Stripe.Params.ChargeUpdateParams (tiger_stripe v0.1.10)

Copy Markdown View Source

Parameters for charge update.

Summary

Types

t()

Types

t()

@type t() :: %Stripe.Params.ChargeUpdateParams{
  customer: String.t() | nil,
  description: String.t() | nil,
  expand: [String.t()] | nil,
  fraud_details: Stripe.Params.ChargeUpdateParams.FraudDetails.t() | nil,
  metadata: map() | nil,
  receipt_email: String.t() | nil,
  shipping: Stripe.Params.ChargeUpdateParams.Shipping.t() | nil,
  transfer_group: String.t() | nil
}
  • customer - 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. Max length: 5000.
  • description - 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. Max length: 40000.
  • expand - Specifies which fields in the response should be expanded.
  • fraud_details - 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.
  • metadata - 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_email - 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. Max length: 5000.
  • shipping - Shipping information for the charge. Helps prevent fraud on charges for physical goods.
  • transfer_group - 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.