api
post/api/subscriptions/addons/add/
Request body
attach_to_customer_idstring nullable required
The add-on will be applied to this customer's subscription.
attach_to_plan_idstring uuid required
The add-on will be applied to the subscription with this plan ID.
addon_idstring uuid required
The add-on to be applied to the subscription.
quantityinteger
The quantity of the add-on to be applied to the subscription. Flat fees of add-ons will be multiplied by this quantity. Usage-based components of add-ons will be unaffected by the quantity.
Response
start_datestring date-time required
The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
end_datestring date-time required
The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
fully_billedboolean required
Whether the subscription has been fully billed and finalized.
auto_renewboolean required
Whether the subscription automatically renews. Defaults to true.