Add-ons

Create an add-on

Changed on
post/api/v1/addons

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

descriptionstring nullable
max_instances_per_subscriptioninteger nullable
namestring required
price_idstring MeteroidId required
product_idstring MeteroidId required
self_serviceableboolean

Example request

{
  "price_id": "pri_7n42DGM5Tflk9n8mt7Fhc7",
  "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
}

Response

Add-on created

archived_atstring date-time nullable
created_atstring date-time required
descriptionstring nullable
fee_type'RATE' | 'SLOT' | 'CAPACITY' | 'USAGE' | 'EXTRA_RECURRING' | 'ONE_TIME'
idstring MeteroidId required
max_instances_per_subscriptioninteger nullable
namestring required
price_idstring MeteroidId required
product_idstring MeteroidId required
self_serviceableboolean required

Example response

{
  "entitlements": [
    {
      "feature_id": "feat_7n42DGM5Tflk9n8mt7Fhc7",
      "id": "ent_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ],
  "id": "add_7n42DGM5Tflk9n8mt7Fhc7",
  "price_id": "pri_7n42DGM5Tflk9n8mt7Fhc7",
  "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
}

Changes

  • v107a61fe347a5Revision changes
    • breaking

      removed the required property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

  • v1ed86d893d43eRevision changes
    • breaking

      added to the // response property oneOf list for the response status

    • warning

      removed the request property

    • info

      added discriminator to // response property for the response status

    • info

      removed subschema #1 subschema #2 from the // response property oneOf list for the response status