Skip to main content
POST
/
v1
/
subscriptions
Create Subscription
curl --request POST \
  --url https://api-sandbox.y.uno/v1/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "account_id": "YOUR_ACCOUNT_ID",
  "name": "Monthly Subscription Plan",
  "description": "Billed monthly",
  "merchant_reference": "sub-001",
  "country": "US",
  "amount": {
    "currency": "USD",
    "value": 9900
  },
  "frequency": {
    "type": "MONTH",
    "value": 1
  },
  "billing_cycles": {
    "total": 12
  },
  "customer_payer": {
    "id": "CUSTOMER_UUID"
  },
  "payment_method": {
    "type": "CARD",
    "vaulted_token": "VAULTED_TOKEN_UUID"
  },
  "availability": {
    "start_at": "2026-04-01T00:00:00Z",
    "finish_at": "2027-03-31T23:59:59Z"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "amount": {
    "currency": "<string>",
    "value": 123
  },
  "frequency": {
    "type": "<string>",
    "value": 123
  },
  "created_at": "2023-11-07T05:31:56Z"
}

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

Response

201 - application/json

Subscription created

​
id
string<uuid>
​
name
string
​
status
enum<string>
Available options:
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED
​
amount
object
​
frequency
object
​
created_at
string<date-time>