Returns a payment setup session with its current status and provider data.
JavaScript
import { createClient } from '@spree/sdk' const client = createClient({ baseUrl: 'https://your-store.com', publishableKey: '<api-key>', }) const session = await client.customer.paymentSetupSessions.get('pss_abc123', { bearerToken: '<token>', })
{ "id": "pss_UkLWZg9DAJ", "status": "pending", "external_id": "seti_test_8f5449c51058d217b826df7c", "external_client_secret": "seti_secret_883bafc0d7c8fb731626611c", "external_data": { "client_secret": "secret_123" }, "created_at": "2026-03-28T11:44:51.144Z", "updated_at": "2026-03-28T11:44:51.144Z", "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 } }
Publishable API key for store access
JWT token for authenticated customers
Payment setup session ID
payment setup session found
Show child attributes
Was this page helpful?