curl --request POST \
--url https://your-site.example/api/v1/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Netflix",
"category": "Streaming",
"amount": 15.99,
"currency": "USD",
"period": "monthly",
"nextPaymentDate": "2026-07-01",
"notificationEnabled": true
}
'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"category": "<string>",
"amount": 499999.995,
"currency": "CNY",
"period": "monthly",
"lastPaymentDate": "2026-06-01",
"nextPaymentDate": "2026-06-01",
"notificationEnabled": true,
"status": "active",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"billingAnchorDay": 16,
"customDate": "<string>"
},
"requestId": "<string>"
}Create a subscription
Creates a subscription for the authenticated API key owner. Server-managed fields are rejected if supplied.
curl --request POST \
--url https://your-site.example/api/v1/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Netflix",
"category": "Streaming",
"amount": 15.99,
"currency": "USD",
"period": "monthly",
"nextPaymentDate": "2026-07-01",
"notificationEnabled": true
}
'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"category": "<string>",
"amount": 499999.995,
"currency": "CNY",
"period": "monthly",
"lastPaymentDate": "2026-06-01",
"nextPaymentDate": "2026-06-01",
"notificationEnabled": true,
"status": "active",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"billingAnchorDay": 16,
"customDate": "<string>"
},
"requestId": "<string>"
}Authorizations
Developer API key generated in the app. Keys carry scopes; a read key can call list, get, analytics, and audit endpoints, while a write key additionally allows create, update, cancel, pause, resume, and delete.
Body
Human-readable service or product name.
1 - 120User-visible category label used for grouping and analytics.
1 - 80Payment amount in major currency units, with at most 2 decimal places.
0 <= x <= 999999.99Must be a multiple of 0.01ISO-like currency code supported by the app.
CNY, USD, EUR, JPY, GBP, AUD, CAD, CHF, HKD, SGD Billing cadence. Monthly means the same calendar day each month; fixed-day intervals use custom.
monthly, yearly, custom Authoritative upcoming renewal date.
^\d{4}-\d{2}-\d{2}$"2026-06-01"
Optional monthly calendar anchor from 1 to 31. Inferred from nextPaymentDate when omitted.
1 <= x <= 31Deprecated compatibility input. Use nextPaymentDate for new integrations.
^\d{4}-\d{2}-\d{2}$"2026-06-01"
Required only when period is custom. Despite the legacy name, this is a positive whole-number string of days, not a calendar date.
^[1-9]\d*$Lifecycle state. active means billing; paused means temporarily stopped; cancelled means no longer billing but kept for history.
active, paused, cancelled