Get a store credit category - Spree Commerce documentation

GET

api

admin

store_credit_categories

{id}

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

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

const category = await client.storeCreditCategories.get('sccat_UkLWZg9DAJ')

{
  "id": "sccat_UkLWZg9DAJ",
  "name": "Goodwill",
  "created_at": "2026-06-01T13:02:02.232Z",
  "updated_at": "2026-06-01T13:02:02.232Z",
  "non_expiring": false
}

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

Bearer token for admin authentication

Path Parameters

string

required

Store credit category ID

Query Parameters

fields

string

Comma-separated list of fields to include. id is always included.

Response

store credit category found

string

required

name

string

required

created_at

string

required

updated_at

string

required

non_expiring

boolean

required

List store credit categories

Get the current store

⌘I

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

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

const category = await client.storeCreditCategories.get('sccat_UkLWZg9DAJ')

{
  "id": "sccat_UkLWZg9DAJ",
  "name": "Goodwill",
  "created_at": "2026-06-01T13:02:02.232Z",
  "updated_at": "2026-06-01T13:02:02.232Z",
  "non_expiring": false
}