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
CustomerTax

object
automatic_tax string
required
Surfaces if automatic tax computation is possible given the current customer location information.
Allowed: "failed""not_collecting""supported""unrecognized_location"
ip_address string
optionalnullable
A recent IP address of the customer used for tax reporting and tax location inference.
maxLength:5000
location
optionalnullable
The customer's location as identified by Stripe Tax.
Root JSON Schema
{"description":"This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment).","properties":{"address":{"anyOf":[{"$ref":"#/components/schemas/address"}],"description":"The customer's address.","nullable":true},"balance":{"description":"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.","type":"integer"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"currency":{"description":"Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.","maxLength":5000,"nullable":true,"type":"string"},"default_source":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/alipay_account"},{"$ref":"#/components/schemas/bank_account"},{"$ref":"#/components/schemas/bitcoin_receiver"},{"$ref":"#/components/schemas/card"},{"$ref":"#/components/schemas/source"}],"description":"ID of the default payment source for the customer.\n\nIf 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.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/alipay_account"},{"$ref":"#/components/schemas/bank_account"},{"$ref":"#/components/schemas/bitcoin_receiver"},{"$ref":"#/components/schemas/card"},{"$ref":"#/components/schemas/source"}]}},"delinquent":{"description":"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.\n\nIf an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`.","nullable":true,"type":"boolean"},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","maxLength":5000,"nullable":true,"type":"string"},"discount":{"anyOf":[{"$ref":"#/components/schemas/discount"}],"description":"Describes the current discount active on the customer, if there is one.","nullable":true},"email":{"description":"The customer's email address.","maxLength":5000,"nullable":true,"type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"invoice_prefix":{"description":"The prefix for the customer used to generate unique invoice numbers.","maxLength":5000,"nullable":true,"type":"string"},"invoice_settings":{"$ref":"#/components/schemas/invoice_setting_customer_setting"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"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.","type":"object"},"name":{"description":"The customer's full name or business name.","maxLength":5000,"nullable":true,"type":"string"},"next_invoice_sequence":{"description":"The suffix of the customer's next invoice number, e.g., 0001.","type":"integer"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["customer"],"type":"string"},"phone":{"description":"The customer's phone number.","maxLength":5000,"nullable":true,"type":"string"},"preferred_locales":{"description":"The customer's preferred locales (languages), ordered by preference.","items":{"maxLength":5000,"type":"string"},"nullable":true,"type":"array"},"shipping":{"anyOf":[{"$ref":"#/components/schemas/shipping"}],"description":"Mailing and shipping address for the customer. Appears on invoices emailed to this customer.","nullable":true},"sources":{"description":"The customer's payment sources, if any.","properties":{"data":{"description":"Details about each object.","items":{"anyOf":[{"$ref":"#/components/schemas/alipay_account"},{"$ref":"#/components/schemas/bank_account"},{"$ref":"#/components/schemas/bitcoin_receiver"},{"$ref":"#/components/schemas/card"},{"$ref":"#/components/schemas/source"}],"title":"Polymorphic"},"type":"array"},"has_more":{"description":"True if this list has another page of items after this one that can be fetched.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"],"type":"string"},"url":{"description":"The URL where this list can be accessed.","maxLength":5000,"type":"string"}},"required":["data","has_more","object","url"],"title":"ApmsSourcesSourceList","type":"object","x-expandableFields":["data"]},"subscriptions":{"description":"The customer's current subscriptions, if any.","properties":{"data":{"description":"Details about each object.","items":{"$ref":"#/components/schemas/subscription"},"type":"array"},"has_more":{"description":"True if this list has another page of items after this one that can be fetched.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"],"type":"string"},"url":{"description":"The URL where this list can be accessed.","maxLength":5000,"type":"string"}},"required":["data","has_more","object","url"],"title":"SubscriptionList","type":"object","x-expandableFields":["data"]},"tax":{"$ref":"#/components/schemas/customer_tax"},"tax_exempt":{"description":"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\"**.","enum":["exempt","none","reverse"],"nullable":true,"type":"string"},"tax_ids":{"description":"The customer's tax IDs.","properties":{"data":{"description":"Details about each object.","items":{"$ref":"#/components/schemas/tax_id"},"type":"array"},"has_more":{"description":"True if this list has another page of items after this one that can be fetched.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"],"type":"string"},"url":{"description":"The URL where this list can be accessed.","maxLength":5000,"type":"string"}},"required":["data","has_more","object","url"],"title":"TaxIDsList","type":"object","x-expandableFields":["data"]}},"required":["created","id","livemode","object"],"title":"Customer","type":"object","x-expandableFields":["address","default_source","discount","invoice_settings","shipping","sources","subscriptions","tax","tax_ids"],"x-resourceId":"customer"}