Skip to main content
GET
List the signed-in member’s product subscriptions

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Query Parameters

filter[status]
enum<string>

Storefront bucket: active includes active, pending and past_due; inactive includes paused and cancelled. paused and cancelled select only that exact status. Omit to include every status.

Available options:
active,
inactive,
paused,
cancelled
filter[q]
string

Case-insensitive literal substring of the product title or subscription plan name. Percent, underscore and backslash are literal characters. The query must contain a non-whitespace character; omit this filter for an unfiltered list. Only names belonging to the member's company can match.

Required string length: 1 - 100
Pattern: ^[^\u0000]*$
page[cursor]
string

Encrypted next-page cursor, valid for three days. Changing member ownership restarts at the first page, including when filters change. Within the same member scope, changing status or search filters invalidates the cursor; restart without it. Search case changes preserve the cursor.

page[limit]
integer
default:25

Maximum number of subscriptions returned.

Required range: 1 <= x <= 100

Response

A page of the member's subscriptions.

A page of subscriptions.

status
integer
required

HTTP response status.

data
object[]
required

The member's subscriptions on this page.

meta
object
required

Envelope metadata present on every response.