STstiggio
Credit ledger

Get a list of credit ledger events

Changed on

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

get/api/v1/credits/ledger

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/credits/ledger
  • Auth
    API key in header X-API-KEY

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

  • b876edd1a4fcRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • a6ff4a5b1f7fRevision changes
    • info

      added the new optional query request parameter eventType