Skip to main content
POST
Add a line to 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
productId
string<uuid>
required

Recurring product to add (from list_billing_products).

amountCents
integer

Price per billing period in cents (e.g. 35000 = $350.00), before tax and processing fees.

Required range: 0 <= x <= 10000000
priceId
string<uuid>

An existing price to use (alternative to amountCents).

quantity
integer
Required range: 1 <= x <= 100
carId
string<uuid>

Car this line bills for.

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