| Idempotency-Key | string <= 255 characters 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. |
| Accept-Encoding | string Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
| Content-Encoding | string Include the |
| Authorization | string The value is in the |
| Zuora-Entity-Ids | string 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 should not set this header. |
| Zuora-Org-Ids | string 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. |
| Zuora-Track-Id | string <= 64 characters 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 ( |
| X-Zuora-WSDL-Version | string Default: 79 Zuora WSDL version number. |
| AccountId | string The ID of the account associated with the usage data. This field is only required if no value is specified for the |
| AccountNumber | string The number of the account associated with the usage data. This field is only required if no value is specified for the |
| ChargeId | string The OrginalId of the rate plan charge related to the usage record, e.g., |
| ChargeNumber | string <= 50 characters A unique number for the rate plan charge related to the usage record. For example, C-00000007. |
| Description | string <= 200 characters A description of the usage record. |
| EndDateTime | string <date-time> 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. |
| ProductRatePlanChargeNumber | string Specify a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record. To use this field, you must set the Note: This field is only available if you have the Dynamic Usage Charges feature enabled. |
| Quantity required | number <double> 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. |
| StartDateTime required | string <date-time> 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 |
| SubscriptionId | string <= 32 characters 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 | string <= 100 characters 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. |
| UOM required | string 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 |
| UniqueKey | string 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 |
| property name* additional property | any Custom fields of the Usage object. The name of each custom field has the form |
{- "AccountId": "8ad09378905a5af201907ca1edb524c2",
- "UOM": "Minutes",
- "Quantity": 200,
- "StartDateTime": "2024-06-01T02:00:00.000+01:00"
}{- "Id": "8ad08ae29085a77b0190908bfdd67abb",
- "Success": true
}