Get Setup Intent
Retrieves the details of an existing SetupIntent.
The response includes a fresh client_secret for confirming the SetupIntent from
your frontend. Pass expand=subscription to inline the associated Subscription, when one exists.
Authorizations
Use a Bearer token to access this API.
Path Parameters
"fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Query Parameters
Comma-separated list of fields to expand (e.g., "subscription").
""
Response
Success
SetupIntent response with expandable subscription (for GET endpoint)
The unique identifier for the object.
"fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
The ID of the account this SetupIntent belongs to.
"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Time at which the object was created. ISO 8601 format.
"2026-06-15T14:30:00Z"
Whether or not the setup intent is in test mode.
false
The current status of the setup intent.
requires_payment_method, requires_confirmation, requires_action, processing, succeeded, canceled "requires_payment_method"
Indicates how the payment method is intended to be used in the future.
off_session, on_session "off_session"
The subscription this SetupIntent is associated with (expandable).
"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
The client secret used to confirm this SetupIntent from your frontend. Present when the SetupIntent is retrieved or created; null when it appears in a list response. Treat it as sensitive: do not log or store it, and expose it only to the customer over TLS.
The Customer this SetupIntent belongs to; returned as the ID by default and expandable to the full object.
"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
An arbitrary string attached to the setup intent.
"Premium SPF 50 mineral sunscreen"
Payment method used with this SetupIntent.
"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
{ "order_id": "8842", "channel": "shopify" }The ID of the Subscription this SetupIntent is associated with (for payment method updates).
"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"