Sign in
Credit ledger

Get a list of credit ledger events

Retrieves a paginated list of credit ledger events for a customer.

get/api/v1/credits/ledger

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

eventTypestring

Filter by event type(s), comma-separated

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

A paginated list of credit ledger event objects.

Changes

Changed in 7 of the 115 revisions of this API.93

  • b876edd1a4fc5See the full diff
    • ●

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status

      response-property-enum-value-added

  • a6ff4a5b1f7f1See the full diff
    • ○

      added the new optional query request parameter eventType

      new-optional-request-parameter

  • 58bb216ff8ce1See the full diff
    • ●

      added the new GovernanceNotEnabled enum value to the response property for the response status

      response-property-enum-value-added

  • 3acd63d6c8612See 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

  • 4fa87d66426d1See the full diff
    • ●

      added the new PricingModelNotSupportedByBillingIntegration enum value to the response property for the response status

      response-property-enum-value-added

  • 0dece860f6781See the full diff
    • ●

      added the new DataExportIntegrationError enum value to the response property for the response status

      response-property-enum-value-added

  • b181b166a2a51See the full diff
    • ●

      added the new InvalidReceivedSignatureError enum value to the response property for the response status

      response-property-enum-value-added