• Pricing
  • Blog
Log inBook a demo
Activate add-on POSTCreate add-on POSTDeactivate add-on DELETEDelete add-on DELETEGet add-on GETList active add-ons GETList add-ons GETUpdate add-on PATCH
System status
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Create add-on

Create a new add-on linked to a feature. Each feature can only be assigned to one add-on.

POST
/addons

Create a new add-on linked to a feature. Each feature can only be assigned to one add-on.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Header Parameters

Idempotency-Key?string

Unique key used to safely retry this write for 24 hours without applying it twice.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/addons" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "basePrice": 0,    "featureId": "string",    "consumptionModel": "boolean"  }'
{  "id": "string",  "name": "string",  "slug": "string",  "description": "string",  "basePrice": -9007199254740991,  "featureCode": "string",  "featureName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "consumptionModel": "boolean",  "includedUnits": -9007199254740991,  "overageRate": -9007199254740991,  "creditCost": -9007199254740991,  "object": "addon",  "livemode": true}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Activate add-on POST

Activate an add-on on a subscription. Charges a prorated amount for the current billing period.

Deactivate add-on DELETE

Deactivate an add-on from a subscription.

name*string
Length1 <= length <= 100
description?string
Lengthlength <= 255
basePrice*integer
Range0 <= value <= 9007199254740991
featureId*string
Length1 <= length
consumptionModel*string