Subscriptions
List subscriptions
Filter by status, customerId, and/or offerId.
Authorization
apiKey X-API-Key<token>
Your merchant API key, shown once at creation in the dashboard (Settings → API key).
In: header
Query Parameters
status?string
Value in
- "pending"
- "active"
- "past_due"
- "canceled"
customerId?string
offerId?string
limit?integer
Max 100, default 20.
start?integer
Offset for pagination, default 0.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/subscriptions"{ "subscriptions": [ { "id": "string", "merchantId": "string", "offerId": "string", "offerPriceId": "string", "offerName": "string", "priceAmount": "30", "priceCurrency": "USDC", "customerId": "string", "chainId": -9007199254740991, "status": "pending", "currentPeriodEnd": "2026-08-19T14:32:00.000Z", "allowanceConfirmed": true, "cyclesCompleted": 3, "consecutiveFailures": 0, "customVariables": { "property1": null, "property2": null }, "afterCompletion": { "property1": null, "property2": null }, "isSandbox": true, "idempotencyKey": "string", "affiliatePartnerId": "string", "affiliateCommissionPct": "string", "createdAt": "2026-08-19T14:32:00.000Z", "updatedAt": "2026-08-19T14:32:00.000Z" } ], "limit": 20, "start": 0}