Skip to main content
GET
List Payment Intents

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

expand
string
default:""

Comma-separated list of related objects to expand in the response.

Example:

""

expand_customer
boolean | null

If true, expands the customer object in the response.

Example:

false

customer
string | null

Filter by customer ID.

Example:

"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

checkout_session
string | null

Filter by checkout session ID.

Example:

"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

starting_after
string | null

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

Example:

"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

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

Example:

"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

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

Response

An envelope wrapping a list of payment intent objects.

An envelope wrapping a list of payment intent objects.

payment_intents
object[]
required

The list of payment intents.