---
title: "Get an add-on"
method: GET
path: "/subscriptions/addons/{id}"
tags: ["Subscriptions"]
---

# Get an add-on

`GET /subscriptions/addons/{id}`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/subscriptions/addons/{id}`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Returns the specified product add-on with its features and pricing.

Use this endpoint to retrieve add-on information when only an id is available.

## Path parameters

- `id` string, uuid, required

## Response `200`

When request is successful. Returns an 'AddOn' object.

- AddOn
  - `id` string, uuid: Unique identifier of the add-on.
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `smokeballId` string, nullable: Unique Smokeball identifier of the add-on. This identifier convenience purposes only and should not be used to interact with the subscriptions API.
  - `productSuite` string, nullable: The product suite that this add-on belongs to.
  - `name` string, nullable: The display name of the add-on.
  - `description` string, nullable: The description of the add-on. Can be used to describe the add-on to a customer.
  - `trialPeriodDays` integer, nullable: The number of days the add-on can be trialed for. Cannot be trialed if zero or missing.
  - `prices` Price[], nullable: The price options for the add-on.
    - `id` string, nullable: The internal price id.
    - `externalPriceId` string, nullable: The external price id.
    - `default` boolean: Returns `true` if the price is the default price.
    - `active` boolean: Returns `true` if the Price is active.
    - `type` string: The type of the pricing option.
    - `name` string, nullable: The price display name.
    - `amount` number, double, nullable: The per unit amount for this pricing option for the specified interval (in cents).
    - `interval` string: The interval of the price.
  - `createdDate` string, date-time: The created date of the add-on.
  - `updatedDate` string, date-time: The updated date of the add-on.

## Other responses

- `404`: When add-on with specified id does not exist.
- `500`: When an error occurs while retrieving add-ons.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)