List billing meter event summaries

Retrieve a list of billing meter event summaries.

Parameters

customerstringRequired
The customer for which to fetch event summaries.

end_timetimestampRequired
The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.

idstringRequired
Unique identifier for the object.

start_timetimestampRequired
The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.

value_grouping_windowenum
Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, …, 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).
Possible enum values
day
Generate event summaries per day.
hour
Generate event summaries per hour.

More parameters

ending_beforestring

limitinteger

starting_afterstring

Returns

Returns a list of billing meter event summaries.

GET /v1/billing/meters/:id/event_summaries

Server-side language

curl -G https://api.stripe.com/v1/billing/meters/mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA/event_summaries \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d customer=cus_Pp40waj64hdRxb \
  -d start_time=1711584000 \
  -d end_time=1711666800 \
  -d value_grouping_window=hour

Response

{
  "object": "list",
  "data": [
    {
      "id": "mtrusg_test_6041CMAXJrFdZ56U76ce6L35Hz7xA3Tn58z5sY7bq6gM3XN5bx5Y459D4Xt2E17ko6M86kt7kV3bl5PM7LV59l4sY50b6oU5QD7bY3HP58z5sY7bq6gM3Y57LF2Dr7od3Hb8927gh4Tt4Lo4xO4ge60T81C6Y53gl4QS2D33ft3HC3Xl3bk3Cy3Cy",
      "object": "billing.meter_event_summary",
      "aggregated_value": 15,
      "end_time": 1711663200,
      "livemode": false,
      "meter": "mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA",
      "start_time": 1711659600
    },
    {
      "id": "mtrusg_test_6041CMAXJrFdZ56U76ce6L35Hz7xA3Tn58z5sY7bq6gM3XN5bx5Y459D4Xt2E17ko6M86kt7kV3bl5PM7LV59l4sY50b6oU5QD7bY3HP58z5sY7bq6gM3Y57LF2Dr7od3Hb8927gh4Tt4Lo4xO4ge60T81C6Y53gl4QS2D33ft3HC3Xi3Cy3Cy3Cy",
      "object": "billing.meter_event_summary",
      "aggregated_value": 10,
      "end_time": 1711659600,
      "livemode": false,
      "meter": "mtr_test_61Q8nQMqIFK9fRQmr41CMAXJrFdZ5MnA",
      "start_time": 1711656000
    }
  ],
  "has_more": false,
  "url": "/v1/billing/meters/:id/event_summaries"
}

Credit Grant

A credit grant is an API resource that documents the allocation of some billing credits to a customer.

Related guide: Billing credits

Endpoints

POST/v1/billing/credit_grants

POST/v1/billing/credit_grants/:id

GET/v1/billing/credit_grants/:id

GET/v1/billing/credit_grants

POST/v1/billing/credit_grants/:id/expire

POST/v1/billing/credit_grants/:id/void

Credit Balance Summary

Indicates the billing credit balance for billing credits granted to a customer.

Endpoints

GET/v1/billing/credit_balance_summary

Credit Balance Transaction

A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.

Endpoints

GET/v1/billing/credit_balance_transactions/:id

GET/v1/billing/credit_balance_transactions

Plans

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single “gold” product that has plans for $10/month, $100/year, €9/month, and €90/year.

Related guides: Set up a subscription and more about products and prices.

Endpoints