Skip to main content
GET
/
v1
/
setup_intents
/
{id}
Get Setup Intent
curl --request GET \
  --url https://api.withflex.com/v1/setup_intents/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.withflex.com/v1/setup_intents/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.withflex.com/v1/setup_intents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withflex.com/v1/setup_intents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.withflex.com/v1/setup_intents/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.withflex.com/v1/setup_intents/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.withflex.com/v1/setup_intents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
{
"code": "string",
"detail": "string"
}

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

Success

SetupIntent response with expandable subscription (for GET endpoint)

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:
{ "order_id": "8842", "channel": "shopify" }
subscription_id
string | null

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

Example:

"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"