API - Subscription
Request a Subscription creation
POST {BASE_URL}/subscription
Allows you to generate a subscription link for any user—if the user doesn’t yet exist in your system, the API will create their account and then register the subscription; if they’re already registered, it simply creates a subscription tied to that user.
Headers
Content-Type
application/json
X-Api-Key
API Key <xxx>
Body
string
merchantId
Unique merchant identifier
Required
string
terminalId
Unique merchant terminal identifier. If your merchant account has multiple terminals, you must specify the terminal ID to indicate which one to use. If you have only one terminal, you may omit this field—it will default to the only available terminal.
Optional
string
userId
Internal identifier of an existing user
Required
string
tokenId
Unique identifier for the customer’s stored banking information
Optional
number
amount
Subscription charge amount. May be 0 for free trials or initial user registration
Required
string
currency
Currency identifier code; by default = 978 . The following link contains the ISO 4217 currencies codes that are supported. Currencies
Required
number
billing_period_length
Number of billing units per cycle (e.g. 3 if combined with "Month" to bill every three months).
Required
number
totalBillingCycles
Total subscription cycles
Required
string
billing_period_unit
Unit for the billing period. One of: "Month", "Week", or "Day".
Required
date
startDate
Subscription initial range. It must be in ISO-8601 format with time zone (OffsetDateTime type).
For example:
2025-04-10T16:47:32.123-05:00
2025-04-10T21:47:32.123Z
Required
date
endDate
Subscription final date. It must be in ISO-8601 format with time zone (OffsetDateTime type).
For example:
2025-04-10T16:47:32.123-05:00
2025-04-10T21:47:32.123Z
Optional
date
freeTrialFinalDate
Free trial period's final date
Optional
string
language
Language identifier code; by default = es. The following link contains the ISO 639-1 language codes that are supported.
Optional
string
urlOk
Merchant's OK url
Optional
string
urlKo
Merchant's KO url
Optional
string
merchantOperationId
Optional field that you can use in order to identify operations in your system (is gonna be returned in the WebHook communication)
Optional
Request
Response
Last updated