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

cadence'onetime' | 'recurring'

line_item_commitmentsobject

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

metadataobject

proration_behavior'create_prorations' | 'none'

start_datestring date-time

subscription_idstring required

Response

addon_idstring

addon_status'active' | 'cancelled' | 'pending'

cancellation_reasonstring

cancelled_atstring date-time

created_atstring date-time

created_bystring

end_datestring date-time

entity_idstring

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

environment_idstring

idstring

metadataobject

start_datestring date-time

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

tenant_idstring

updated_atstring date-time

updated_bystring

Changes

Changed in 7 of the 12 revisions of this API.12531

Jun 29, 2026cef2964c102c310See the full diff
- ●
  removed the optional property subscription/customer_timezone from the response with the 200 status
  response-optional-property-removed
- ●
  added the new config enum value to the addon/entitlements/items/feature/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new config enum value to the addon/entitlements/items/feature_type response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property line_item_commitments/additionalProperties/commitment_time_buckets
  new-optional-request-property
- ○
  added the optional property addon/entitlements/items/config_value to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/coupon_associations/items/coupon/coupon_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/coupon_associations/items/subscription_line_item to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/customer/integrations/items/metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/customer/timezone to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/line_items/items/commitment_time_buckets to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/line_items/items/price/sequence to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/synced_price_sequence to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/timezone to the response with the 200 status
  response-optional-property-added
May 18, 2026f62d8a5fe7cf4See the full diff
- ●
  removed the optional property details from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
- ●
  added the new too_many_requests enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new too_many_requests enum value to the code response property for the response status 500
  response-property-enum-value-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 18, 20260cb3425d6580108See the full diff
- ●
  removed the optional property addon/type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property subscription/line_items/items/trial_period_days from the response with the 200 status
  response-optional-property-removed
- ●
  added the new ONETIME enum value to the subscription/billing_period response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ONETIME enum value to the subscription/commitment_duration response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ONETIME enum value to the subscription/line_items/items/billing_period response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ONETIME enum value to the subscription/line_items/items/commitment_duration response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ONETIME enum value to the subscription/line_items/items/price/billing_period response property for the response status 200
  response-property-enum-value-added
- ●
  added the new delegated_invoicing enum value to the subscription/subscription_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new grouped_invoicing enum value to the subscription/subscription_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new pending enum value to the addon_status response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property cadence
  new-optional-request-property
- ○
  added the new optional request property proration_behavior
  new-optional-request-property
- ○
  added the new ONETIME enum value to the request property line_item_commitments/additionalProperties/commitment_duration
  request-property-enum-value-added
- ○
  added the optional property subscription/auto_invoice_threshold to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/line_items/items/addon_association_id to the response with the 200 status
  response-optional-property-added
- ○
  removed the ONETIME enum value from the subscription/billing_cadence response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the ONETIME enum value from the subscription/line_items/items/price/billing_cadence response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the paused enum value from the addon_status response property for the response status 200
  response-property-enum-value-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 23, 202682f205e0f42922See the full diff
- ●
  removed the optional property subscription/line_items/items/price/trial_period from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property subscription/line_items/items/trial_period from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property subscription/line_items/items/price/trial_period_days to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property subscription/line_items/items/trial_period_days to the response with the 200 status
  response-optional-property-added
Apr 6, 20264ded3711f40169See the full diff
- ●
  removed the optional property error from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property error from the response with the 500 status
  response-optional-property-removed
- ●
  removed the optional property subscription/customer/parent_customer from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property subscription/customer/parent_customer_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property success from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property success from the response with the 500 status
  response-optional-property-removed
- ○
  added the optional property code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property http_status_code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property http_status_code to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property subscription/subscription_type to the response with the 200 status
  response-optional-property-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 4, 2026d1860fe0ee6711See the full diff
- ▲
  the start_date request property type/format changed from string/ to string/date-time
  request-property-type-changed
- ○
  added the optional property subscription/customer/integrations to the response with the 200 status
  response-optional-property-added
This revision also has 223 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 20, 2026bc91c95fbb1a1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history