List saved credit cards - Spree Commerce documentation

GET

api

store

customers

credit_cards

Spree SDK

import { createClient } from '@spree/sdk'

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

const cards = await client.customer.creditCards.list({}, {
  token: '<token>',
})

{
  "data": [
    {
      "id": "card_UkLWZg9DAJ",
      "brand": "visa",
      "last4": "1111",
      "month": 12,
      "year": 2027,
      "name": "Spree Commerce",
      "default": false,
      "gateway_payment_profile_id": null
    }
  ],
  "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., name,slug,price). id is always included.

Response

credit cards found

data

object[]

Show child attributes

meta

object

Show child attributes

Update an address

Get a credit card

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

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

const cards = await client.customer.creditCards.list({}, {
  token: '<token>',
})

{
  "data": [
    {
      "id": "card_UkLWZg9DAJ",
      "brand": "visa",
      "last4": "1111",
      "month": 12,
      "year": 2027,
      "name": "Spree Commerce",
      "default": false,
      "gateway_payment_profile_id": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}