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

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

const session = await client.store.orders.paymentSessions.update('or_abc123', 'ps_abc123', {
  amount: '50.00',
}, {
  bearerToken: '<token>',
})
{
  "id": "ps_UkLWZg9DAJ",
  "status": "pending",
  "currency": "USD",
  "external_id": "bogus_edd71b5019fcb41dd05fe015",
  "external_data": {
    "client_secret": "secret_123"
  },
  "customer_external_id": null,
  "expires_at": null,
  "created_at": "2026-03-05T20:52:28.611Z",
  "updated_at": "2026-03-05T20:52:28.625Z",
  "amount": "50.0",
  "payment_method_id": "pm_UkLWZg9DAJ",
  "order_id": "or_UkLWZg9DAJ",
  "payment_method": {
    "id": "pm_UkLWZg9DAJ",
    "name": "Credit Card",
    "description": null,
    "type": "Spree::Gateway::Bogus",
    "session_required": true
  }
}

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

Bearer token for authenticated customers

​
x-spree-order-token
string

Order token for guest access

Path Parameters

​
order_id
string
required

Order ID or number

​
id
string
required

Payment session ID

Body

application/json
​
amount
string

Updated payment amount

Example:

"50.00"

​
external_data
object

Provider-specific data to update

Response

200 - application/json

payment session updated

​
id
string
required
​
status
string
required
​
currency
string
required
​
external_id
string
required
​
external_data
object
required
​
customer_external_id
string | null
required
​
expires_at
string | null
required
​
created_at
string
required
​
updated_at
string
required
​
amount
string
required
​
payment_method_id
string
required
​
order_id
string
required
​
payment_method
object
required
​
payment
object