Skip to main content
POST
Remove a line from a plan

Authorizations

Authorization
string
header
required

Team API key from Settings → Integrations. Use Authorization: Bearer <key> or x-api-key.

Path Parameters

id
string<uuid>
required

Subscription id from list_billing_subscriptions.

Body

application/json
line
object

Which line of the plan to change. Optional when the plan has one line; otherwise pass one of these.

confirm
boolean

Leave out (or false) to preview: nothing changes, and the response has a summary and previewToken. With confirm: true and that previewToken, the change is applied.

previewToken
string

From the preview. Required with confirm: true; refused if the plan or the change differs from what was previewed.

Maximum string length: 100

Response

Preview (applied: false) or applied change (applied: true).

data
object
required