POST /batch/usage_events

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Possible values:

• "all-disabled"

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

skip all actions to be done on the events

Possible values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

skip only emails

Possible values:

• "all-disabled"

Parameters for batch usage events

The timestamp indicating when this usage occurred, represented as Epoch time in milliseconds .
Example: 1738732394123 represents the timestamp for February 5, 2025, at 05:13:14.123 UTC.
Note : The timestamp must be within the last 12 hours.

A schema-less field that accepts any JSON-formatted data to define the attributes of the ingested event. It is a requirement to structure the data in a flat format wherever possible for better compatibility with downstream processing.

We strongly encourage using unique field names---particularly for fields intended for metering purposes. This approach enhances clarity and maintainability in the future.

For example, a field named status,

• Can represent string values such as accepted or processing in one context.

• In another scenario, it might hold numeric values, such as HTTP response codes like 200, 300, or 400.

Note : There is a size limit of 1 KB.

An identifier used by the Chargebee's customer to distinguish between multiple events generated at the same timestamp for a single subscription_id.

The combination of usage_timestamp, subscription_id, and deduplication_id uniquely identifies each event.

Example:

If 3 events are generated for subscription_id = sub-1 at 2025-04-01T00:00:00.000Z, each event must have a distinct deduplication_id.

The unique identifier of a subscription.
Note:

• If an existing subscription_id is provided, usage data is recorded against it.
• If the subscription does not exist yet in Chargebee, a new subscription_id can be used, and the subscription can be imported later, once the usage is successfully recorded.
• During invoice generation, recorded usage linked to the subscription_id will be applied to the invoice.