Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Setup Intents

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.

get/v1/setup_intents/{id}

Path parameters

idstring required
Example:fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Query parameters

expandstring

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

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

Response

SetupIntent response with expandable subscription

setup_intent_idstring required

The unique identifier for the object.

client_secretstring nullable

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.

descriptionstring nullable

An arbitrary string attached to the setup intent.

payment_methodstring nullable

Payment method used with this SetupIntent.

partner_idstring required

The ID of the account this SetupIntent belongs to.

metadataobject nullable

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.

created_atstring required

A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. 2026-06-15T14:30:00Z).

test_modeboolean required

Whether or not the setup intent is in test mode.

status'requires_payment_method' | 'requires_confirmation' | 'requires_action' | 'processing' | 'succeeded' | 'canceled' required

The status of the setup intent.

usage'off_session' | 'on_session' required

Whether the saved payment method is intended for off-session or on-session future payments.

subscription_idstring nullable

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

Example response

{
  "subscription": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
  "setup_intent_id": "fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
  "customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
  "description": "Premium SPF 50 mineral sunscreen",
  "payment_method": "fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
  "partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
  "metadata": {
    "order_id": "8842",
    "channel": "shopify"
  },
  "created_at": "2026-06-15T14:30:00Z",
  "test_mode": false,
  "status": "requires_payment_method",
  "usage": "off_session",
  "subscription_id": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
}