v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

post/api/subscriptions/{subscription_id}/addons/attach/

Path parameters

subscription_idstring required

The ID of the subscription to add an addon to.

Request body

addon_idstring uuid

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.

metadataobject

A JSON object containing additional information about the add-on subscription. This will be returned in the response when you retrieve the add-on subscription.

Response

addon_subscription_idstring required
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
auto_renewboolean required

Whether the subscription automatically renews. Defaults to true.

metadataobject required