HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Get store credit usage for the store

Lists the retailer's store-credit customers, balances and transactions. Customer details can be included in the response.

🔒 Requires: store_credits:read scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1000

The maximum number of items to be returned in the response

integer
≥ 0
Defaults to 0

Number of store-credit customer records to skip.

includes[]
array of strings

Repeat this query key to request supplementary customer metadata. Other values are ignored.

includes[]
Allowed:
Responses

400

page_size is not a positive integer or offset is not a nonnegative integer.

403

Access is forbidden.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json