Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Store Credits

Get store credit usage for the store

Returns all the store credit customers in a store with their store credit balance and a list of last store credit transactions for each customer

🔒 Requires: store_credits:read scope

get/store_credits

Query parameters

page_sizeinteger

The maximum number of items to be returned in the response

includes[]string

Include supplementary data. The only valid value for includes[] is 'customer'.

Response

The list of store credit customers.

balancenumber double required

The customers store credit balance.

created_atstring

Creation timestamp in UTC.

customer_idstring uuid required

The customer id.

idstring string

Store Credit Customer's internal ID.

total_credit_issuednumber double required

Total amount of store credit issued to this customer.

total_credit_redeemednumber double required

Total amount of store credit spent by this customer.

Example response

[
  {
    "store_credit_transactions": [
      {
        "created_at": "2026-01-02T15:04:05Z"
      }
    ]
  }
]