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
add | addList | delete | deleteList | get | getDeleted | getList | search | searchMoreWithId | getSavedSearch |update | getSelectValue | updateList | upsert | upsertList
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 |
|---|---|---|
|
|
Subscription |
The subscription name. This is a RecordRef field. |
|
|
Subscription Line |
The subscription line name. This is a RecordRef field. |
|
|
Quantity |
The usage quantity number. This is a double field. |
|
|
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.
For information on using the SOAP Schema Browser, see SOAP Schema Browser.