Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Subscriptions

Get usage product

Retrieves detailed information for a specific usage-billed product, including its prices.

get/subscriptions/usages/{id}

Path parameters

idstring uuid required

The unique identifier of the usage product

Response

When request is successful. Returns a 'Usage' object.

idstring uuid

Unique identifier of the usage product.

hrefstring nullable
relationstring nullable
methodstring nullable
smokeballIdstring nullable

Unique Smokeball identifier of the usage product.

productSuitestring nullable

The product suite that this usage product belongs to.

iconIdentifierstring nullable

Icon identifier for the product.

namestring nullable

The display name of the usage product.

descriptionstring nullable

The description of the usage product.

trialPeriodDaysinteger nullable

The number of days the usage product can be trialed for.

createdDatestring date-time

The created date of the usage product.

updatedDatestring date-time

The updated date of the usage product.

Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "prices": [
    {
      "default": true,
      "active": true,
      "type": "Recurring",
      "name": "\"$109 per user/month\"",
      "amount": 5900,
      "interval": "Monthly"
    }
  ]
}