Skip to main content
POST
Cancel a subscription

Authorizations

x-app-id
string
header
required

App identifier (App.id, sent as the x-app-id header)

Path Parameters

id
string
required

Query Parameters

immediately
string

Omit to resolve from the product billing_config.on_cancel (defaults to end-of-period). Set explicitly to override it for this call.

Response

200 - application/json
id
string
required
tenant_id
string
required
customer
object
required
plan_price_id
string
required
pack_id
string | null
required
pending_plan_price_id
string | null
required
pending_pack_id
string | null
required
provider
enum<string>
required
Available options:
STRIPE,
POLAR
provider_subscription_id
string | null
required
provider_customer_id
string | null
required
status
enum<string>
required
Available options:
ACTIVE,
TRIALING,
PAST_DUE,
CANCELED,
UNPAID,
PAUSED
current_period_start
string<date-time> | null
required
current_period_end
string<date-time> | null
required
trial_start
string<date-time> | null
required
trial_end
string<date-time> | null
required
canceled_at
string<date-time> | null
required
ended_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required