Skip to main content
POST
Cancel a membership policy
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.

Headers

idempotency-key
string
required

Unique per cancellation; send the same key on a retry.

Required string length: 1 - 100

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}$

Body

application/json
cancelWhen
string
required

IMMEDIATELY ends it now when permitted; END_OF_BILLING_PERIOD applies the scheme's notice period for a member. More values may be added.

outstandingInvoices
enum<string>

Organizer keys only: what becomes of invoices the membership still owes. KEEP, the default, leaves them owed. VOID voids them, so the member owes nothing. A member token that sends this is refused; a member's own cancellation follows the scheme's rules.

Available options:
KEEP,
VOID
reason
string

Organizer keys only. REQUESTED_BY_MEMBER, UNPAID_FEES, BREACH_OF_TERMS, DUPLICATE_MEMBERSHIP or OTHER. Audit context only; does not change billing or mark a system-triggered cancellation.

note
string

Organizer keys only. Private untrusted plain text, never returned to the member.

Maximum string length: 2000

Response

The policy id, its pending cancellation if any, the cooling-off refund outcome when returned, and whether a requested void is still being finished.

policyId
string
required
pendingChange
object | null
required
coolingOffRefund
MembershipCoolingOffRefundOutcome · object
outstandingInvoicesVoidIncomplete
boolean

True when the cancellation went through but some invoices an organizer key asked to void are not yet voided. They are retried for about an hour; read the cancellation quote to see what is still owed. Absent otherwise.