Skip to main content
POST
Cancel Billing Plan

Authorizations

Authorization
string
header
required

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Path Parameters

account_id
string<uuid>
required

Body

application/json

Customer request schema for cancelling an account subscription plan.

cancel_at_period_end
boolean
default:true

Cancel the plan at the end of the billing period

cancel_immediately
boolean
default:false

Cancel the plan immediately

Response

status
string
required

Billing operation status

account_status
string | null

Account status after the operation

effective_at
string<date-time> | null

When the billing change took effect

eligible
boolean | null

Whether the account was eligible for the operation

previous_plan_id
string | null

Previous billing plan ID

target_plan_id
string | null

Target billing plan ID