Update a charge
Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- customerstring
The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
- descriptionstring
An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the
descriptionof the charge(s) that they are describing. - metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata. - receipt_
emailstring This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
- shippingobject
Shipping information for the charge. Helps prevent fraud on charges for physical goods.
More parameters
- fraud_
detailsobject - transfer_
groupstringConnect only
Returns
Returns the charge object if the update succeeded. This call will raise an error if update parameters are invalid.
Retrieve a charge
Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.
Parameters
No parameters.
Returns
Returns a charge if a valid identifier was provided, and raises an error otherwise.
List all charges
Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.
Parameters
- customerstring
Only return charges for the customer specified by this customer ID.
More parameters
- createdobject
- ending_
beforestring - limitinteger
- payment_
intentstring - starting_
afterstring - transfer_
groupstringConnect only
Returns
A dictionary with a data property that contains an array of up to limit charges, starting after charge starting_after. Each entry in the array is a separate charge object. If no more charges are available, the resulting array will be empty. If you provide a non-existent customer ID, this call raises an error.
Capture a charge
Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.
Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.
Parameters
- amountinteger
The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.
- receipt_
emailstring The email address to send this charge’s receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
- statement_
descriptorstring For card charges, use
statement_descriptor_suffixinstead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. - statement_
descriptor_ suffixstring Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
More parameters
- application_
fee_ amountintegerConnect only - transfer_
dataobjectConnect only - transfer_
groupstringConnect only
Returns
Returns the charge object, with an updated captured property (set to true). Capturing a charge will always succeed, unless the charge is already refunded, expired, captured, or an invalid capture amount is specified, in which case this method will raise an error.
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.
Parameters
- querystringRequired
The search query string. See search query language and the list of supported query fields for charges.
- 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.
Returns
A dictionary with a data property that contains an array of up to limit charges. If no objects match the query, the resulting array will be empty. See the related guide on expanding properties in lists.