TAtalkdesk
Billing

Get subscription

Changed on

Retrieves the aggregated and simplified information of the account subscription, including the product plan name, agent license count, contract duration, and renewal status.

get/billing/account/subscription

Request

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

Response

Aggregated subscription details for the account, including product plan, license count, and contract dates.

account_idstring

The unique identifier for the account.

subscription_product_namestring

The name of the subscription product plan (e.g., 'Enterprise', 'Professional').

agent_license_countnumber

The total number of agent licenses included in the subscription.

durationinteger

The duration of the subscription contract.

duration_unitsstring

The unit of measure for the subscription duration (e.g., 'month').

start_atstring date-time

The start date of the subscription in ISO 8601 format.

finish_atstring date-time

The end date of the subscription in ISO 8601 format.

auto_renewboolean

Whether the subscription automatically renews at the end of the current term.

Changes