Skip to main content
GET
Get a membership dashboard
This endpoint is in beta: its request and response contract can still change while it’s being developed.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policyId
string
required

The id of a membership policy: a member's purchased membership. Each seat names its policy in policyId.

Pattern: ^[a-fA-F0-9]{24}$

Query Parameters

includeCard
boolean
default:false

Set to true to add the last four digits of the policy's card, when it has one.

Response

The policy with its price, plan, benefits and status.

id
string
required
schemeId
string
required
offeringId
string | null
required
offeringPriceId
string | null
required
price
MembershipPrice · object | null
required

The revision pinned to this policy, which may no longer be on sale. A subscription price is shown in the currency the policy's subscription bills in.

offering
object | null
required
billingCard
object | null
required

The card's last four digits, returned when requested with includeCard=true.

billingCardState
enum<string>
required
Available options:
NOT_REQUESTED,
AVAILABLE,
UNAVAILABLE
status
enum<string>
required

ACTIVE grants access. CANCELLED_RUNNING has renewal canceled but keeps access until the policy ends. FROZEN is not entitled for now but has not lapsed: with frozenReason PAYMENT_FAILED, a renewal payment failed; with a null frozenReason, the renewal payment is still pending rather than failed, and the membership is active again once it is paid. ENDED has ended, including after Stripe cancels the subscription for non-payment, or is blocked for another reason. Use entitled for access decisions.

Available options:
ACTIVE,
CANCELLED_RUNNING,
FROZEN,
ENDED
entitled
boolean
required

Whether the member has access now. A failed renewal does not remove access before the paid period ends, nor before the end of any renewal access grace the scheme sets. Without one, access can continue briefly after the paid period while renewal payment is pending. Other blockers can deny access immediately.

paymentFailed
boolean
required

True once a renewal payment has failed, and still true after a membership ends that way. Access continues until the paid period ends, and through any renewal access grace the scheme sets, so this can be true while entitled is still true. After that the status is FROZEN while the renewal is still being retried, or ENDED once Stripe has cancelled the subscription; on a scheme that sets a renewal access grace, even of 0 days, no sooner than 7 days after the paid period ends.

blockingReasons
enum<string>[]
required

Blockers other than a failed payment, such as an immediate cancellation. Can be empty while access is denied, so don't use it as the access decision.

Available options:
ORGANIZER_OFFBOARDED,
CANCELLED_IMMEDIATELY,
OTHER
frozenReason
enum<string> | null
required
Available options:
PAYMENT_FAILED,
null
expiresAt
string | null
required

When the paid period ends, moved on each time a renewal is paid. Access can continue after it while a renewal is collected, through any renewal access grace the scheme sets. Null when the membership has no end date or its first payment is outstanding.

renewalDate
string | null
required

When the subscription next renews, which is when its current billing period ends. It is the next renewal even when that renewal is free, as when a scheme gives late joiners their next period free, so it can be earlier than the first renewal the member pays for. Null when the policy has no subscription. autoRenew and cancelAtDate say whether it will renew.

cancelAtDate
string | null
required
autoRenew
boolean | null
required