Subscriptions
PLATFORM_NAME treats subscriptions as recurring merchant relationships: a plan, billing cadence, customer, and a sequence of subscription charges (renewal or manual charges) in money.
Currency
Subscription amounts, trials, and renewal charges are in USD or EUR only—the same rule as one-time payments. Do not assume other currencies.
Merchant capabilities (lifecycle)
Merchants manage subscription business logic from the organization (dashboard) context—the same security model as Organization & merchant and Payment links (dashboard):
| Operation | Description |
|---|---|
| Create | Create a subscription (plan, customer, start date, trial if applicable, currency USD/EUR). |
| Get | View subscription detail and status (active, trialing, past due, canceled, etc.). |
| Update | Change plan fields, metadata, or billing parameters where product rules allow. |
| Cancel | Cancel at period end or immediately, per product behavior. |
| Delete | Remove or archive subscription records according to retention rules (may be restricted if invoices exist). |
| Create subscription transaction | Record or trigger a subscription charge (initial invoice payment, renewal, retry, or manual charge) so it appears in payments, webhooks, and reporting as a subscription-linked payment. |
Use dashboard session authentication (Authorization: Token <access_token>) for these operations in the merchant UI.
API key integrations
Public REST documentation for subscription CRUD is not published in this developer guide while the product standardizes dashboard workflows. Integrations using API keys should:
- Use Create payment (
POST /checkout/create/) with USD/EUR and catalog products for customer acquisition flows that mirror checkout. - Use Webhooks for payment and status updates (
transaction.status_changed, etc.). - Use Get payment by id to reconcile charges.
When subscription-specific REST endpoints and webhooks are released for API keys, they will appear in the API Reference and this page will be updated.
Sandbox
If your deployment provides sandbox API keys (Organization & merchant), subscription testing rules match your environment: no live card movement in test mode, separate credentials and webhook secrets where configured.
See also: Currencies (USD & EUR) · Create payment · Webhooks · Organization & merchant