Sample - Stripe API
POST/v1/charges/{charge}

Update a charge

Updates selected properties of an existing charge without changing fields that you omit. Supply charge and include only the charge attributes you want to modify. Some attributes, including an associated customer or transfer group, can only be set when their existing value permits the change.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 8 body fields
chargestringrequired
The unique identifier of the charge to update. Maximum 5,000 characters.

Optional form-encoded fields to update on the charge; omitted fields remain unchanged.

customerstringoptional
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.
descriptionstringoptional
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 `description` of the charge(s) that they are describing.
expandarray<string>optional
Specifies which fields in the response should be expanded.
fraud_detailsobjectoptional
A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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_emailstringoptional
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.
shippingobjectoptional
Shipping information for the charge. Helps prevent fraud on charges for physical goods.
transfer_groupstringoptional
A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.

2 status codes
200Returns the updated Charge object with the submitted changes applied.
amountintegerrequired
Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (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](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
amount_capturedintegerrequired
Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
amount_refundedintegerrequired
Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
applicationstringoptional
ID of the Connect application that created the charge.
application_feestringoptional
The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.
application_fee_amountintegeroptional
The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.
balance_transactionstringoptional
ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
billing_detailsobjectrequired
calculated_statement_descriptorstringoptional
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.
capturedbooleanrequired
If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
customerstringoptional
ID of the customer this charge is for if one exists.
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
disputedbooleanrequired
Whether the charge has been disputed.
failure_balance_transactionstringoptional
ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
failure_codestringoptional
Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes).
failure_messagestringoptional
Message to user further explaining reason for charge failure if available.
fraud_detailsobjectoptional
Information on fraud assessments for the charge.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:charge
on_behalf_ofstringoptional
The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
outcomeobjectoptional
Details about whether the payment was accepted, and why. See [understanding declines](https://docs.stripe.com/declines) for details.
paidbooleanrequired
`true` if the charge succeeded, or was successfully authorized for later capture.
payment_intentstringoptional
ID of the PaymentIntent associated with this charge, if one exists.
payment_methodstringoptional
ID of the payment method used in this charge.
payment_method_detailsobjectoptional
Details about the payment method at the time of the transaction.
presentment_detailsobjectoptional
radar_optionsobjectoptional
Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
receipt_emailstringoptional
This is the email address that the receipt for this charge was sent to.
receipt_numberstringoptional
This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.
receipt_urlstringoptional
This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
refundedbooleanrequired
Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
refundsobjectoptional
A list of refunds that have been applied to the charge.
reviewstringoptional
ID of the review associated with this charge if one exists.
shippingobjectoptional
Shipping information for the charge.
source_transferstringoptional
The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
statement_descriptorstringoptional
For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
statement_descriptor_suffixstringoptional
Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
statusstringrequired
The status of the payment is either `succeeded`, `pending`, or `failed`.
Allowed:failedpendingsucceeded
transferstringoptional
ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
transfer_dataobjectoptional
An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
transfer_groupstringoptional
A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
defaultReturns an error object when the charge update cannot be processed.
errorobjectrequired

Error handling

charge must identify the existing charge and must not exceed 5,000 characters. fraud_details.user_report must be one of: an empty value, fraudulent, or safe; description must not exceed 40,000 characters and shipping must include address and name when provided.