POST /v1/object/usage

Zuora WSDL version number.

Default value: "79"

Default value: "application/json"

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

Default value: false

The number of the account associated with the usage data. This field is only required if no value is specified for the AccountId field. Character limit: 50 Values: a valid account number.

A unique number for the rate plan charge related to the usage record. For example, C-00000007.

Indicates the number of units used.

Character limit: 16

Values: A valid decimal amount. It could be a negative amount. Negative quantity usage records are used to adjust the previously uploaded usage records.

The ID of the account associated with the usage data. This field is only required if no value is specified for the AccountNumber field. Character limit: 32 Values: a valid account ID.

The original ID of the subscription that contains the fees related to the usage data.

The ID of a subscription might change when you create amendments to the subscription. It is good practice to use the unique subscription number that you can specify in the SubscriptionNumber field.

The OrginalId of the rate plan charge related to the usage record, e.g., 2c9081a03c63c94c013c6873357a0117 Character limit: 32 Values: a valid rate plan charge OriginalID.

The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation. Character limit: 29 Values: a valid date and time value.

The unique external reference of the usage record. See Upload usage record with unique key for information on how to use this field. Note: This field is only available if you set the X-Zuora-WSDL-Version request header to 114 or later.

Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in Billing Settings. Character limit: Values: a valid unit of measure

The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the EndDateTime, the StartDateTime field does affect usage calculation. Character limit: 29 Values: a valid date and time value

A description of the usage record.

The unique identifier number of the subscription that contains the fees related to the usage data.

It is good practice to use this field when creating usage records.