Credit usage

Get credit usage

Retrieves credit usage time-series data for a customer, grouped by feature, over a specified time range.

get/api/v1/credits/usage

Query parameters

limitinteger

Maximum number of items to return

afterstring

Return items that come after this cursor

beforestring

Return items that come before this cursor

customerIdstring required

Filter by customer ID (required)

resourceIdstring

Filter by resource ID

currencyIdstring

Filter by currency ID

timeRange'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR'

Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults to LAST_MONTH

startDatestring date-time

Start date for the credit usage time range (ISO 8601). Takes precedence over timeRange when provided

endDatestring date-time

End date for the credit usage time range (ISO 8601). Defaults to now when startDate is provided

groupBystring

Comma-separated list of feature dimension keys to group usage series by (up to 3). Each key matches /^[a-zA-Z0-9_$-]+$/

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

Credit usage data with time-series points per feature.

Changes

Changed in 10 of the 115 revisions of this API.21010

Aug 5, 202660500d436b852See the full diff
- ○
  added the required property data/series/items/eventCount to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/series/items/points/items/eventCount to the response with the 200 status
  response-required-property-added
Jul 28, 2026913f273cc2f71See the full diff
- ●
  added the new ContractNotFound enum value to the code response property for the response status 404
  response-property-enum-value-added
Jul 23, 2026b876edd1a4fc5See the full diff
- ●
  added the new CreditOveragePriceCurrencyNotFound enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new InvalidCreditOverageBillingModel enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new OveragePriceNotSupportedOnAddon enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new OveragePriceRequiresUsageLimit enum value to the code response property for the response status 400
  response-property-enum-value-added
Jul 8, 202658bb216ff8ce1See the full diff
- ●
  added the new GovernanceNotEnabled enum value to the code response property for the response status 403
  response-property-enum-value-added
Jun 8, 20263acd63d6c8612See the full diff
- ○
  added the new optional header request parameter X-ACCOUNT-ID
  new-optional-request-parameter
- ○
  added the new optional header request parameter X-ENVIRONMENT-ID
  new-optional-request-parameter
Jun 4, 20264fa87d66426d1See the full diff
- ●
  added the new PricingModelNotSupportedByBillingIntegration enum value to the code response property for the response status 400
  response-property-enum-value-added
Jun 2, 2026ff3654f420a44See the full diff
- ○
  added the new optional query request parameter after
  new-optional-request-parameter
- ○
  added the new optional query request parameter before
  new-optional-request-parameter
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the required property data/pagination to the response with the 200 status
  response-required-property-added
May 31, 20260dece860f6781See the full diff
- ●
  added the new DataExportIntegrationError enum value to the code response property for the response status 400
  response-property-enum-value-added
May 28, 2026b181b166a2a51See the full diff
- ●
  added the new InvalidReceivedSignatureError enum value to the code response property for the response status 400
  response-property-enum-value-added
May 26, 202697c0c1bef62122See the full diff
- ▲
  the response property data/series/items/featureId became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/series/items/featureName became nullable for the status 200
  response-property-became-nullable
- ○
  added the new optional query request parameter groupBy
  new-optional-request-parameter
- ○
  added the optional property data/series/items/tags to the response with the 200 status
  response-optional-property-added

Full history