Subscriptions

Add addon to subscription

Use when adding an optional product or add-on to an existing subscription (e.g. extra storage or support tier).

post/subscriptions/addon

Request body

addon_idstring required

line_item_commitmentsobject

LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id)

metadataobject

start_datestring

subscription_idstring required

addon_idstring

addon_status'active' | 'cancelled' | 'paused'

cancellation_reasonstring

cancelled_atstring

created_atstring

created_bystring

end_datestring

entity_idstring

entity_type'subscription' | 'plan' | 'addon'

environment_idstring

idstring

metadataobject

start_datestring

status'published' | 'deleted' | 'archived'

tenant_idstring

updated_atstring

updated_bystring