Skip to main content
POST
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

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-23"

Path Parameters

id
string
required

Membership ID (mem_ tag).

Body

application/json
reason
string

Free-form note recording why the membership was canceled.

Response

membership canceled

account
object
required

The account (seller) this membership belongs to.

cancel_at_period_end
boolean
required

Whether the membership is set to cancel when the current billing period ends. Only meaningful for recurring plans.

created_at
string
required

When the membership was created, as an ISO 8601 timestamp.

current_period_end
string | null
required

When the current billing period renews, or when a non-renewing membership expires, as an ISO 8601 timestamp. null for one-time purchases with no expiration.

id
string
required

Membership ID, prefixed mem_.

license_key
string | null
required

The software license key for this membership. Only present when the product includes a software licensing experience.

member
object | null
required

The caller's member row on the account. Present only when the membership belongs to the caller; null on seller-side reads.

metadata
object
required

Custom key-value pairs stored on the membership, commonly used for software licensing.

plan_id
string
required

The plan the buyer purchased, prefixed plan_.

product_id
string
required

The product this membership grants access to, prefixed prod_.

status
enum<string>
required

Billing state of the membership. active/trialing memberships grant access; past_due is the grace period after a failed payment; completed one-time purchases keep access; canceled/expired do not.

Available options:
trialing,
active,
past_due,
completed,
canceled,
expired,
unresolved
Example:

"trialing"

user_id
string | null
required

The buyer, prefixed user_. null when the buyer is another business or the membership is unclaimed.