v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB

Membership

Cancel Membership

post/provider/memberships/{id}/cancel

Path parameters

idstring required

Unique Membership ID

Request body

end_datestring date required

It must line up with the membership's bill_date (not next_bill_date). Eg. A membership that bills on the 5th must end on the 5th. Date must be formatted as YYYY-MM-DD.

cancellation_reason_otherstring

Description required when sending cancellation_reason of "Other"

Response

Successful response

idstring

bill_datestring date

billed_through_datestring date

billing_start_datestring date

bills_at_end_of_periodboolean

contract_expiration_actionstring

contract_expiresstring date

contract_period_in_monthsinteger

created_atstring date-time

end_datestring date

enrollment_statusstring

fixed_period_rate_in_centsinteger

fixed_registration_fee_in_centsinteger

group_codestring

is_confirmedstring

is_currentboolean

is_processingboolean

is_restartableboolean

list_price_in_centsinteger

next_bill_datestring date

period_in_monthsstring

period_rate_in_centsinteger

rate_in_centsinteger

source_statusstring

start_datestring date

statusstring

updated_atstring date-time