Skip to main content
GET
TypeScript

인증

Authorization
string
header
필수

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

member:basic:read

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

쿼리 매개변수

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.

member_id
string

Narrow to one member's memberships (mber_ tag), including memberships bought by another business. A member outside the caller's visible set returns an empty list.

external_account
string

Narrow to memberships linked to one Discord or Telegram account, given as the platform's user ID prefixed with discord_ or telegram_. Discord matches include memberships imported with that Discord ID. Any other format is a 400.

예시:

"discord_123456789012345678"

status
enum<string>

Filter by billing state. trialing, active, past_due, completed, canceled, and expired match the membership's status; active, trialing, and past_due exclude memberships set to cancel at period end. The other values are derived buckets that never appear as a status: canceling matches memberships set to cancel at period end; paused matches memberships with payment collection paused; expiring matches one-time purchases that have not yet expired; one_time matches one-time purchases that never expire; unclaimed matches memberships with no buyer user, including memberships bought by another business; banned matches memberships whose buyer is banned from the account.

사용 가능한 옵션:
active,
trialing,
past_due,
completed,
canceled,
expired,
canceling,
paused,
expiring,
one_time,
unclaimed,
banned
statuses
enum<string>[]

Filter to memberships matching any of these billing states, with the same meanings as status. Repeat the parameter to pass several. Combined with status when both are sent.

사용 가능한 옵션:
active,
trialing,
past_due,
completed,
canceled,
expired,
canceling,
paused,
expiring,
one_time,
unclaimed,
banned
product_id
string

Filter to memberships of this product (prod_ tag).

product_ids
string[]

Filter to memberships of any of these products, each prefixed prod_. Repeat the parameter to pass several.

variant_id
string

Filter to memberships of this variant (plan_ tag).

variant_ids
string[]

Filter to memberships of any of these variants, each prefixed plan_. Repeat the parameter to pass several.

promo_code_ids
string[]

Filter to memberships discounted by any of these promo codes, each prefixed promo_. Repeat the parameter to pass 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>
기본값:created_at

Sort field.

사용 가능한 옵션:
created_at
direction
enum<string>
기본값:desc

Sort direction.

사용 가능한 옵션:
asc,
desc
first
integer
기본값:20

Number of results to return from the start of the range.

필수 범위: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

필수 범위: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

include_total_count
boolean

Set to true to return the number of matching results in page_info.total_count. Send first=0 as well to return the count without any results.

응답

memberships listed

data
object[]
필수
page_info
object
필수