Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

List all subscription item period summaries 

Billing
Usage Record Summary
List all subscription item period summaries

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

Parameters

No parameters.

More parameters

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

A dictionary with a data property that contains an array of up to limit summaries, starting after summary starting_after. Each entry in the array is a separate summary object. If no more summaries are available, the resulting array is empty.

GET /v1/subscription_items/:id/usage_record_summaries
curl -G https://api.stripe.com/v1/subscription_items/si_E9xjsAhGRXCCWe/usage_record_summaries \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/subscription_items/si_E9xjsAhGRXCCWe/usage_record_summaries",
  "has_more": false,
  "data": [
    {
      "object": "list",
      "url": "/v1/subscription_items/si_E9xjsAhGRXCCWe/usage_record_summaries",
      "has_more": false,
      "data": [
        {
          "id": "sis_1Bnyrd2eZvKYlo2CuVcUbXln",
          "object": "usage_record_summary",
          "invoice": "in_1Bnyrd2eZvKYlo2CSV57GLV8",
          "livemode": false,
          "period": {
            "end": 1711987200,
            "start": 1709312400
          },
          "subscription_item": "si_18UXa82eZvKYlo2CbYoIEZVv",
          "total_usage": 1
        }
      ]
    }
  ]
}