Skip to main content
GET
/
api
/
v3
/
store
/
customer
/
credit_cards
Spree SDK
import { createSpreeClient } from '@spree/sdk'

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

const cards = await client.store.customer.creditCards.list({}, {
  bearerToken: '<token>',
})
{
  "data": [
    {
      "id": "card_UkLWZg9DAJ",
      "cc_type": "visa",
      "last_digits": "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

Response

credit cards found

data
object[]
meta
object