Page the tenant's subscriptions (admin)
The tenant's subscriptions, optionally narrowed by user_id and status.
/v1/subscriptionsThe tenant's subscriptions, optionally narrowed by user_id and status. Requires subscriptions:read and a machine or staff principal; a user token is refused forbidden (403). Cursor paged: pass the last id you saw as cursor; limit is clamped to 1-100 and defaults to 50.
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
Query Parameters
uuidValue in
- "active"
- "past_due"
- "paused"
- "canceled"
Last seen id from the previous page. The listing resumes after that row, so an id that belongs to no row in the listing is refused invalid_request (400) rather than answered with an empty page.
uuid1 <= value <= 10050Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/subscriptions"[ { "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" }]Refund a captured payment back to the payer's wallet
Returns captured money to the payer's wallet as a contra posting: the original transaction is never rewritten, so both movements stay in the history.
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...