WIwithflex
Payment Intents

List Payment Intents

Changed on

Returns a list of payment intents

get/v1/payment_intents

Request

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

Query parameters

expandstring

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

expand_customerboolean nullable

If true, expands the customer object in the response.

customerstring nullable

Filter by customer ID.

Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA
checkout_sessionstring nullable

Filter by checkout session ID.

Example:fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA
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
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
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

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,
      "application_fee_amount": 0,
      "customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "transfer_data": {
        "amount": 2500,
        "destination": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
      },
      "status": "canceled",
      "latest_charge": "fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "created_at": "2026-06-15T14:30:00Z",
      "invoice": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "capture_method": "automatic",
      "client_secret": "string",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "payment_method": "fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "test_mode": false,
      "transfer_group": "example_value",
      "payment_card_type": "primary",
      "letter_fee_amount": 0,
      "transaction_fee": 0,
      "last_payment_error": {
        "type": "string",
        "code": "string",
        "decline_code": "string",
        "message": "string",
        "payment_method": "fpm_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
      }
    }
  ]
}

Changes

  • eec642897a22Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • 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

    • warning

      added the new adaptiveShoesDependent enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new adaptiveShoesDependent enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new automatedCleaner enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new automatedCleaner enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new babyMonitorSplit enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new babyMonitorSplit enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new babySleepApp enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new babySleepApp enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new bodyPillow enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new bodyPillow enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new breathWorkDependent enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new breathWorkDependent enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new coolingSleepwear enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new coolingSleepwear enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new meneralsNootropicPouch enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new meneralsNootropicPouch enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new nonenalOdor enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new nonenalOdor enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new nursingChairs enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new nursingChairs enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new speechHealthDependent enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new speechHealthDependent enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new uvClothing enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new uvClothing enum value to the ///////////////////////////////////////////// response property for the response status

    • warning

      added the new uvGlasses enum value to the //////////////////////////////////// response property for the response status

    • warning

      added the new uvGlasses enum value to the ///////////////////////////////////////////// response property for the response status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property /////////////////////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property ///////////////////////////// to the response with the status

    • info

      added the optional property //////////////////////////////////// to the response with the status

    • info

      added the optional property ///////////////////////////// to the response with the status