v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Subscriptions

Get tier add-ons

Lists all available add-ons for a specific product tier.

The response includes:

Add-on details and pricing
Compatibility information
Usage limits
Dependencies or prerequisites

Use this endpoint to show customers which add-ons are available for their tier.

get/subscriptions/tiers/{id}/addons

Path parameters

idstring uuid required

The identifier of the product tier

Response

Successfully retrieved the list of available add-ons

idstring uuid

Unique identifier of the add-on.

hrefstring nullable

relationstring nullable

methodstring nullable

smokeballIdstring nullable

Unique Smokeball identifier of the add-on.

This identifier convenience purposes only and should not be used to interact with the subscriptions API.

productSuitestring nullable

The product suite that this add-on belongs to.

namestring nullable

The display name of the add-on.

descriptionstring nullable

The description of the add-on.

Can be used to describe the add-on to a customer.

trialPeriodDaysinteger nullable

The number of days the add-on can be trialed for.

Cannot be trialed if zero or missing.

createdDatestring date-time

The created date of the add-on.

updatedDatestring date-time

The updated date of the add-on.

Example response

[
  {
    "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "name": "Intake",
    "prices": [
      {
        "default": true,
        "active": true,
        "type": "Recurring",
        "name": "\"$109 per user/month\"",
        "amount": 5900,
        "interval": "Monthly"
      }
    ],
    "createdDate": "2022-04-23T14:00:00Z",
    "updatedDate": "2022-04-23T14:00:00Z"
  }
]