Skip to main content
GET
List subscriptions

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Query Parameters

customerPartyId
string

Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer.

Pattern: ^pty_[0-9a-f]{32}$
status
enum<string>

Only subscriptions with this status.

Available options:
pending,
active,
past_due,
needs_attention,
canceled,
completed
limit
integer
default:50

Maximum results per page.

Required range: 1 <= x <= 100
cursor
string

Cursor from the previous page.

Pattern: ^sub_[0-9a-f]{32}$

Response

Successful Response

data
SubscriptionListItem · object[]
required
meta
object
required