Struct stripe::UpdateCustomer

pub struct UpdateCustomer<'a> {
    pub address: Option<Address>,
    pub balance: Option<i64>,
    pub coupon: Option<CouponId>,
    pub default_alipay_account: Option<AlipayAccountId>,
    pub default_bank_account: Option<BankAccountId>,
    pub default_card: Option<CardId>,
    pub default_source: Option<PaymentSourceId>,
    pub description: Option<&'a str>,
    pub email: Option<&'a str>,
    pub expand: &'a [&'a str],
    pub invoice_prefix: Option<&'a str>,
    pub invoice_settings: Option<CustomerInvoiceSettings>,
    pub metadata: Option<Metadata>,
    pub name: Option<&'a str>,
    pub next_invoice_sequence: Option<i64>,
    pub phone: Option<&'a str>,
    pub preferred_locales: Option<Vec<String>>,
    pub promotion_code: Option<PromotionCodeId>,
    pub shipping: Option<ShippingParams>,
    pub source: Option<PaymentSourceParams>,
    pub tax_exempt: Option<CustomerTaxExemptFilter>,
    pub trial_end: Option<Scheduled>,
}

The parameters for Customer::update.

Fields

address: Option<Address>

The customer's address.

balance: Option<i64>

An integer amount in %s 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.

coupon: Option<CouponId>

default_alipay_account: Option<AlipayAccountId>

ID of Alipay account to make the customer's new default for invoice payments.

default_bank_account: Option<BankAccountId>

ID of bank account to make the customer's new default for invoice payments.

default_card: Option<CardId>

ID of card to make the customer's new default for invoice payments.

default_source: Option<PaymentSourceId>

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.

description: Option<&'a str>

An arbitrary string that you can attach to a customer object.

It is displayed alongside the customer in the dashboard.

email: Option<&'a str>

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.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

invoice_prefix: Option<&'a str>

The prefix for the customer used to generate unique invoice numbers.

Must be 3–12 uppercase letters or numbers.

invoice_settings: Option<CustomerInvoiceSettings>

Default invoice settings for this customer.

metadata: Option<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.

name: Option<&'a str>

The customer's full name or business name.

next_invoice_sequence: Option<i64>

The sequence to be used on the customer's next invoice.

Defaults to 1.

phone: Option<&'a str>

The customer's phone number.

preferred_locales: Option<Vec<String>>

Customer's preferred languages, ordered by preference.

promotion_code: Option<PromotionCodeId>

The API ID of a promotion code to apply to the customer.

The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.

shipping: Option<ShippingParams>

The customer's shipping information.

Appears on invoices emailed to this customer.

source: Option<PaymentSourceParams>

tax_exempt: Option<CustomerTaxExemptFilter>

The customer's tax exemption.

One of none, exempt, or reverse.

trial_end: Option<Scheduled>

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.

This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value now can be provided to end the customer's trial immediately. Can be at most two years from billing_cycle_anchor.

Implementations

impl<'a> UpdateCustomer<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for UpdateCustomer<'a>

fn clone(&self) -> UpdateCustomer<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UpdateCustomer<'a>

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

Formats the value using the given formatter.

impl<'a> Default for UpdateCustomer<'a>

fn default() -> UpdateCustomer<'a>

Returns the "default value" for a type.

impl<'a> Serialize for UpdateCustomer<'a>

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

Serialize this value into the given Serde serializer.