WIwithflex
Setup Intents

List Setup Intents

Changed on

Returns a list of SetupIntents, sorted by ID in descending order (most recent first).

The client_secret is not included on listed SetupIntents; retrieve a SetupIntent individually to obtain it.

get/v1/setup_intents

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/setup_intents
  • Auth
    HTTP bearer

Query parameters

limitinteger nullable

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

Example:10
offsetinteger nullable

Number of objects to skip before returning results.

Example:3
customerstring nullable

Filter by customer ID.

Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA
starting_afterstring nullable

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:fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA
ending_beforestring nullable

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:fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA
expandstring

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

Response

An envelope wrapping a list of setup intent objects.

Example response

{
  "setup_intents": [
    {
      "setup_intent_id": "fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "client_secret": "string",
      "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"
    }
  ]
}

Changes

  • eec642897a22Revision changes
    • breaking

      the /////////// response's property format changed from email to no format for status

    • warning

      for the query request parameter limit, the max was set to 2147483647.00

    • warning

      for the query request parameter offset, the max was set to 2147483647.00

    • warning

      for the query request parameter limit, the min was set to -2147483648.00

    • warning

      for the query request parameter offset, the min was set to -2147483648.00