List customer store credits

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: storeCredits } = await client.customers.storeCredits.list('cus_UkLWZg9DAJ')

{
  "data": [
    {
      "id": "credit_UkLWZg9DAJ",
      "amount": "50.00",
      "amount_used": "0.00",
      "amount_remaining": "50.00",
      "currency": "USD",
      "memo": null,
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "amount_authorized": "0.00",
      "outstanding": true,
      "customer_id": "cust_UkLWZg9DAJ",
      "created_by_id": "adm_UkLWZg9DAJ",
      "created_by_type": "admin_user",
      "originator_type": null,
      "originator_id": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

admin

customers

{customer_id}

store_credits

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: storeCredits } = await client.customers.storeCredits.list('cus_UkLWZg9DAJ')

{
  "data": [
    {
      "id": "credit_UkLWZg9DAJ",
      "amount": "50.00",
      "amount_used": "0.00",
      "amount_remaining": "50.00",
      "currency": "USD",
      "memo": null,
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "amount_authorized": "0.00",
      "outstanding": true,
      "customer_id": "cust_UkLWZg9DAJ",
      "created_by_id": "adm_UkLWZg9DAJ",
      "created_by_type": "admin_user",
      "originator_type": null,
      "originator_id": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[memo_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`amount`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`created_by_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`currency`	One of the `CurrencyCode` codes	`eq` `not_eq` `in` `not_in` `null` `not_null`
`customer_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`memo`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Filters through associations

Prefix an associated record’s attribute with the association, as in q[customer_id_eq]. The same predicates apply.

Prefix	Attributes
`customer_`	`accepts_email_marketing`, `created_at`, `email`, `first_name`, `id`, `last_name`, `phone`, `updated_at`
`customer_addresses_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customer_bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customer_customer_groups_`	`created_at`, `id`, `name`, `updated_at`
`customer_orders_`	`channel_id`, `completed_at`, `considered_risky`, `coupon_code`, `created_at`, `currency`, `customer_id`, `delivery_total`, `email`, `fulfillment_status`, `id`, `item_total`, `locale`, `market_id`, `number`, `order_group_id`, `payment_status`, `po_number`, `seller_id`, `status`, `total`, `total_quantity`, `updated_at`
`customer_ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customer_spree_roles_`	`created_at`, `id`, `name`, `updated_at`
`customer_tags_`	`created_at`, `id`, `name`, `updated_at`

Sort by: amount, created_at, created_by_id, currency, customer_id, id, memo, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Path Parameters

customer_id

string

required

Query Parameters

q[search]

string

Matches any of memo (partial, case-insensitive).

q[from_gift_card]

boolean

Set to true to apply from_gift_card.

q[outstanding]

boolean

Set to true to apply outstanding.

expand

string

Comma-separated associations to expand (e.g., store, created_by). Use dot notation for nested expand (max 4 levels).

fields

string

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

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

200 - application/json

store credits found

⌘I

API basics

Endpoints

Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters