Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Payment Intents

List Payment Intents

Returns a list of payment intents

get/v1/payment_intents

Query parameters

expandstring

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

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

expand_customerboolean nullable

If true, expands the customer object in the response.

If true, expands the customer object in the response.

customerstring nullable

Filter by customer ID.

Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by customer ID.

checkout_sessionstring nullable

Filter by checkout session ID.

Example:fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by checkout session ID.

starting_afterstring nullable

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

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.

ending_beforestring nullable

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

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.

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

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

offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Number of objects to skip before returning results.

Response

An envelope wrapping a list of payment intent objects.

Example response

{
  "payment_intents": [
    {
      "payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "amount": 2500,
      "amount_capturable": 2500,
      "amount_received": 2500,
      "status": "canceled",
      "created_at": "2026-06-15T14:30:00Z",
      "capture_method": "automatic",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "test_mode": false,
      "transfer_group": "example_value"
    }
  ]
}