Skip to main content

Fetch customer credit balance by external customer id​

Returns a paginated list of unexpired, non-zero credit blocks for a customer.

Note that currency defaults to credits if not specified. To use a real world currency, set currency to an ISO 4217 string.

Path Parameters
    external_customer_id string required
Query Parameters
    limit integer

    Possible values: >= 1 and <= 1000

    Default value: 20

    cursor string
    currency string
    include_all_blocks boolean
Responses

OK

Response Headers
    Schema
      data object[] required
    • Array [
      • id string required
      balance number required
      effective_date date-time nullable required
      expiry_date date-time nullable required
      per_unit_cost_basis string nullable required
      status string required

      Possible values: [active, pending_payment]

      maximum_initial_balance number nullable required
    • ]
      • pagination_metadata object required
      has_more boolean required
      next_cursor string nullable required
    Loading...