Struct UpdateCharge

pub struct UpdateCharge { /* private fields */ }

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

Implementations

impl UpdateCharge

pub fn new(charge: impl Into<ChargeId>) -> Self

Construct a new UpdateCharge.

pub fn customer(self, customer: impl Into<String>) -> Self

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.

pub fn description(self, description: impl Into<String>) -> Self

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.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn fraud_details( self, fraud_details: impl Into<UpdateChargeFraudDetails>, ) -> Self

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.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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.

pub fn receipt_email(self, receipt_email: impl Into<String>) -> Self

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.

pub fn shipping(self, shipping: impl Into<OptionalFieldsShipping>) -> Self

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

pub fn transfer_group(self, transfer_group: impl Into<String>) -> Self

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.

impl UpdateCharge

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for UpdateCharge

fn clone(&self) -> UpdateCharge

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateCharge

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for UpdateCharge

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for UpdateCharge

type Output = Charge

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.