Buy or shed a recurring add-on
POST/api/billing/addons
Adjust the tenant's recurring add-ons (ENT-2): extra standard/premium channel slots or agent seats on top of the plan. Admin only.
- add — issues a prorated invoice for the rest of the current period,
never below the minimum card charge ($0.50). It settles from the wallet
when
pay_from_walletcovers it (200summary), otherwise responds202with a hosted Checkout URL; the quantity applies only once the invoice is paid. Requires an active PAID subscription;premium_channelsalso requires a premium tier. - storage_gb is sold in packs:
quantityis in GB and must be a multiple ofentitlements.storage_pack_gb(10), up to 100 packs. - remove — reduces the quantity immediately (no refund; the next
renewal simply bills less) and responds
200.
Request
Responses
- 200
- 202
- 401
- 403
- 422
- 502
The refreshed billing summary (settled or reduced).
A live-Stripe purchase: redirect the browser to the hosted Checkout URL; the add-on applies after payment (via webhook).
Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).
Authenticated but not allowed.
The request failed validation.
The payment provider could not start the payment. Nothing was charged; the invoice this request issued is voided.