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

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

const giftCard = await client.customer.giftCards.get('gc_abc123', {
  token: '<token>',
})
curl --request GET \
  --url http://{defaultHost}/api/v3/store/customers/me/gift_cards/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-spree-api-key: <api-key>'
{
  "id": "gc_UkLWZg9DAJ",
  "code": "81861537648F20C3",
  "status": "active",
  "currency": "USD",
  "amount": "10.0",
  "amount_used": "0.0",
  "amount_authorized": "0.0",
  "amount_remaining": "10.0",
  "display_amount": "$10.00",
  "display_amount_used": "$0.00",
  "display_amount_remaining": "$10.00",
  "expires_at": null,
  "redeemed_at": null,
  "expired": false,
  "active": true
}
{
  "error": {
    "code": "record_not_found",
    "message": "Gift card not found"
  }
}

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., name,slug,price). id is always included.

Response

gift card found

​
id
string
required
​
code
string
required
​
status
string
required
​
currency
string
required
​
amount
string | null
required
​
amount_used
string | null
required
​
amount_authorized
string | null
required
​
amount_remaining
string | null
required
​
display_amount
string | null
required
​
display_amount_used
string | null
required
​
display_amount_remaining
string | null
required
​
expires_at
string | null
required
​
redeemed_at
string | null
required
​
expired
boolean
required
​
active
boolean
required