Struct stripe::Customer

pub struct Customer {
    pub id: CustomerId,
    pub account_balance: Option<i64>,
    pub address: Option<Address>,
    pub balance: Option<i64>,
    pub created: Option<Timestamp>,
    pub currency: Option<Currency>,
    pub default_source: Option<Expandable<PaymentSource>>,
    pub deleted: bool,
    pub delinquent: Option<bool>,
    pub description: Option<String>,
    pub discount: Option<Discount>,
    pub email: Option<String>,
    pub invoice_prefix: Option<String>,
    pub invoice_settings: Option<InvoiceSettingCustomerSetting>,
    pub livemode: Option<bool>,
    pub metadata: Metadata,
    pub name: Option<String>,
    pub phone: Option<String>,
    pub preferred_locales: Option<Vec<String>>,
    pub shipping: Option<Shipping>,
    pub sources: List<PaymentSource>,
    pub subscriptions: List<Subscription>,
    pub tax_exempt: Option<CustomerTaxExempt>,
    pub tax_ids: List<TaxId>,
    pub tax_info: Option<TaxInfo>,
    pub tax_info_verification: Option<TaxInfoVerification>,
}

The resource representing a Stripe "Customer".

For more details see https://stripe.com/docs/api/customers/object.

Fields

id: CustomerId

Unique identifier for the object.

account_balance: Option<i64>

This field has been renamed to balance and will be removed in a future API version.

address: Option<Address>

The customer's address.

balance: Option<i64>

Current balance, if any, being stored on the customer.

If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.

created: Option<Timestamp>

Time at which the object was created.

Measured in seconds since the Unix epoch.

currency: Option<Currency>

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

default_source: Option<Expandable<PaymentSource>>

ID of the default payment source for the customer.

deleted: bool

delinquent: Option<bool>

When the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge is failed.

When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice is not paid by its due date.

description: Option<String>

An arbitrary string attached to the object.

Often useful for displaying to users.

discount: Option<Discount>

Describes the current discount active on the customer, if there is one.

email: Option<String>

The customer's email address.

invoice_prefix: Option<String>

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

invoice_settings: Option<InvoiceSettingCustomerSetting>

livemode: Option<bool>

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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

name: Option<String>

The customer's full name or business name.

phone: Option<String>

The customer's phone number.

preferred_locales: Option<Vec<String>>

The customer's preferred locales (languages), ordered by preference.

shipping: Option<Shipping>

Mailing and shipping address for the customer.

Appears on invoices emailed to this customer.

sources: List<PaymentSource>

The customer's payment sources, if any.

subscriptions: List<Subscription>

The customer's current subscriptions, if any.

tax_exempt: Option<CustomerTaxExempt>

Describes the customer's tax exemption status.

One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text "Reverse charge".

tax_ids: List<TaxId>

The customer's tax IDs.

tax_info: Option<TaxInfo>

The customer's tax information.

Appears on invoices emailed to this customer. This field has been deprecated and will be removed in a future API version, for further information view the migration guide.

tax_info_verification: Option<TaxInfoVerification>

Describes the status of looking up the tax ID provided in tax_info.

This field has been deprecated and will be removed in a future API version, for further information view the migration guide.

Implementations

impl Customer

pub fn list(client: &Client, params: ListCustomers) -> Response<List<Customer>>

Returns a list of your customers.

The customers are returned sorted by creation date, with the most recent customers appearing first.

pub fn create(client: &Client, params: CreateCustomer) -> Response<Customer>

Creates a new customer object.

pub fn retrieve(
    client: &Client,
    id: &CustomerId,
    expand: &[&str]
) -> Response<Customer>

Retrieves the details of an existing customer.

You need only supply the unique customer identifier that was returned upon customer creation.

pub fn update(
    client: &Client,
    id: &CustomerId,
    params: UpdateCustomer
) -> Response<Customer>

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.

pub fn delete(client: &Client, id: &CustomerId) -> Response<Deleted<CustomerId>>

Permanently deletes a customer.

It cannot be undone. Also immediately cancels any active subscriptions on the customer.

impl Customer

pub fn attach_source(
    client: &Client,
    customer_id: &CustomerId,
    source: PaymentSourceParams
) -> Response<PaymentSource>

Attaches a source to a customer, does not change default Source for the Customer

For more details see https://stripe.com/docs/api#attach_source.

pub fn detach_source(
    client: &Client,
    customer_id: &CustomerId,
    source_id: &PaymentSourceId
) -> Response<DetachedSource>

Detaches a source from a customer

For more details see https://stripe.com/docs/api#detach_source.

pub fn retrieve_source(
    client: &Client,
    customer_id: &CustomerId,
    source_id: &PaymentSourceId
) -> Response<PaymentSource>

Retrieves a Card, BankAccount, or Source for a Customer

pub fn verify_bank_account(
    client: &Client,
    customer_id: &CustomerId,
    bank_account_id: &BankAccountId,
    params: VerifyBankAccount
) -> Response<BankAccount>

Verifies a Bank Account for a Customer.

For more details see https://stripe.com/docs/api/customer_bank_accounts/verify.

Trait Implementations

impl Clone for Customer

fn clone(&self) -> Customer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Customer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Customer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Object for Customer

type Id = CustomerId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Serialize for Customer

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

Serialize this value into the given Serde serializer.