POST /v1/charges/{charge}

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

Servers

Path parameters

Name Type Required Description
charge String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
fraud_details Object No

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.

fraud_details.user_report String Yes

Possible values:

  • ""
  • "safe"
  • "fraudulent"
customer String No

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.

description String No

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.

expand[] Array No

Specifies which fields in the response should be expanded.

metadata No

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.

shipping Object No

Shipping information for the charge. Helps prevent fraud on charges for physical goods.

shipping.name String Yes
shipping.carrier String No
shipping.phone String No
shipping.address Object Yes
shipping.address.line2 String No
shipping.address.line1 String No
shipping.address.postal_code String No
shipping.address.country String No
shipping.address.state String No
shipping.address.city String No
shipping.tracking_number String No
transfer_group String No

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 for details.

receipt_email String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.