Delete an Add-on
DELETE
/v1/addons/:id
Click to copy
Use this endpoint to delete an add-on.
Handy Tips
You cannot delete an add-on associated with an invoice.
Is this page helpful?
Path Parameters
id
*
string
The unique identifier of an add-on. For example, ao_00000000000001
.
Response Parameters
id
string
The unique identifier of the created add-on. For example, ao_00000000000001
.
item
object
Details of the created add-on.
Show child parameters (7)
quantity
integer
This specifies the number of units of the add-on to be charged to the customer. For example, 2
. The total amount is calculated as amount
* quantity
.
created_at
integer
The Unix timestamp, indicates when the add-on was created. For example, 1581597318
.
subscription_id
string
The unique identifier of the Subscription to which the add-on is being added. For example, sub_00000000000001
.
invoice_id
string
The add-on is added to the next invoice that is generated after it is created. This field is populated only after the invoice is generated. Until then, it is null
. Once the add-on is linked to an invoice, it cannot be deleted.
Errors
The API key/secret provided is invalid.
Error Status: 4xx
This error occurs due to a mismatch between the API credentials passed in the API call and those generated on the dashboard.
Solution
Delete an Add-on
DELETE
/v1/addons/:id
Click to copy
Use this endpoint to delete an add-on.
Handy Tips
You cannot delete an add-on associated with an invoice.
Is this page helpful?
Path Parameters
id
*
string
The unique identifier of an add-on. For example, ao_00000000000001
.
Response Parameters
id
string
The unique identifier of the created add-on. For example, ao_00000000000001
.
item
object
Details of the created add-on.
Show child parameters (7)
quantity
integer
This specifies the number of units of the add-on to be charged to the customer. For example, 2
. The total amount is calculated as amount
* quantity
.
created_at
integer
The Unix timestamp, indicates when the add-on was created. For example, 1581597318
.
subscription_id
string
The unique identifier of the Subscription to which the add-on is being added. For example, sub_00000000000001
.
invoice_id
string
The add-on is added to the next invoice that is generated after it is created. This field is populated only after the invoice is generated. Until then, it is null
. Once the add-on is linked to an invoice, it cannot be deleted.
Errors
The API key/secret provided is invalid.
Error Status: 4xx
This error occurs due to a mismatch between the API credentials passed in the API call and those generated on the dashboard.
Solution