Documentation

POST

api

billing

cancel

Error

A valid request URL is required to generate request examples

{
  "cancel_at_period_end": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorization

string

header

required

JWT access token or API key (csk_...)

Cancellation scheduled

subscription_status

enum<string>

required

Available options:

none,

active,

past_due,

canceled,

revoked

cancel_at_period_end

enum<boolean>

default:true

Available options:

true

Error

A valid request URL is required to generate request examples

{
  "cancel_at_period_end": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Cancel subscription at period end