get https://api.talkdeskapp.com/express/subscriptions
Returns info on the account subscriptions. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged.
If you're a reseller, please check how to get entitled to this API here.
Scope
express-accounts-subscriptions:read
Body Response - Schema
200 OK
| Parameter | Type | Description |
|---|---|---|
| count | integer | The number of results on the current page. |
| page | integer | The number of the current page. |
| per_page | integer | The number of results per page. |
| total | integer | The total number of results for all pages. |
| total_pages | integer | The total number of pages. |
| _embedded | object | "_embedded" subdivides into: 1 - "subscriptions" (array[object]). Required. 1.1 - "id" (string) - The ID of the record. Example: 8f3e643c16671acaf60e8bceddbc1877 1.2 - "account ID"(string) - The ID of the Talkdesk account. Example: 5ea75fe7aa224700012eae40 1.3 - "contract_number"(string) - The number of the contract. Example: 00021679 1.4 - "currency"(string) - The 3 chars ISO code of the currency for the subscription according to ISO-4217 (https://www.iso.org/iso-4217-currency-codes.html ). Example: USD 1.4 - "billing_period"(string) - The billing period for the subscription on the contract level. Allowed values: ANNUAL QUARTER MONTH SEMI_ANNUAL OTHER Example: MONTH 1.5 - "status"(string) - The status of the contract. Allowed values: ACTIVATED OTHER Example: ACTIVATED 1.6 - "term"(string) - The duration of the contract in months. Example: 12 1.7 - "start_date"(string) - The start date of the contract. Example: 2023-08-31T00:00:00.000Z 1.8 - "end_date"(string) - The end date of the contract. Example: 2024-08-31T00:00:00.000Z 1.9 - "edition"(string) - The Talkdesk CX Cloud Edition on the contract. Example: Express 1.10 - "auto_renewal"(boolean) - The Talkdesk CX Cloud Edition on the contract. True if the contract is auto-renewed. False otherwise. Might be NULL if not applicable. Example: true 1.11 - "renewal_uplift"(number) - The percentage of uplift in the contract value upon renewal. Might be NULL if not applicable. Example: 9 1.12 - "product_id"(string) - The Talkdesk product code. Example: TD-LIC-APP-RC-101910 1.13 - "quantity"(number) - The quantity of product in the subscription. Example: 10 1.14 - "unit_price"(number) - The price for product unit. Example: 5 1.15 - "billing_frequency"(string) - The billing frequency for the subscription on a contract line level. Allowed values: ANNUAL QUARTER MONTH SEMI_ANNUAL OTHER Example: MONTH 1.16 - "pricing_model"(string) - The pricing model for the subscription. Allowed values: FIXED_FEE TIME_AND_MATERIALS OTHER Example: FIXED_FEE 1.17 - "concurrent"(boolean)- False if the license is billed per number of licensed users, True if it is billed by the number of simultaneous users using the product. Example: false 1.18 - "seasonal"(boolean)- True if the subscription is seasonal. These are monthly licenses that are not supposed to be renewed, but only effective during a period explicit in a contract to attend to our customers' business cycle and seasonality needs. Example: false |
| _links | object | "_links" subdivides into: 1 - "first" (object) 1.1 - "href" (string) - The link to the first page. 2. - "last" (object) 2.1 - "href" (string) - The link to the last page. 3. - "next" (object) 3.1 - "href" (string) - The link to the last page. 4. - "prev" (object) 4.1 - "href" (string) - The link to the previous page. 5 - "self" (object) 5.1 - "href" (string) - The link to the current page. |
400 (bad request), 401 (unauthorized), 403 (This caller is not authorized to query the given accounts. The accounts specified are not under the organization owning the current authentication token.)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Billing Insights API becomes available on January 31st, 2024.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.