Get a credit card - Spree Commerce documentation

GET

api

store

customers

credit_cards

{id}

Spree SDK

import { createClient } from '@spree/sdk'

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

const card = await client.customer.creditCards.get('card_abc123', {
  token: '<token>',
})

{
  "id": "card_UkLWZg9DAJ",
  "brand": "visa",
  "last4": "1111",
  "month": 12,
  "year": 2027,
  "name": "Spree Commerce",
  "default": false,
  "gateway_payment_profile_id": 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

Path Parameters

string

required

Query Parameters

fields

string

Comma-separated list of fields to include (e.g., name,slug,price). id is always included.

Response

credit card found

string

required

brand

string

required

last4

string

required

month

number

required

year

number

required

name

string | null

required

default

boolean

required

gateway_payment_profile_id

string | null

required

List saved credit cards

Delete a credit card

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

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

const card = await client.customer.creditCards.get('card_abc123', {
  token: '<token>',
})

{
  "id": "card_UkLWZg9DAJ",
  "brand": "visa",
  "last4": "1111",
  "month": 12,
  "year": 2027,
  "name": "Spree Commerce",
  "default": false,
  "gateway_payment_profile_id": null
}