Skip to main content
GET
List Setup Intents

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:

3

customer
string | null

Filter by customer ID.

Example:

"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

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:

"fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

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:

"fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

expand
string
default:""

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

Example:

""

Response

An envelope wrapping a list of setup intent objects.

An envelope wrapping a list of setup intent objects.

setup_intents
object[]
required

A list of SetupIntents.