Skip to main content
GET
Quote a membership cancellation
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}$

Response

The cancellation terms and cooling-off refund quote currently available.

cancellationEffectiveAt
string<date-time> | null
required

When a period-end cancellation requested now takes effect, including notice; null when unavailable.

memberMayCancelNow
boolean | null
required

Null when the service cannot answer.

coolingOff
object | null
required

Null outside every cooling-off window.

coolingOffRefundQuote
object | null
required

Null when no cooling-off refund quote is available.

outstandingInvoices
object | null
required

What the membership still owes. Null when nothing bills it or the amount could not be read.