Update Subscription

patch

https://api-sandbox.y.uno/v1/subscriptions/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Subscription Transition
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.

Path Params

string

required

The unique identifier of the subscription.

Body Params

name

string

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

description

string

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

account_id

string

The unique identifier of the account that will have the subscription plan available to use (MAX 64 ; MIN 36).

merchant_reference

string

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

country

string

The subscription's country.

amount

object

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

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

Specifies the payment_method object. Currently, only card as available as payment methods. You can use the card token, the vaulted_token or the card information using through the card object.

availability

object

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

retries

object

Specified the 'retries' object. If we need to retry declined transactions in Yuno and the amount if necessary. If modified, the retries will apply to the next payment intent.

metadata

object

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Responses

Language

Credentials

Loading…

Response

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

application/json

Subscription Transition

200200

400400