Skip to Content

Billing

Set add-on packs

Sets how many packs of an add-on the workspace pays for each month, on top of its plan. More packs are charged now for the rest of the period; fewer packs credit the rest of the period to the next invoice. Packs cannot drop below what is in use (billing_add_on_in_use): disconnect accounts, remove inboxes or teammates first. Adding packs during a free trial ends the trial and charges the plan now, so it needs end_trial: true (billing_trial_running otherwise). Needs a subscription.

PUT
/billing/add-ons/{id}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

The add-on's id, from add_ons in Get billing.

Body

application/json
packsintegerrequired

How many packs to pay for from now on; 0 removes the paid packs.

Required range: 0 <= x <= 100

end_trialboolean

true to end a running free trial so the plan is charged now, which buying during a trial needs (billing_trial_running otherwise); see the quote for the amount.

Response

application/json

Success

payment_urlstring | nullrequired

The checkout page to open when a card must be added first; null when the change is already made.