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

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Path Parameters

subscription_id
string
required

The ID of the subscription to add an addon to.

Body

addon_id
string

The add-on to be applied to the subscription.

quantity
integer
default: 1

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.

metadata
object

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

200 - application/json
addon_subscription_id
string
required
customer
object
required
addon
object
required
start_date
string
required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

end_date
string
required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

parent
object
required
fully_billed
boolean
required
auto_renew
boolean
required

Whether the subscription automatically renews. Defaults to true.

metadata
object
required
Change Prepaid UnitsCancel an Add-On