Usage

Important:

Most types of records are also supported in REST web services. For a list of all records supported in REST, see REST Web Services Supported Records.

Important:

For information about working with this record type in REST web services, see Usage.

In the SuiteBilling feature, usage is connected to a subscription line. Examples of usage include money, time, cellular data, internet data, etc. The usage record is defined in the sales XSD.

For details about working with the usage record in the user interface, see Creating Usage Records.

Usage Prerequisites

To work with the usage record in SOAP web services, you must have the SuiteBilling feature enabled for your account.

To add a usage record, you must first add the following prerequisite records in the user interface:

Subscription
Subscription Line

Usage Supported Operations

Note:

You can also use the asynchronous equivalents of SOAP web services list operations. For information about asynchronous operations, see SOAP Web Services Asynchronous Operations. For more information about request processing, see Synchronous Versus Asynchronous Request Processing.

Usage Notes and Field Summary

The usage record does not support user-event scripts.

Body Fields

When creating a usage record, you are required to define the following body fields:

Field Name	Label in UI	Description
`usageSubscription`	Subscription	The subscription name. This is a RecordRef field.
`usageSubscriptionLine`	Subscription Line	The subscription line name. This is a RecordRef field.
`usageQuantity`	Quantity	The usage quantity number. This is a double field.
`usageDate`	Date	The usage date. This is a dateTime field.

Field Name

Label in UI

Description

usageSubscription

Subscription

The subscription name.

This is a RecordRef field.

usageSubscriptionLine

Subscription Line

The subscription line name.

This is a RecordRef field.

usageQuantity

Quantity

The usage quantity number.

This is a double field.

usageDate

Date

The usage date.

This is a dateTime field.

The SOAP Schema Browser includes definitions for all body fields, sublist fields, search filters, and search joins available to this record. For details, see the SOAP Schema Browser’s usage reference page.