Create Subscription

post

https://api-sandbox.y.uno/v1/subscriptions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Subscription Completion
The fields billing_cycles and availability.finish_at have an impact on each other. If both are completed during the subscription creation, it will transition to the COMPLETED state upon reaching the nearest event defined in these fields, whether it is the billing cycle or the corresponding finish_at.

Refer to the HTTP Response Codes section for details on possible error outcomes.

Body Params

name

string

required

The subscription plan name (MAX 255; MIN 3).

description

string

The subscription plan description (MAX 255; MIN 3).

account_id

string

required

The unique identifier of the account that will have the subscription plan available to use (UUID, 36 chars).

merchant_reference

string

Identification of the subscription plan (MAX 255; MIN 3).

country

string

required

The subscription's country (MAX 2; MIN 2; ISO 3166-1).

amount

object

required

Specifies the amount object, with the value of each subscription payment and the used currency.

additional_data

object

Specifies the additional_data object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.

frequency

object

Specifies the frequency object. Defines the billing frequency for the subscription. Including type and value.

billing_cycles

object

Specifies the billing_cycles object. Defines the number of charges associated to the subscription.

customer_payer

object

Specifies the customer_payer object to identify the customer.

payment_method

object

required

Specifies the payment_method object. Currently, only card is available as a payment method using previously enrolled cards (vaulted_token)

trial_period

object

Specifies the trial period object

availability

object

Specifies the availability object. Defines a date interval based on starting and ending dates when the subscription is available to use.

metadata

array of objects

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Keys can be unset by posting an empty value to metadata. You can add up to 50 metadata objects.

metadata

retries

object

Specified the 'retries' object. If we need to retry declined transactions in Yuno and the amount if necessary

initial_payment_validation

boolean

Flag to identify if the subscription should wait for the first payment in order to continue. False by default.

billing_date

object

Specifies the billing_date object. Defines the type of date use for the subscription logic. Mutually exclusive with the frequency object.

Headers

x-idempotency-key

string

Defaults to {$randomUUID}

A unique identifier for the request. Must be different each time (UUID). See authentication.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Subscription Completion

200200

400400