GET /usages

The device from which the customer has made the request

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.

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.

optional, string filter
A unique and immutable id for the usage. If not provided, it is autogenerated.
Supported operators : is, is_not, starts_with

Example → id[is] = "usage_lsfja24411"

optional, enumerated string filter
The source from which the usage record was created. Possible values are : admin_console, api, bulk_operation.
Supported operators : is, is_not, in, not_in

Example → source[is] = "api"

The number of resources to be returned.

Default value: 10

optional, timestamp(UTC) in seconds filter
The time at which this usage occurred. Chargebee bills only those usages whose usage_date falls within a time when the subscription status was active or non_renewing. However, the remaining usage records are still stored and are retrievable.
Note: If usage_date corresponds to a time already invoiced, then it is stored but never invoiced unless the invoice is regenerated.
Supported operators : after, before, on, between

Example → usage_date[after] = "1601220958"

optional, string filter
When the usage has been invoiced, this is the id of the invoice. This is cleared when the invoice is voided or deleted.
Supported operators : is, is_not, starts_with, is_present

Example → invoice_id[is] = "null"

optional, string filter
The id of the item price to which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.
Supported operators : is, is_not, starts_with

Example → item_price_id[is] = "sprout"

optional, string filter
Sorts based on the specified attribute.
Supported attributes : usage_date
Supported sort-orders : asc, desc

Example → sort_by[asc] = "usage_date"
This will sort the result based on the 'usage_date' attribute in ascending(earliest first) order.

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

optional, string filter
The id of the subscription to which this usage record belongs.
Supported operators : is, is_not, starts_with

Example → subscription_id[is] = "active2"