Skip to main content
POST
/
api
/
v3
/
store
/
customer
/
payment_setup_sessions
Spree SDK
import { createSpreeClient } from '@spree/sdk'

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

const session = await client.store.customer.paymentSetupSessions.create({
  payment_method_id: 'pm_abc123',
}, {
  bearerToken: '<token>',
})
{
  "id": "pss_gbHJdmfrXB",
  "status": "pending",
  "external_id": "bogus_seti_e0ac17ce639983d8d155b11d",
  "external_client_secret": "bogus_seti_secret_b5ed82606bfa5145",
  "external_data": {},
  "created_at": "2026-03-04T21:02:33.230Z",
  "updated_at": "2026-03-04T21:02:33.230Z",
  "payment_method_id": "pm_UkLWZg9DAJ",
  "payment_source_id": null,
  "payment_source_type": null,
  "customer_id": "cus_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
required

Body

application/json
​
payment_method_id
string
required

Payment method ID

Example:

"pm_abc123"

​
external_data
object

Provider-specific data passed to the gateway

Response

payment setup session created

​
id
string
required
​
status
string
required
​
external_id
string | null
required
​
external_client_secret
string | null
required
​
external_data
object
required
​
created_at
string
required
​
updated_at
string
required
​
payment_method_id
string | null
required
​
payment_source_id
string | null
required
​
payment_source_type
string | null
required
​
customer_id
string | null
required
​
payment_method
object
required