Sign in
api

post/api/subscriptions/addons/update/

Query parameters

addon_idstring uuid required

Filter to a specific addon.

attached_customer_idstring required

Filter to a specific customer.

attached_plan_idstring uuid required

Filter to a specific plan.

valuestring required
property_namestring required

The string name of the property to filter on. Example: 'product_id'

Filter to a specific set of subscription filters. If your billing model only allows for one subscription per customer, you very likely do not need this field. Must be formatted as a JSON-encoded + stringified list of dictionaries, where each dictionary has a key of 'property_name' and a key of 'value'.

Request body

invoicing_behavior'add_to_next_invoice' | 'invoice_now'

The invoicing behavior to use when changing the quantity. Invoice now will recalculate the amount due immediately, whereas add_to_next_invoice will wait until the end of the subscription to do the calculation.

turn_off_auto_renewboolean

Turn off auto renew for the addon

end_datestring date-time

Change the end date for the addon.

quantityinteger

Change the quantity of the susbcription to be this number.

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.

Changes