TAtalkdesk
Billing

Get subscription license details

Changed on

Retrieves detailed information about a specific subscription license, including rate plan details, pricing, currency, license model, and contract start and end dates.

get/billing/account/subscription/licenses/{id}

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/billing/account/subscription/licenses/{id}
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: licenses:read

Path parameters

idstring required
Example:2c92c0f94d65a21d014d6ca280895ca8

The unique identifier for an account subscription license.

Response

Detailed information about a specific subscription license, including rate plan details, pricing, and contract dates.

idstring

The unique identifier for an account subscription license.

product_rate_plan_idstring

The unique identifier of the product rate plan in the billing system.

product_rate_plan_namestring

The name of the product rate plan (e.g., 'Annual Licenses - Enterprise').

friendly_namestring

A human-readable display name for the license.

product_family'ADD_ON' | 'LICENSE' | 'THIRD_PARTY_APP_CONNECT'

The product family category for this license.

product_rate_plan_descriptionstring

A detailed description of the product rate plan.

billing_period'MONTH' | 'QUARTER' | 'SEMI_ANNUAL' | 'ANNUAL' | 'TWO_YEAR' | 'THREE_YEAR' | 'FIVE_YEAR'

The billing cycle frequency for this license.

quantityinteger

The total number of seats purchased for this license.

priceinteger

The price per billing period for this license, in the smallest currency unit (e.g., cents).

currencystring

The currency used to charge the account, following the ISO 4217 standard.

self_serviceboolean

Defines if the customer can make a self-service purchase of this license.

model'NAMED' | 'CONCURRENT'

The license model that determines how seats are counted for this license.

multipliernumber double

The factor applied to quantity to compute the seat_limit. Defaults to 1 (no scaling).

seat_limitinteger

The maximum number of seats that can be assigned for this license. This value is derived from quantity and may differ from it for products where each unit represents multiple seats; the result is rounded up to a whole seat.

seats_in_useinteger

The total number of seats currently in use for this license.

start_atstring date-time

The start date of the license contract in ISO 8601 format.

finish_atstring date-time

The end date of the license contract in ISO 8601 format.

next_billing_datestring date-time

The next billing date for this license in ISO 8601 format.

Changes