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
Pattern: ^[a-fA-F0-9]{24}$

Query Parameters

includeCard
boolean
default:false

Response

Default Response

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.

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 blocked by a failed payment. ENDED has ended 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. Access can continue briefly after that while renewal payment is pending; other blockers can deny access immediately.

paymentFailed
boolean
required

True once a renewal payment has failed. Access continues until the paid period ends, so this can be true while entitled is still true; after that the status is FROZEN.

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 briefly after it while a renewal is collected. Null when the membership has no end date or its first payment is outstanding.

renewalDate
string | null
required
cancelAtDate
string | null
required
autoRenew
boolean | null
required