Skip to main content
GET
Get Setup Intent

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

id
string
required
Example:

"fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Query Parameters

expand
string
default:""

Comma-separated list of fields to expand (e.g., "subscription").

Example:

""

Response

SetupIntent response with expandable subscription

SetupIntent response with expandable subscription

setup_intent_id
string
required

The unique identifier for the object.

Example:

"fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

partner_id
string
required

The ID of the account this SetupIntent belongs to.

Example:

"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

created_at
string
required

Time at which the object was created. ISO 8601 format.

Example:

"2026-06-15T14:30:00Z"

test_mode
boolean
required

Whether or not the setup intent is in test mode.

Example:

false

status
enum<string>
required

The current status of the setup intent.

Available options:
requires_payment_method,
requires_confirmation,
requires_action,
processing,
succeeded,
canceled
Example:

"requires_payment_method"

usage
enum<string>
required

Indicates how the payment method is intended to be used in the future.

Available options:
off_session,
on_session
Example:

"off_session"

subscription

The subscription this SetupIntent is associated with (expandable).

Example:

"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

client_secret
string | null

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.

customer

The Customer this SetupIntent belongs to; returned as the ID by default and expandable to the full object.

Example:

"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

description
string | null

An arbitrary string attached to the setup intent.

Example:

"Premium SPF 50 mineral sunscreen"

payment_method
string | null

Payment method used with this SetupIntent.

Example:

"fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

metadata
object | null

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.

Example:
subscription_id
string | null

The ID of the Subscription this SetupIntent is associated with (for payment method updates).

Example:

"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"