Update a charge

Changed on

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post/v1/charges/{charge}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/charges/{charge}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

chargestring required

Response

Successful response.

amountinteger required

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_capturedinteger required

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

amount_refundedinteger required

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

application_fee_amountinteger nullable

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

calculated_statement_descriptorstring nullable

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.

capturedboolean required

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

createdinteger required

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

currencystring currency required

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

descriptionstring nullable

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

disputedboolean required

Whether the charge has been disputed.

failure_codestring nullable

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

failure_messagestring nullable

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

idstring required

Unique identifier for the object.

livemodeboolean required

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

metadataobject required

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'charge' required

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

paidboolean required

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

payment_methodstring nullable

ID of the payment method used in this charge.

receipt_emailstring nullable

This is the email address that the receipt for this charge was sent to.

receipt_numberstring nullable

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_urlstring nullable

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.

refundedboolean required

Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.

statement_descriptorstring nullable

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.

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_suffixstring nullable

Provides information about a card charge. Concatenated to the account's statement descriptor prefix 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.

status'failed' | 'pending' | 'succeeded' required

The status of the payment is either succeeded, pending, or failed.

transfer_groupstring nullable

A string that identifies this transaction as part of a group. See the Connect documentation for details.

Changes

  • 8b5c2f03d4cdRevision changes
    • 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

    • 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

    This list may be incomplete.

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.