Struct UpdateCustomer

pub struct UpdateCustomer { /* private fields */ }

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

This request accepts mostly the same arguments as the customer creation call.

Implementations

impl UpdateCustomer

pub fn new(customer: impl Into<CustomerId>) -> Self

Construct a new UpdateCustomer.

pub fn address(self, address: impl Into<OptionalFieldsCustomerAddress>) -> Self

The customer’s address.

pub fn balance(self, balance: impl Into<i64>) -> Self

An integer amount in cents (or local equivalent) that represents the customer’s current balance, which affect the customer’s future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.

pub fn cash_balance( self, cash_balance: impl Into<UpdateCustomerCashBalance>, ) -> Self

Balance information and default balance settings for this customer.

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

If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method parameter.

Provide the ID of a payment source already attached to this customer to make it this customer’s default payment source.

If you want to add a new payment source and make it the default, see the source property.

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

An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.

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

Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.

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

Specifies which fields in the response should be expanded.

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

The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

pub fn invoice_settings( self, invoice_settings: impl Into<UpdateCustomerInvoiceSettings>, ) -> Self

Default invoice settings for this customer.

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 name(self, name: impl Into<String>) -> Self

The customer’s full name or business name.

pub fn next_invoice_sequence( self, next_invoice_sequence: impl Into<i64>, ) -> Self

The sequence to be used on the customer’s next invoice. Defaults to 1.

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

The customer’s phone number.

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

Customer’s preferred languages, ordered by preference.

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

The customer’s shipping information. Appears on invoices emailed to this customer.

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

pub fn tax(self, tax: impl Into<UpdateCustomerTax>) -> Self

Tax details about the customer.

pub fn tax_exempt(self, tax_exempt: impl Into<CustomerTaxExempt>) -> Self

The customer’s tax exemption. One of none, exempt, or reverse.

pub fn validate(self, validate: impl Into<bool>) -> Self

impl UpdateCustomer

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 UpdateCustomer

fn clone(&self) -> UpdateCustomer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateCustomer

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

Formats the value using the given formatter.

impl Serialize for UpdateCustomer

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 UpdateCustomer

type Output = Customer

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.