Skip to main content
GET
Spree SDK

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

Path Parameters

id
string
required

Payment setup session ID

Response

payment setup session found

id
string
required
status
required

The values listed are the built-in ones; extensions may add more.

Available options:
pending,
processing,
completed,
failed,
canceled,
expired
external_id
string | null
required
external_client_secret
string | null
required
external_data
object
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