Retrieve Usage Summary For A Subscription

Retrieve usage summary for a subscription

GET/subscriptions/{subscription-id}/usage_summary

Use it in a workflow

Add a step and choose the Chargebee connector.
Pick the Retrieve Usage Summary For A Subscription action (under Chargebee API).
Fill in the fields below, then reference the result from later steps as {{retrieveUsageSummaryForASubscription.response.data}}.

Request

Path parameters

subscription-idstringrequired

Query parameters

limitinteger (int32)

The number of resources to be returned.

Default 10

offsetstring

<p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code> to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code> obtained in the previous iteration of the API call.</p>

feature_idstringrequired

Unique identifier of the metered [feature](/docs/api/features/feature-object#id) for which usage is aggregated

window_sizestring

Specifies the aggregation interval for the reporting window. If omitted, the response includes a single aggregate for the entire reporting window. \* day - Aggregates usage by day. \* minute - Aggregates usage by minute. \* hour - Aggregates usage by hour. \* month - Aggregates usage by month. \* week - Aggregates usage by week.

One ofmonthweekdayhourminute

timeframe_startinteger (unix-time)

Start of the reporting window, in Unix epoch seconds. If not provided, defaults to the start of the current subscription term.

timeframe_endinteger (unix-time)

End of the reporting window, in Unix epoch seconds. If not provided, defaults to the current time

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

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

chargebee-request-origin-user-encodedstring (email)

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.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

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.

Response

Returns 200 with an object. Read it in later steps with {{retrieveUsageSummaryForASubscription.response.data.<field>}}.

listarray<object>

usage_summaryobjectrequired5 fields

Usage summary represents aggregated usage data for a metered [feature](/docs/api/features/feature-object) in a [subscription](/docs/api/subscriptions/subscription-object) over a specific reporting period. The aggregation is performed based on the [aggregation method](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/defining-metered-features) configured in Billing. Use this resource to analyze feature-level usage for reporting or analytics purposes, independent of usage billing or invoicing.

next_offsetstring

<p class="mb-2">This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>.</p>

json

{
  "list": null,
  "next_offset": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.

Was this page helpful?