Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-23"

Query Parameters

account_id
string

Narrow to one account (biz_ tag). With read access to the account this lists all of its memberships; without, only the caller's own memberships in it.

user_id
string

Narrow to one user's memberships (user_ tag, or me for the caller). A user outside the caller's visible set returns an empty list.

status
enum<string>

Filter by billing state. canceling matches active memberships set to cancel at period end; paused matches memberships with payment collection paused.

Available options:
active,
trialing,
past_due,
completed,
canceled,
expired,
canceling,
paused
product_id
string

Filter to memberships of this product (prod_ tag). Repeat as product_ids[] for several.

plan_id
string

Filter to memberships of this plan (plan_ tag). Repeat as plan_ids[] for several.

created_after
string

Only memberships created after this ISO 8601 timestamp.

created_before
string

Only memberships created before this ISO 8601 timestamp.

order
enum<string>
default:created_at

Sort field.

Available options:
created_at
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
first
integer
default:20

Number of memberships to return from the start of the window.

Required range: x <= 100
after
string

Cursor to paginate forwards from.

last
integer

Number of memberships to return from the end of the window.

Required range: x <= 100
before
string

Cursor to paginate backwards from.

Response

memberships listed

data
object[]
required
page_info
object
required