Charges
get/v1/charges/search

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.

Query parameters

NameDescription
expandSpecifies which fields in the response should be expanded.
limitA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
pageA 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.
query*The search query string. See search query language and the list of supported query fields for charges.

Request body

object (no properties in spec)

Response

FieldTypeDescription
data*array<charge>
array item fields
FieldTypeDescription
amount*integer

Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

amount_captured*integer

Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).

amount_refunded*integer

Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).

applicationstring | application

ID of the Connect application that created the charge.

application_feestring | application_fee

The application fee (if any) for the charge. See the Connect documentation for details.

application_fee_amountinteger

The amount of the application fee (if any) requested for the charge. See the Connect documentation for details.

balance_transactionstring | balance_transaction

ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).

billing_details*billing_details
5 nested fields
FieldTypeDescription
addressaddress

Billing address.

emailstring

Email address.

namestring

Full name.

phonestring

Billing phone number (including extension).

tax_idstring

Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

calculated_statement_descriptorstring

The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.

captured*boolean

If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.

created*integer (unix-time)

Time at which the object was created. Measured in seconds since the Unix epoch.

currency*string (currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customerstring | customer | deleted_customer

ID of the customer this charge is for if one exists.

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

disputed*boolean

Whether the charge has been disputed.

failure_balance_transactionstring | balance_transaction

ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.

failure_codestring

Error code explaining reason for charge failure if available (see the errors section for a list of codes).

failure_messagestring

Message to user further explaining reason for charge failure if available.

fraud_detailscharge_fraud_details

Information on fraud assessments for the charge.

id*string

Unique identifier for the object.

livemode*boolean

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadata*object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object*string

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

on_behalf_ofstring | account

The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.

outcomecharge_outcome

Details about whether the payment was accepted, and why. See understanding declines for details.

paid*boolean

true if the charge succeeded, or was successfully authorized for later capture.

payment_intentstring | payment_intent

ID of the PaymentIntent associated with this charge, if one exists.

payment_methodstring

ID of the payment method used in this charge.

payment_method_detailspayment_method_details

Details about the payment method at the time of the transaction.

presentment_detailspayment_flows_payment_intent_presentment_details
2 nested fields
FieldTypeDescription
presentment_amount*integer

Amount intended to be collected by this payment, denominated in presentment_currency.

presentment_currency*string

Currency presented to the customer during payment.

has_more*boolean
next_pagestring
object*string

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.

url*string