Skip to main content
POST
Activate add-on
This reference describes API version 2026-07-24. Send Commet-Version: 2026-07-24 with your request.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-07-24

API version used by this reference. Send this header to select this contract explicitly.

Path Parameters

id
string
required

Body

application/json
addonId
string
required
Minimum string length: 1

Response

Success

addonId
string
required
status
enum<string>
required

active when the add-on is active. processing when the payment method confirms later: the add-on is activated once the payment is confirmed, and stays inactive if it is declined.

Available options:
active,
processing
proratedCharge
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
object
string
required
Allowed value: "subscription_addon"
livemode
boolean
required