Skip to main content
PATCH
/
api
/
v3
/
admin
/
gift_cards
/
{id}
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

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

const giftCard = await client.giftCards.update('gc_K3zr8x', {
  amount: '75.00',
})
{
  "id": "gc_UkLWZg9DAJ",
  "code": "80360376B43E9B35",
  "status": "active",
  "currency": "USD",
  "amount": "75.0",
  "amount_used": "0.0",
  "amount_authorized": "0.0",
  "amount_remaining": "75.0",
  "display_amount": "$75.00",
  "display_amount_used": "$0.00",
  "display_amount_remaining": "$75.00",
  "expires_at": null,
  "redeemed_at": null,
  "expired": false,
  "active": true,
  "created_at": "2026-05-24T17:37:00.647Z",
  "updated_at": "2026-05-24T17:37:00.941Z",
  "customer_id": null,
  "created_by_id": null
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

id
string
required

Gift card prefixed ID

Body

application/json
amount
string
Example:

"75.00"

expires_at
string | null
Example:

"2031-12-31"

user_id
string | null
Example:

"cus_UkLWZg9DAJ"

Response

200 - application/json

gift card updated

id
string
required
code
string
required
status
string
required
currency
string
required
amount
string
required
amount_used
string
required
amount_authorized
string
required
amount_remaining
string
required
display_amount
string
required
display_amount_used
string
required
display_amount_remaining
string
required
expires_at
string | null
required
redeemed_at
string | null
required
expired
boolean
required
active
boolean
required
created_at
string
required
updated_at
string
required
customer_id
string | null
required
created_by_id
string | null
required
customer
object
created_by
object
gift_card_batch
object
orders
object[]