---
title: "Get an addon"
method: GET
path: "/addons/{addon_id}"
tags: ["AddOns"]
---

# Get an addon

`GET /addons/{addon_id}`

## Request

- Base URL: `https://api.togai.com`
- URL: `https://api.togai.com/addons/{addon_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/togaihq/apis/togai-apis/docs/addons/:addon_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get details of an addon

## Path parameters

- `addon_id` string, required

## Response `200`

Response for Create and Get addons requests

- AddOn: Request to create an addon
  - `name` string, required: Name of addon
  - `type` 'LICENSE' | 'FIXED_FEE' | 'CREDIT_GRANT' | 'NAMED_LICENSE', required: LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards
  - `billableName` string: Billable name of addon. Billable name takes precedence over name to display in invoice.
  - `id` string, required: Id of addon
  - `createdAt` string, date-time, required: Created Time of addon
  - `status` 'ACTIVE' | 'ARCHIVED', required: status of addon
  - `displayName` string, required: Display name of addon. This is an auto-generated field which contains billableName of addon. If billableName is not provided, name will be used as display name.

## Other responses

- `400`: Error response
- `401`: Error response
- `403`: Error response
- `404`: Error response
- `429`: Error response
- `default`: Error response

## Changes

- **2024-03-11** `cc0b10fb537e`: 1 warning
  - added the new `NAMED_LICENSE` enum value to the `allOf[#/components/schemas/CreateAddOnRequest]/type` response property for the response status `200`
- **2023-11-30** `b3351be4b462`: 1 info
  - added the required property `allOf[subschema #2]/displayName` to the response with the `200` status
- **2023-11-03** `a6c96c5ec06e`: 1 info
  - added the optional property `allOf[#/components/schemas/CreateAddOnRequest]/billableName` to the response with the `200` status
- **2023-09-02** `6b13f6f47735`: 1 breaking, 1 warning, 1 info
  - removed the required property `allOf[subschema #2]/displayName` from the response with the `200` status
  - removed the optional property `allOf[#/components/schemas/CreateAddOnRequest]/billableName` from the response with the `200` status
  - removed the `NAMED_LICENSE` enum value from the `allOf[#/components/schemas/CreateAddOnRequest]/type` response property for the response status `200`

[Operation history](https://skmtc.dev/togaihq/apis/togai-apis/changes/addons/:addon_id/get.md)

---

[API](https://skmtc.dev/togaihq/apis/togai-apis.md) - [All operations](https://skmtc.dev/togaihq/apis/togai-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/togaihq/apis/togai-apis/revisions/442f5d8f4aa0?raw)