Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Memberships

List Memberships

Lists every membership the caller can read: an account API key its account's; a user credential their own plus those of every account they manage. account_id and user_id only narrow that list — values outside the caller's reach return fewer results, not an error.

get/memberships

Query parameters

account_idstring

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_idstring

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'active' | 'trialing' | 'past_due' | 'completed' | 'canceled' | 'expired' | 'canceling' | 'paused'

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

product_idstring

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

plan_idstring

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

created_afterstring

Only memberships created after this ISO 8601 timestamp.

created_beforestring

Only memberships created before this ISO 8601 timestamp.

order'created_at'

Sort field.

direction'asc' | 'desc'

Sort direction.

firstinteger

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

afterstring

Cursor to paginate forwards from.

lastinteger

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

beforestring

Cursor to paginate backwards from.

Response

memberships listed

Example response

{
  "data": [
    {
      "member": {
        "access_level": "no_access"
      },
      "status": "trialing"
    }
  ]
}