Skip to navigation

Usage data source

View as Markdown

A data source to export usage data that is used to determine usage-based charges.

Overview

Use this data source to export usage data that is used to determine usage-based charges. Usage data can be tied to associated Accounts, Subscriptions and Charges, and Product Catalog data.

Base object

Object

Description

Usage

Fields on a usage. It includes the following fields. See the field description in the Usage object reference.

  • Account Number
  • Created By ID
  • Created Date
  • Description
  • End Date
  • ID
  • Import ID
  • Quantity
  • RBS Status
  • Source Type
  • Start Date
  • Submission Date
  • Unit of Measure
  • Updated By ID
  • Updated Date

The following field is only available if you have the Prepaid with Drawdown feature enabled.

  • Unique Key

Object

Description

Account

The Customer Account and corresponding details to which the usage belongs.

Amendment

The amendment that is tied to the usage, if applicable.

Bill To Contact

The contact of the entity or person who you bill for your product or service.

Entity

The entity that the data relates to. Part of the Multi-entity feature. Contains the following fields:

  • Address 1
  • Address 2
  • City
  • Country
  • Created By ID
  • Created Date
  • Display Name
  • Email
  • ID
  • Name
  • Postal Code
  • State
  • Updated By ID
  • Updated Date

Sold To Contact

The contact of the entity/person to whom you sold your product or service.

Default Payment Method

Details and data of the default payment method of the customer account.

Product

The product related to the Usage.

Product Rate Plan

The pricing plan (in the Product Catalog) related to the Usage.

Product Rate Plan Charge

The charge (in the Product Catalog) that is related to the Usage.

Rate Plan

The pricing plan (for the subscription) that is related to the Usage.

Rate Plan Charge

The charge (for the subscription) that is related to the Usage.

Subscription

The subscription the usage belongs to.

Usage

This is the base object, which has information around the Usage record.