Search charges

Search for charges you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

get/v1/charges/search

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

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

pagestring

A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

querystring required

The search query string. See search query language and the list of supported query fields for charges.

Response

Successful response.

has_moreboolean required
next_pagestring nullable
object'search_result' required

String representing the object's type. Objects of the same type share the same value.

total_countinteger

The total number of objects that match the query, only accurate up to 10,000.

urlstring required

Changes

Changed in 16 of the 51 revisions of this API.297673

    • removed the required property data/items/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/acss_debit/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/au_becs_debit/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/bacs_debit/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/nz_bank_account/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/sepa_debit/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/us_bank_account/expected_debit_date to the response with the 200 status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/acss_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/au_becs_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/bacs_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/nz_bank_account/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/sepa_debit/expected_debit_date to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/us_bank_account/expected_debit_date to the response with the default status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status

      response-optional-property-added

    • removed the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/paypay from the response with the 200 status

      response-optional-property-removed

    • removed the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypay from the response with the default status

      response-optional-property-removed

    • removed the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/paypay from the response with the default status

      response-optional-property-removed

    • added the new prevented enum value to the data/items/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status 200

      response-property-enum-value-added

    • added the new prevented enum value to the data/items/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status 200

      response-property-enum-value-added

    • added the new prevented enum value to the data/items/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status 200

      response-property-enum-value-added

    • added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

    • added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

    • added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the 200 status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the default status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the 200 status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the default status

      response-optional-property-added

    • added the optional property data/items/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/refunds/data/items/destination_details/paypal/network_decline_code to the response with the 200 status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/refunds/data/items/destination_details/paypal/network_decline_code to the response with the default status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added the optional property data/items/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/location to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/reader to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/location to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/reader to the response with the 200 status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/balance_type to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/location to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/affirm/reader to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/location to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/wechat_pay/reader to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/billie/anyOf[subschema #1: payment_method_options_billie]/capture_method to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/satispay to the response with the default status

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added the new stripe_balance_payment_debit enum value to the data/items/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit enum value to the data/items/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit enum value to the data/items/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the data/items/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the data/items/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the data/items/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status 200

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    • added the new stripe_balance_payment_debit_reversal enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/type response property for the response status default

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.