StoreBay Developers
Commerce

List subscriptions

GET
/subscriptions

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Query Parameters

cursor?string

Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.

limit?integer

Page size. Values above the maximum are clamped.

Range1 <= value <= 100
Default25
status?string

Filter by subscription status.

Value in

  • "pending"
  • "active"
  • "past_due"
  • "paused"
  • "cancelled"
  • "ended"
contact_id?string

Filter by contact.

Formatuuid
agreement_id?string

Filter by agreement.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/subscriptions"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "subscription",      "agreement_id": "67dd069b-637c-4b8e-8d92-17a313d06fb8",      "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",      "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",      "status": "pending",      "billing_interval": "week",      "interval_count": 0,      "currency": "str",      "amount_minor": 0,      "current_period_start": "2019-08-24",      "current_period_end": "2019-08-24",      "next_billing_date": "2019-08-24",      "anchor_day": 0,      "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",      "mandate_id": "e98a8906-c5df-4f83-89a8-e8197c5fddcb",      "default_rail": "bacs_dd",      "auto_collect": true,      "collection_waived": true,      "started_at": "2019-08-24T14:15:22Z",      "paused_at": "2019-08-24T14:15:22Z",      "cancelled_at": "2019-08-24T14:15:22Z",      "ended_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "limit": 0,    "cursor": {      "next": "string",      "has_more": true    }  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}
{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}
{  "error": {    "code": "rate_limited",    "message": "Rate limit exceeded. Retry after 7s."  }}
{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}

List reservations GET

Previous Page

Start (or idempotently re-read) an order's payment session POST

Enqueues a card charge or a Bacs Direct Debit mandate setup through the outbox — never a provider call inline. Re-entry with a live session already attached to the order returns that SAME session, never a second charge/mandate intent.