Skip to main content
GET
/
v1
/
setup_intents
List Setup Intents
curl --request GET \
  --url https://api.withflex.com/v1/setup_intents \
  --header 'Authorization: Bearer <token>'
{
  "setup_intents": [
    {
      "setup_intent_id": "obj_01EXAMPLE00000000000000000",
      "client_secret": "string",
      "description": "string",
      "payment_method": "string",
      "partner_id": "obj_01EXAMPLE00000000000000000",
      "metadata": {},
      "created_at": "2024-01-01T00:00:00Z",
      "test_mode": false,
      "status": "requires_payment_method",
      "usage": "off_session",
      "subscription_id": "obj_01EXAMPLE00000000000000000"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.withflex.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
limit
integer<int32> | null

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:

10

​
offset
integer<int32> | null

Number of objects to skip before returning results.

Example:

0

​
customer
string | null

Filter by customer ID.

Example:

"obj_01EXAMPLE00000000000000000"

​
starting_after
string | null

A cursor for use in pagination. starting_after is a setup intent ID that defines your place in the list. For instance, if you make a list request and receive 20 setup intents, ending with fsi_xyz, your subsequent call can include starting_after=fsi_xyz to fetch the next page.

Example:

"obj_01EXAMPLE00000000000000000"

​
ending_before
string | null

A cursor for use in pagination. ending_before is a setup intent ID that defines your place in the list. For instance, if you make a list request and receive 20 setup intents, starting with fsi_abc, your subsequent call can include ending_before=fsi_abc to fetch the previous page.

Example:

"obj_01EXAMPLE00000000000000000"

​
expand
string
default:""

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

Example:

""

Response

Success

​
setup_intents
object[]
required