Legacy Dev Forum Posts

 View Only

Sign Up

How to get billing data from PureCloud to an external billing system?

  • 1.  How to get billing data from PureCloud to an external billing system?

    Posted 06-05-2025 18:14

    HLam | 2018-11-05 14:03:54 UTC | #1

    Hi all!

    I am a newcomer here, so this question might already been asked.

    I searched the API-documentation, but did not find any way how to GET billing information via PureCloud REST API to 3rd party billing system. I mean information including all these together or with separate requests:

    • Company (customer organisation), License Type, Quantity ((user) count of licence-type) and Rate (unit price) and Amount (total price).

    Any ideas how to do that?


    tim.smith | 2018-11-05 14:15:53 UTC | #2

    The billing APIs are available here: https://developer.mypurecloud.com/api/rest/v2/billing/index.html. If you need more than what that provides, you may consider inspecting user configuration directly. You can request additional billing features here: https://purecloud.ideas.aha.io/ideas.


    HLam | 2018-11-05 14:30:17 UTC | #3

    Thanks for your quick reply.

    Well I noticed that it is possible to GET this info with a billing API:

    " BillingUsageReport

    id

    ( string ): The globally unique identifier for the object.

    name

    ( string )

    startDate

    ( string ): The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

    endDate

    ( string ): The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

    usages

    ( array BillingUsage ): The usages for the given period.

    BillingUsage

    name

    ( string ): Identifies the billable usage.

    totalUsage

    ( string ): The total amount of usage, expressed as a decimal number in string format.

    resources

    ( array BillingUsageResource ): The resources for which usage was observed (e.g. license users, devices).

    BillingUsageResource

    name

    ( string ): Identifies the resource (e.g. license user, device).

    date

    ( string ): The date that the usage was first observed by the billing subsystem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

    selfUri

    ( string ): The URI for this object".

    I also inspected user-API, but did not find any way to get the price info (rate and amount in PureCloud invoice: https://www.youtube.com/watch?v=kbyay4lyFpY&feature=youtu.be) along other information.

    This might be a place for development request, yes.


    system | 2018-12-06 14:30:21 UTC | #4

    This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.


    This post was migrated from the old Developer Forum.

    ref: 3909