The Billing Insights API is designed to deliver in-depth insights into billing and invoicing data associated with any Talkdesk Instance.
By leveraging the Billing Insights API, resellers, Business Process Outsourcers (BPOs), Managed Service Providers (MSPs), or similar partner entities to Talkdesk, who manage multiple Talkdesk Instances, have a way to get access to billing and invoicing data regarding those customers, in one single API call.
The Billing Insights API encompasses five key endpoints:
- Get Accounts - provides the names and IDs of Talkdesk Instances affiliated with the Talkdesk Organization. These IDs serve as a gateway to retrieve detailed information on Talkdesk Instances through subsequent endpoints.
- Get Products - provides a comprehensive view of available products and their respective TD Product codes. By aligning with the Talkdesk price book, it facilitates seamless mapping between products and their associated SKUs.
- Get Subscriptions - provides information on the subscriptions of one or more Talkdesk Instances.
- Get Invoices - provides an exhaustive breakdown of invoice line items, associated with a Talkdesk Instances.
- Get Monthly Usage - provides aggregated usage data for Talkdesk Instances. Data is segmented by month for each product, offering insights into usage patterns.
As a Talkdesk Partner you can have access to the Billing Insights API endpoints via OAuth Clients that Talkdesk needs to provide you with. Hence you are requested to ask Talkdesk for the required OAuth Clients. There is no Self-service way to provision the entitlement to these endpoints.
To get access to the OAuth Clients needed to leverage the Billing Insights API endpoints, please read the “Billing Insights API: Entitlement”