Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Store Credits

Store Credit operations and a balance of a customer

Returns a balance and a history of store credit operations for the given customer id.

🔒 Requires: store_credits:read scope

get/store_credits/{customerId}

Path parameters

customerIdstring uuid required

Customer id

Response

The store credit details for the given customer.

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"
    }
  ]
}