Attributes This object represents a subscription that can be associated with a customer.
The unique identifier of the subscription (MAX 64 ; MIN 36). Example: 7304911d-5df9-429e-8488-ad41abea1a4c
The subscription name (MAX 255; MIN 3). Example: sub_001
The subscription description (MAX 255; MIN 3). Example: Servicio de streaming
The unique identifier of the account that will have the subscription plan available to use (MAX 64 ; MIN 36). Example: 2404911d-5df9-429e-8488-ad41abea1a4b
Identification of the subscription plan (MAX 255; MIN 3). Example: 001_marzo_23
The subscription’s country. Example: CO
Status of the subscription. Possible values:
ACTIVE = The subscription has been created with an associated customer and is already active.PAUSED = The subscription has been paused and can be reactivated.COMPLETED = The subscription is completed because it reached the end date and time.CANCELED = Subscription canceled. Specifies the subscription amount object, with the value and currency. The payment amount (multiple of 0.0001). Example: 12100.00
The frequency defined for the payment subscription. If not set, defaults are MONTH for type and 1 for value. The type of interval the subscription will have in time (DAY, WEEK, MONTH). If not set, always MONTH by default. Possible enum values: DAY, MONTH, or YEAR.
The value between each interval the subscription will have in time. If not set, always 1 by default. Example: 1
Specifies the billing_cycles object. Total amount of billing cycles. Example: 10
Value of the current billing cycle. Example: 2
The date of the next payment for the subscription. Example: 2023-02-16T20:00:00.786342Z
[Optional] Specifies the billing_date object. Mutually exclusive with the frequency object. The type of billing_date the subscription will have in time. PREPAID, POSTDATE, DAY. If not set, the creation date for the plan will be set by default. Example: PLAN_CREATION_DATE
The day of the month to charge the subscription if the type is set to DAY. Always 1 by default. Example: 2
Specifies the customer_payer object. The unique identifier of the customer (MAX 255; MIN 3). Example: 3t04911d-5df9-429e-8488-ad41abea1a2c
Specifies the payment_method object. Type of the payment method. Possible enum values: CARD
The one-time use payment method token provided by Yuno SDK (MAX 64; MIN 36). Example: 9104911d-5df9-429e-8488-ad41abea1a4b
The vaulted token of the stored payment method (MAX: 64; MIN: 36). Example: 6104911d-5df9-429e-8488-ad41abea1a4b
Specifies the card object. Using amount = 0 and verify = true, you can verify the user’s card without authorizing a real amount. Possible values: true or false.
Specifies the card_data object. Card’s number without any separators (MAX 19; MIN 8) - only available for PCI certified merchants. Example: 4507990000000010
Card’s expiration month - MM (MAX 2; MIN 2) - only available for PCI certified merchants. Example: 10
Card’s expiration year - YYYY (MAX 4; MIN 4) - only available for PCI certified merchants. Example: 2025
Card’s security code (MAX 4; MIN 3) - only available for PCI certified merchants. Example: 123
Cardholder’s full name as it appears on the card (MAX 26; MIN 3) - only available for PCI certified merchants. Example: JOHN DOE
Specifies the trial_period object. Total amount of billing cycles the free_trial should apply to. Example: 1
Amount to be discounted for the trial period. The currency used to make the trial period. (ISO 4217 MAX 3; MIN 3). Example: COP
The trial period amount value (multiple of 0.0001). Example: 10
Specifies the availability object. The dates that the subscription will be available. If null the start date will be the day of the creation and it will not have a finish date. The start date that the subscription will be available to use. Example: 2024-01-16T00:00:00.786342Z
The end date until the subscription will be available to use. Example: 2024-05-26T20:00:00.786342Z
Specifies the retries object. If we need to retry declined transactions in Yuno and the amount if necessary. If we should retry a payment or not after a first decline. False by default. Example: TRUE
The number of retries that the subscription plan will have to completion. The maximum equals your environment’s configured retry schedule length (6 in production). Values above the cap are clamped to it. Max: 6 Example: 4
initial_payment_validation
Flag to identify if the subscription should wait for the first payment in order to continue. False by default. Example: false
Specifies the metadata object. This value serves as a name or identifier for the metadata. Use a descriptive term. (MAX 48; MIN 1). Example: sub_ext_id
The information you wish to store within the metadata. (MAX 512; MIN 1). Example: AA001
subscription_agreement_id
Links this subscription to the initial payment created with the same agreement ID. Used for tracking, reconciliation, and chargeback handling (MAX 255). The value must exactly match the subscription_agreement_id sent in payment_method.detail.card.stored_credentials.subscription_agreement_id on the originating payment. Example: sa_6af2dfcd-44c0-4f16-a331-8bed3ed9c9fa
Specifies the payments array. This array is currently always empty in webhook payloads. Subscribe to payment.* webhooks to track charges.
The unique identifier of the payment (MAX 64 ; MIN 36). Example: 5104911d-5df9-229e-8468-bd41abea1a4s
Subscription creation date and time (ISO 8601 MAX 27; MIN 27). Example: 2023-12-16T20:46:54.786342Z Subscription last updated date and time (ISO 8601 MAX 27; MIN 27). Example: 2023-12-16T21:00:54.786342Z 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. Specifies the order object. Specifies the item’s object. The unique identifier of the item (MAX 255; MIN 3). Example: 3214
The name of the item (MAX 255; MIN 3). Example: iPhone 12 Pro Max
The quantity of the item (MAX 999; MIN 1). Example: 1
The unit amount of the item (multiple of 0.0001). Example: 550
The brand of the item (MAX 255; MIN 3). Example: Apple
The stock keeping unit (SKU) of the item (MAX 255; MIN 3). Example: A2342
The manufacture part number of the item (MAX 255; MIN 3). Example: 345621234
