Skip to main content
POST
Create Subscription

Headers

X-Idempotency-Key
string<uuid>
required

Unique UUID per request. Prevents duplicate processing on retries.

Body

application/json
account_id
string<uuid>
required
name
string
required
Required string length: 3 - 255
country
enum<string>
required

ISO 3166-1 alpha-2 country code

Available options:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
amount
object
required
frequency
object
required
payment_method
object
required
description
string
merchant_reference
string
billing_cycles
object
customer_payer
object
availability
object
additional_data
object
subscription_agreement_id
string

Links this subscription to the initial payment created with the same agreement ID. Used for tracking, reconciliation, and chargeback handling. Must exactly match the subscription_agreement_id sent in payment_method.detail.card.stored_credentials.subscription_agreement_id on the originating payment.

Maximum string length: 255

Response

201 - application/json

Subscription created

id
string<uuid>
name
string
status
enum<string>
Available options:
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED
amount
object
frequency
object
subscription_agreement_id
string

Links this subscription to the initial payment created with the same agreement ID. Used for tracking, reconciliation, and chargeback handling.

created_at
string<date-time>