Remove a line from a plan
Requires write:billing. Remove one line from a customer’s plan (e.g. a car that was sold). The only line on a plan can’t be removed (cancelling a plan is done in the dashboard). Without confirm, nothing changes and the response has a plain-language summary, the plan before and after, and a previewToken. Calling again with the same arguments plus confirm: true and that previewToken applies the change. Takes effect with the next bill (no proration, nothing charged now). A stale token (the plan changed since the preview) is refused with 409; preview again.
Authorizations
Team API key from Settings → Integrations. Use Authorization: Bearer <key> or x-api-key.
Path Parameters
Subscription id from list_billing_subscriptions.
Body
Which line of the plan to change. Optional when the plan has one line; otherwise pass one of these.
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.
From the preview. Required with confirm: true; refused if the plan or the change differs from what was previewed.
100Response
Preview (applied: false) or applied change (applied: true).