Skip to main content
Schema2020-08-27object

customer

This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

Customer

object

This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer. Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment).

address
optionalnullable

The customer's address.

balance integer
optional

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 integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string
optionalnullable

Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.

default_source
optionalnullable

ID of the default payment source for the customer. If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.

delinquent boolean
optionalnullable

When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. If an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`.

description string
optionalnullable

An arbitrary string attached to the object. Often useful for displaying to users.

discount
optionalnullable

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

email string
optionalnullable

The customer's email address.

id string
required

Unique identifier for the object.

invoice_prefix string
optionalnullable

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

livemode boolean
required

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

metadata object
optional

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

name string
optionalnullable

The customer's full name or business name.

next_invoice_sequence integer
optional

The suffix of the customer's next invoice number, e.g., 0001.

object string
required

String representing the object's type. Objects of the same type share the same value.

phone string
optionalnullable

The customer's phone number.

preferred_locales array
optionalnullable

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

shipping
optionalnullable

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

subscriptions SubscriptionList object
optional

The customer's current subscriptions, if any.

tax_exempt string
optionalnullable

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 TaxIDsList object
optional

The customer's tax IDs.