Get Products

👍
Access and Registration
Authentication

🚧
If you're a reseller, please check how to get entitled to this API here.

Scope

express-products:read

Body Response - Schema

200 OK

Parameter	Type	Description
count	integer	The number of results on the current page. Example: 50
page	integer	The number of the current page. Example: 2
per_page	integer	The number of results per page. Example: 50
total	integer	The total number of results for all pages. Example: 425
total_pages	integer	The total number of pages. Example: 9
_embedded	object	"_embedded" subdivides into: 1 - "products" (array[object]). Required. 1.1 - "id" (string) - The Talkdesk product code Example: TD-LIC-APP-RC-101910 1.2 - "name"(string) - The name of the product. Example: Identity 1.3 - "family"(string) - The product family. Can be NULL for placeholder products like discounts.Allowed values: ADD_ON ADD_ON_PACKAGES CONSUMPTION CREDIT CREDIT_USAGE FINANCE LEGACY_ADD_ON LEGACY_LICENSE LICENSE PRODUCT_USAGE_RATE PROFESSIONAL_SERVICES SUNSET THIRD_PARTY_APPCONNECT OTHER Example: CONSUMPTION 1.4 - "unit_of_measure"(string) - The unit used to measure product usage. Can be NULL when not applicable. Allowed values: CHARACTERS CREDITS EACH MINUTES PER_API_CALL PER_ACCOUNT PER_CONNECTION PER_CONVERSATION PER_GB PER_MINUTE PER_PAGE PER_SEAT PER_SESSION PER_USE PER_VALIDATION OTHER Example: MINUTES 1.5 - "charge_type"(string) - How the product is charged. Can be NULL if not applicable. Allowed values: FIXED_RECURRING ONE_TIME ONE_TIME_CHARGE RECURRING USAGE OTHER Example: USAGE
_links	object	"_links" subdivides into: 1 - "first" (object) 1.1 - "href" (string) - The link to the first page. "last" (object) 2.1 - "href" (string) - The link to the last page. "next" (object) 3.1 - "href" (string) - The link to the last page. "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.