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

The Usage Record Summary object 

Billing
Usage Record Summary
The Usage Record Summary object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • invoicenullable string

    The invoice in which this usage period has been billed for.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • periodobject

    Start and end dates of this usage period. All usage after the start date and up to, and including, the end date is included.

    • period.endnullable timestamp

      The end date of this usage period. All usage up to and including this point in time is included.

    • period.startnullable timestamp

      The start date of this usage period. All usage after this point in time is included.

  • subscription_itemstring

    The ID of the subscription item this summary is describing.

  • total_usageinteger

    The total usage within this usage period.

The Usage Record Summary object
{
  "id": "sis_1Bnyrd2eZvKYlo2CuVcUbXln",
  "object": "usage_record_summary",
  "invoice": "in_1Bnyrd2eZvKYlo2CSV57GLV8",
  "livemode": false,
  "period": {
    "end": 1711987200,
    "start": 1709312400
  },
  "subscription_item": "si_18UXa82eZvKYlo2CbYoIEZVv",
  "total_usage": 1
}