Skip to main content
GET
/
api
/
v3
/
store
/
customers
/
me
/
store_credits
Spree SDK
import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const credits = await client.customer.storeCredits.list({}, {
  token: '<token>',
})
{
  "data": [
    {
      "id": "credit_UkLWZg9DAJ",
      "amount": "100.0",
      "amount_used": "0.0",
      "amount_remaining": "100.0",
      "display_amount": "$100.00",
      "display_amount_used": "$0.00",
      "display_amount_remaining": "$100.00",
      "currency": "USD"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Authorizations

​
x-spree-api-key
string
header
required

Publishable API key for store access

​
Authorization
string
header
required

JWT token for authenticated customers

Headers

​
x-spree-api-key
string
required
​
Authorization
string
required

Query Parameters

​
page
integer
​
limit
integer
​
fields
string

Comma-separated list of fields to include (e.g., amount,currency). id is always included.

Response

store credits found

​
data
object[]
​
meta
object