Skip to main content
POST
Add subscription add-on

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Billing subscription sid (bl_sb_…).

Required string length: 18
Pattern: ^bl_sb_

Body

application/json

Request body of add_billing_subscription_addon.

price_sid
string
required

The add-on price (product.type=addon).

Required string length: 18
Pattern: ^bl_pc_
quantity
integer
required

Units of the add-on.

Required range: x >= 1
request_id
string
required

Client idempotency token; a retry with the same token does not re-charge.

Maximum string length: 64

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required
credits
object