Operations API
Subscriptions

Create Addon

This API endpoint (POST) creates an addon on a subscription. If the request succeeds, it returns an Addon Object. Permissions: subscriptions.edit Webhook event: subscription-updated

Path Parameters

id * The id of the subscription to update.

Body Parameters

duration string * The possible values are once, limited and recurring.



cost integer * The cost of the addon.



description string * A short description of the addon.



number_of_payments integer The total number of payments to collect for the addon. Required if duration is set to limited.



tax_calculation string Determines how the tax will be calculated for the addon. The possible values are inclusive and exclusive. The default value is exclusive.



vat_classification string Determines how the VAT will be calculated for the addon. The possible values are digital, physical and notax. The default value is digital. Available for subscriptions with VAT taxes enabled.