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

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

const credit = await client.customer.storeCredits.get('credit_abc123', {
  bearerToken: '<token>',
})
{
  "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"
}

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

Path Parameters

id
string
required

Query Parameters

fields
string

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

Response

store credit found

id
string
required
amount
string
required
amount_used
string
required
amount_remaining
string
required
display_amount
string
required
display_amount_used
string
required
display_amount_remaining
string
required
currency
string
required