Cancel at the end of a billing period (respecting notice and minimum term) or immediately where policy allows

post/api/v1/memberships/{id}/cancel

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/memberships/{id}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

idstring required

Request body

mode'period_end' | 'immediate'
reasonstring required
idempotency_keystring required

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.