Billing Reconciliation

Partner administrators can use the Wholesale Billing APIs to generate custom billing reports that display usage consumption at the per partner, per customer, or per user levels. Partners can use this information to reconcile their monthly invoice so that they can bill their customers and users according to their usage consumption.

Partners can also generate custom billing reports for sub-partners using subPartnerOrgId parameter.

There are four APIs that are available to partner administrators who meet the minimum access requirements.

Billing API

Purpose of API

Partner Admin Access Requirement

Create a Wholesale Billing Report

Used to generate a billing report.

Read / Write

Get a Wholesale Billing Report

Used to get a generated billing report for download.

Read

List Wholesale Billing Reports

Used to list the billing reports that exist for that partner.

Read

Delete a Wholesale Billing Report

Used to delete an existing billing report.

Read / Write

Data Source

Data for the Billing reports gets pulled from the usage consumption data that Webex tracks for each partner. Each day, Webex tracks the previous day's usage consumption for all partners, customers and users and aggregates the data so that it can be used to generate the partner's monthly invoice. Billing APIs leverage this data, letting partner admins generate custom reports so that the partner can reconcile usage consumption from their monthly invoice at the partner, customer and user levels.

For more detailed information on how Webex invoices partners, see Service Provider Billing.

Create a Wholesale Billing Report

Use this procedure to generate a custom billing report that you can use to reconcile your billing.
1

Go to the Create a Wholesale Billing Report API.

2

Enter the billing period by entering values for the billingStartDate and billingEndDate in the format that the API specifies. You can enter any date from the last five years, but not the current day.

3

Enter the Type of report:

  • PARTNER (this is the default)—Shows usage consumption at the partner level.
  • CUSTOMER—Shows total usage consumption broken down to the level of customer organizations under the partner.
  • USER—Shows total usage consumption broken down to the level of customer organizations and subsribers under the partner.
4

Click Run to generate the report.

5

Copy the report id from the API output. You can use this value with the Get API in order to get the generated billing report.

What to do next

Go to Get a Wholesale Billing Report in order to download a copy of the report.

Get a Wholesale Billing Report

Once a billing report is generated, use this API to obtain a specific billing report. The report gets output to a URL where it is available for download for 30 minutes following the completion of the GET request.
1

Go to the Get a Wholesale Billing Report API.

2

In the GET line, click the id button and enter the unique id value for the report.

3

Click Run.

4

The API outputs report status. The output includes the tempDownloadURL parameter, which provides a URL from which you can download the report.

5

Copy the tempDownloadURL into a browser in order to access and download the report.

List Wholesale Billing Reports

Use this API to obtain a list of generated billing reports for the partner organization. You can list all existing reports, or limit the list to those reports that meet the specified parameters such as your billing period and billing type (Partner, customer, user).

If you enter optional parameters, the API returns only those reports that match exactly the parameters that you enter. For example, if you enter a billing period, only reports that use that specific billing period get returned—reports that fall within the period, but which don’t exactly match the dates are not returned.
1

Go to the List Wholesale Billing Report API

2

Under Query Parameters, enter any search parameters that you want to use (for example, the startDate, endDate, Type, sortBy on). For additional details on these parameters, see the Developer help on the API.

3

Click Run.

The API outputs the list of reports along with the unique report id and status (COMPLETED, IN_PROGRESS).

What to do next

Take a record of the id for any reports that you want to download. Go to Get a Wholesale Billing Report in order to download the report.

Delete a Wholesale Billing Report

Use this procedure to delete a generated billing report based on report id. A few examples where you may want to delete a report include:

  • If you want to regenerate an existing billing report, you must first delete the existing report. After you delete the existing report, you can create a new report for that period. Note that the delete requirement does not exist if the report is failed or is in progress.

  • If a report is generated and you send the URL to the wrong person, you can delete the report and they won’t be able to access it.

1

Go to the Delete Wholesale Billing Report API.

2

Enter the report Id.

3

Click Run.

Billing Report Fields

Billing reports contain the following fields:

Field

Additional information

Appears in reports of the type

PARTNER_NAME

Name of partner

PARTNER, CUSTOMER, USER

PARTNER_ORG_ID

Unique partner identifier

PARTNER, CUSTOMER, USER

SUBSCRIPTION_ID

Unique subscription identifier

PARTNER, CUSTOMER, USER

SERVICE_NAME

Name of service

(e.g, COMMON_AREA_CALLING, WEBEX_CALLING, WEBEX_SUITE, WEBEX_MEETINGS)

PARTNER, CUSTOMER, USER

SKU

Sku for the service

PARTNER, CUSTOMER, USER

DESCRIPTION

Description of the service

PARTNER, CUSTOMER, USER

CONSUMPTION_START_DATE

Start of the service consumption. Along with the following field, this value defines the usage period.

PARTNER, CUSTOMER, USER

CONSUMPTION_END_DATE

End of the service consumption. Along with the preceding field, this value defines the usage consumption period.

PARTNER, CUSTOMER, USER

QUANTITY

Represents the aggregated user usage consumption per partner, per customer or per user (depending on the report and level at which you're viewing the data).

Calculation:

They calculate the per-day quantity for each user on a prorated basis for that day.

Usage for a full day = 1

Usage for a half day = 0.5

They sum the per-day totals for all days within the billing period to calculate the total quantity for that user within that billing period.

For customer and partner-level reports, the totals for all users are aggregated to provide a total quantity for that customer or partner.

PARTNER, CUSTOMER, USER

CUSTOMER_ORG_ID

Internal Customer Unique Identifier

CUSTOMER, USER

CUSTOMER_EXTERNAL_ID

Customer Unique Identifier as provided by a partner

CUSTOMER, USER

SUBSCRIBER_ID

Unique identifier for the subscriber

USER

USER_ID

The subscriber's Webex user ID

USER

WORKSPACE_ID

Unique workspace identifier

USER

LOCATION_ID

Unique Location Identifier

CUSTOMER, USER

LICENSE_ID

License Identifier

This field is visible only for Wholesale packages. The License_ID is blank for licenses assigned before the introduction of this field.

A billing report may show multiple rows for the same Wholesale package, with each row representing a unique package/license ID combination.

If the LICENSE_ID field is present, each row represents a unique package/location/license ID combination.

CUSTOMER, USER

Provisioning a package to a user triggers Webex Wholesale billing, while removing the package assignment stops it.