Skip to main content
GET
Get a cancellation record

Authorizations

Authorization
string
header
required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Path Parameters

membershipId
string
required

Response

Tenant-scoped resource.

Cancellation detail with sanitized signup discounts and twelve UTC monthly firstYearPayments periods. Null coverage means the source data was not sufficient; it never exposes raw payment-provider objects.

membershipId
string
required
customerId
string | null
required
signupAt
string<date-time> | null
required

UTC ISO 8601 timestamp.

cancelledAt
string<date-time>
required

UTC ISO 8601 timestamp.

reason
string
required
churnType
enum<string>
required
Available options:
voluntary,
involuntary
planName
string | null
required
billingAmountCents
integer | null
required

Amount in integer cents.

hadSignupDiscount
boolean | null
required
signupDiscounts
object[] | null
required
firstYearPayments
object[] | null
required
firstYearPaymentCoverage
object
required