Fetch a subscription
Fetches one subscription with its status, next charge time and retry count.
/v1/subscriptions/{subscriptionId}Fetches one subscription with its status, next charge time and retry count. Requires subscriptions:read; a user token may read only its own (forbidden, 403) and an unknown id gives subscription_not_found (404).
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "plan_name": "string", "amount": 0, "commission": 0, "interval": "weekly", "status": "active", "next_charge_at": "2019-08-24T14:15:22Z", "retry_count": 0, "metadata": { "property1": "string", "property2": "string" }, "created_at": "2019-08-24T14:15:22Z"}Create a recurring charge mandate
Records a recurring charge mandate. Creating one moves no money: the first charge runs at start_at (now when omitted) and the scheduler charges once per interval after that, retrying a failed perio...
Pause charging
Stops charging without ending the mandate; nothing is billed while it is paused.