Partner Billing Usage API
The Partner Billing Usage API is intended for Genesys partner companies to create systems for customer billing of Genesys Cloud users, devices and resources and AppFoundry applications.
Note: The Partner Billing API includes only pre-tax price values. It is the responsibility of the customer to pay all taxes that are on their invoice. The Partner Billing API does not include Genesys Cloud Voice and Bring Your Own Carrier Cloud telco usage.
Getting Set Up
Follow the Partner Trust establishment processes defined in the below pages on Resource Center:
Additional Setup Tasks
After trust has been established:
- Login to the Trustee (partner) org
- Go to Admin > People & Permissions > Roles / Permissions
- Add a role
- Name it Trustee Billing Reader
- Add the affiliateOrganization:clientBilling:view permission
- Save the role and assign it to any user who needs to access a Trustor organization’s billing information
Sample API Request
- Price values are for placement only.
- Prices returned by the Partner Billing API do not include taxes.
- It is the responsibility of the customer to pay all taxes that are on their invoice.
Copied
{
"organization":{
"id":"9d750d63-95ae-4df7-8955-2bca7152ca19",
"name":"Test Org Name"
},
"currency":"USD",
"enabledProducts":[
"PureCloudCommunicateOverage",
"PureCloudCollaborateOverage",
"salesforceCommunicateOverage",
"PureCloud3Overage",
"salesforceOverage",
"PureCloudCommunicateStandaloneOverage",
"skypePremiumAppIntegrationOverage",
"avtexDynamicsOverage"
],
"subscriptionType":"PREPAY",
"rampPeriodStartDate":"2018-07-01T00:00:00Z",
"rampPeriodEndDate":"2018-08-31T23:59:59.999Z",
"billingPeriodStartDate":"2020-04-01T00:00:00Z",
"billingPeriodEndDate":"2020-04-30T23:59:59Z",
"usages":[
{
"name":"PureCloud for Avtex InteractionSync Add-on",
"partNumber":"PC-170-NV-AVTEXINSY",
"grouping":"billable-app-usage-license",
"unitOfMeasureType":"seat",
"usageQuantity":"0",
"overagePrice":"23.74",
"prepayQuantity":"2",
"prepayPrice":"23.74",
"isCancellable":false,
"bundleQuantity":"1",
"isThirdParty":false
},
{
"name":"PureCloud 3 User",
"partNumber":"PC-170-NV-USR3",
"grouping":"user-license",
"unitOfMeasureType":"seat",
"usageQuantity":"0",
"overagePrice":"170.00",
"prepayQuantity":"2",
"prepayPrice":"170.00",
"isCancellable":false,
"bundleQuantity":"1",
"isThirdParty":false
},
{
"name":"PureCloud for Salesforce Communicate Add-on",
"partNumber":"PC-170-NV-PCSFCAN",
"grouping":"billable-app-usage-license",
"unitOfMeasureType":"seat",
"usageQuantity":"0",
"overagePrice":"17.99",
"prepayQuantity":"2",
"prepayPrice":"17.99",
"isCancellable":false,
"bundleQuantity":"1",
"isThirdParty":false
},
{
"name":"PureCloud Communicate User",
"partNumber":"PC-170-NV-USCOM",
"grouping":"user-license",
"unitOfMeasureType":"seat",
"usageQuantity":"0",
"overagePrice":"12.00",
"prepayQuantity":"2",
"prepayPrice":"12.00",
"isCancellable":false,
"bundleQuantity":"1",
"isThirdParty":false
},
{
"name":"PureCloud Communicate Stand-alone Phone",
"partNumber":"PC-170-NV-USCOMSAP",
"grouping":"device",
"unitOfMeasureType":"phone",
"usageQuantity":"7",
"overagePrice":"11.99",
"prepayQuantity":"2",
"prepayPrice":"9.99",
"isCancellable":false,
"bundleQuantity":"1",
"isThirdParty":false
},
{
"name":"PureCloud Collaborate User",
"partNumber":"PC-170-NV-USCOL",
"grouping":"user-license",
"unitOfMeasureType":"seat",
"usageQuantity":"0",
"overagePrice":"0.00",
"prepayQuantity":"2",
"prepayPrice":"0.00",
"isCancellable":false,
"bundleQuantity":"1",
"isThirdParty":false
},
{
"name":"PureCloud Skype for Business WebSDK",
"partNumber":"PC-170-NV-PCSKYPE",
"grouping":"billable-app-usage-license",
"unitOfMeasureType":"seat",
"usageQuantity":"0",
"overagePrice":"6.00",
"prepayQuantity":"2",
"prepayPrice":"6.00",
"isCancellable":false,
"bundleQuantity":"1",
"isThirdParty":false
},
{
"name":"PureCloud for Salesforce Add-on",
"partNumber":"PC-170-NV-PCSFAN",
"grouping":"billable-app-usage-license",
"unitOfMeasureType":"seat",
"usageQuantity":"0",
"overagePrice":"19.99",
"prepayQuantity":"2",
"prepayPrice":"19.99",
"isCancellable":false,
"bundleQuantity":"1",
"isThirdParty":false
}
],
"contractEffectiveDate":"2018-07-01T00:00:00Z",
"contractEndDate":"2019-09-30T23:59:59.999Z",
"minimumMonthlyAmount":"0.00"
}