v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Store Credits

Store Credit balance of a customer

Returns a balance for the given customer id.

🔒 Requires: store_credits:read scope

get/store_credits/{customerId}/balance

Path parameters

customerIdstring uuid required

Customer id

Response

The store credit details for the given customer.

balancenumber double

The customers store credit balance.

customer_idstring

The customers public id.

total_credit_issuednumber double

Total amount of store credit issued to this customer.

total_credit_redeemednumber double

Total amount of store credit spent by this customer.