---
title: "Get usage products"
method: GET
path: "/subscriptions/usages"
tags: ["Subscriptions"]
---

# Get usage products

`GET /subscriptions/usages`

## Request

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

Returns a list of all usage-billed products available for subscription.

## Response `200`

When request is successful. Returns a collection of 'Usage' objects.

- UsageCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` Usage[], nullable
    - `id` string, uuid: Unique identifier of the usage product.
    - `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 usage product.
    - `productSuite` string, nullable: The product suite that this usage product belongs to.
    - `iconIdentifier` string, nullable: Icon identifier for the product.
    - `name` string, nullable: The display name of the usage product.
    - `description` string, nullable: The description of the usage product.
    - `trialPeriodDays` integer, nullable: The number of days the usage product can be trialed for.
    - `prices` Price[], nullable: The chargeable metered price options for the usage product.
      - `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 usage product.
    - `updatedDate` string, date-time: The updated date of the usage product.

---

[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)