Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Setup Intents

Create Setup Intent

Creates a SetupIntent to collect a customer's payment method details for future off-session use.

A new SetupIntent is created on each call and starts in the requires_payment_method status; it is not an upsert. The response includes a client_secret that you use to confirm the SetupIntent and attach a payment method from your frontend.

post/v1/setup_intents

Request body

Example request

{
  "setup_intent": {
    "partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "checkout_session": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
  }
}

Response

An envelope wrapping a single setup intent object.

Example response

{
  "setup_intent": {
    "setup_intent_id": "fseti_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"
  }
}