Subscriptions
Get subscription status
Includes cyclesCompleted, consecutiveFailures, and customVariables.
Authorization
apiKey X-API-Key<token>
Your merchant API key, shown once at creation in the dashboard (Settings → API key).
In: header
Path Parameters
subscriptionId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/subscriptions/string"{ "id": "string", "status": "pending", "currentPeriodEnd": "2026-08-19T14:32:00.000Z", "allowanceConfirmed": true, "customerId": "string", "cyclesCompleted": 3, "consecutiveFailures": 0, "customVariables": { "property1": null, "property2": null }, "lastInvoice": { "id": "inv_01j8x2q3r4s5t6u7v8w9x0y1z2", "subscriptionId": "string", "merchantId": "string", "idempotencyKey": "string", "grossAmount": "10.00", "platformAmount": "10.00", "merchantAmount": "10.00", "tokenKey": "usdc-polygon", "chainId": 137, "pullTxHash": "string", "merchantTransferTxHash": "string", "platformTransferTxHash": "string", "distributeTxHash": "string", "status": "pending", "failureReason": "insufficient_allowance", "isSandbox": true, "createdAt": "2026-08-19T14:32:00.000Z", "updatedAt": "2026-08-19T14:32:00.000Z" }}