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

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

const methods = await client.store.orders.paymentMethods.list('or_abc123', {
  bearerToken: '<token>',
})
{
  "data": [
    {
      "id": "pm_UkLWZg9DAJ",
      "name": "Credit Card",
      "description": null,
      "type": "Spree::Gateway::Bogus",
      "session_required": true
    }
  ],
  "meta": {
    "count": 1
  }
}

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
x-spree-order-token
string

Path Parameters

order_id
string
required

Response

payment methods found

data
object[]
meta
object