The Customer object

Attributes

idstring
Unique identifier for the object.

addressnullable dictionary
The customer’s address.

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

emailnullable string
The customer’s email address.

metadatadictionary
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.

namenullable string
The customer’s full name or business name.

phonenullable string
The customer’s phone number.

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

taxdictionaryExpandable
Tax details for the customer.

More attributes

objectstring

balanceinteger

cash_balancenullable dictionaryExpandable

createdtimestamp

currencynullable string

default_sourcenullable stringExpandable

delinquentnullable boolean

discountnullable dictionary

invoice_credit_balancedictionaryExpandable

invoice_prefixnullable string

invoice_settingsdictionary

livemodeboolean

next_invoice_sequencenullable integer

preferred_localesnullable array of strings

sourcesnullable dictionaryExpandable

subscriptionsnullable dictionaryExpandable

tax_exemptnullable enum

tax_idsnullable dictionaryExpandable

test_clocknullable stringExpandable

The Customer object

{
  "id": "cus_NffrFeUfNV2Hib",
  "object": "customer",
  "address": null,
  "balance": 0,
  "created": 1680893993,
  "currency": null,
  "default_source": null,
  "delinquent": false,
  "description": null,
  "email": "jennyrosen@example.com",
  "invoice_prefix": "0759376C",
  "invoice_settings": {
    "custom_fields": null,
    "default_payment_method": null,
    "footer": null,
    "rendering_options": null
  },
  "livemode": false,
  "metadata": {},
  "name": "Jenny Rosen",
  "next_invoice_sequence": 1,
  "phone": null,
  "preferred_locales": [],
  "shipping": null,
  "tax_exempt": "none",
  "test_clock": null
}

Create a customer

Parameters

addressdictionaryRequired if calculating taxes
The customer’s address.

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

emailstring
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.

metadatadictionary
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.

namestring
The customer’s full name or business name.

payment_methodstring
The ID of the PaymentMethod to attach to the customer.

phonestring
The customer’s phone number.

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

taxdictionaryRecommended if calculating taxes
Tax details about the customer.

More parameters

balanceinteger

cash_balancedictionary

invoice_prefixstring

invoice_settingsdictionary

next_invoice_sequenceinteger

preferred_localesarray of strings

sourcestring

tax_exemptenum

tax_id_dataarray of dictionaries

test_clockstring

Returns

Returns the Customer object after successful customer creation. Raises an error if create parameters are invalid (for example, specifying an invalid coupon or an invalid source).

POST /v1/customers

Server-side language

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
import stripe
stripe.api_key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
customer =
stripe.Customer.create(
  name="Jenny Rosen",
  email="jennyrosen@example.com",
)

Response

{
  "id": "cus_NffrFeUfNV2Hib",
  "object": "customer",
  "address": null,
  "balance": 0,
  "created": 1680893993,
  "currency": null,
  "default_source": null,
  "delinquent": false,
  "description": null,
  "email": "jennyrosen@example.com",
  "invoice_prefix": "0759376C",
  "invoice_settings": {
    "custom_fields": null,
    "default_payment_method": null,
    "footer": null,
    "rendering_options": null
  },
  "livemode": false,
  "metadata": {},
  "name": "Jenny Rosen",
  "next_invoice_sequence": 1,
  "phone": null,
  "preferred_locales": [],
  "shipping": null,
  "tax_exempt": "none",
  "test_clock": null
}

Update a 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.

Parameters

addressdictionaryRequired if calculating taxes
The customer’s address.

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

emailstring
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.

metadatadictionary
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.

namestring
The customer’s full name or business name.

phonestring
The customer’s phone number.

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

taxdictionaryRecommended if calculating taxes
Tax details about the customer.

More parameters

balanceinteger

cash_balancedictionary

default_sourcestring

invoice_prefixstring

invoice_settingsdictionary

next_invoice_sequenceinteger

preferred_localesarray of strings

sourcestring

tax_exemptenum

Returns

Returns the customer object if the update succeeded. Raises an error if update parameters are invalid (e.g. specifying an invalid coupon or an invalid source).

POST /v1/customers/:id

Server-side language

import stripe
stripe.api_key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
customer =
stripe.Customer.modify(
  "cus_NffrFeUfNV2Hib",
  metadata={"order_id": "6735"},
)

Response

{
  "id": "cus_NffrFeUfNV2Hib",
  "object": "customer",
  "address": null,
  "balance": 0,
  "created": 1680893993,
  "currency": null,
  "default_source": null,
  "delinquent": false,
  "description": null,
  "email": "jennyrosen@example.com",
  "invoice_prefix": "0759376C",
  "invoice_settings": {
    "custom_fields": null,
    "default_payment_method": null,
    "footer": null,
    "rendering_options": null
  },
  "livemode": false,
  "metadata": {
    "order_id": "6735"
  },
  "name": "Jenny Rosen",
  "next_invoice_sequence": 1,
  "phone": null,
  "preferred_locales": [],
  "shipping": null,
  "tax_exempt": "none",
  "test_clock": null
}

Retrieve a customer

Retrieves a Customer object.

Parameters

No parameters.

Returns

Returns the Customer object for a valid identifier. If it’s for a deleted Customer, a subset of the customer’s information is returned, including a deleted property that’s set to true.

GET /v1/customers/:id

Server-side language

import stripe
stripe.api_key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
customer =
stripe.Customer.retrieve("cus_NffrFeUfNV2Hib")

Response

{
  "id": "cus_NffrFeUfNV2Hib",
  "object": "customer",
  "address": null,
  "balance": 0,
  "created": 1680893993,
  "currency": null,
  "default_source": null,
  "delinquent": false,
  "description": null,
  "email": "jennyrosen@example.com",
  "invoice_prefix": "0759376C",
  "invoice_settings": {
    "custom_fields": null,
    "default_payment_method": null,
    "footer": null,
    "rendering_options": null
  },
  "livemode": false,
  "metadata": {},
  "name": "Jenny Rosen",
  "next_invoice_sequence": 1,
  "phone": null,
  "preferred_locales": [],
  "shipping": null,
  "tax_exempt": "none",
  "test_clock": null
}

List all customers

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

Parameters

emailstring
A case-sensitive filter on the list based on the customer’s email field. The value must be a string.

More parameters

createddictionary

ending_beforestring

limitinteger

starting_afterstring

test_clockstring

Returns

A dictionary with a data property that contains an array of up to limit customers, starting after customer starting_after. Passing an optional email will result in filtering to customers with only that exact email address. Each entry in the array is a separate customer object. If no more customers are available, the resulting array will be empty.

GET /v1/customers

Server-side language

import stripe
stripe.api_key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
customers =
stripe.Customer.list(limit=3)

Response

{
  "object": "list",
  "url": "/v1/customers",
  "has_more": false,
  "data": [
    {
      "id": "cus_NffrFeUfNV2Hib",
      "object": "customer",
      "address": null,
      "balance": 0,
      "created": 1680893993,
      "currency": null,
      "default_source": null,
      "delinquent": false,
      "description": null,
      "email": "jennyrosen@example.com",
      "invoice_prefix": "0759376C",
      "invoice_settings": {
        "custom_fields": null,
        "default_payment_method": null,
        "footer": null,
        "rendering_options": null
      },
      "livemode": false,
      "metadata": {},
      "name": "Jenny Rosen",
      "next_invoice_sequence": 1,
      "phone": null,
      "preferred_locales": [],
      "shipping": null,
      "tax_exempt": "none",
      "test_clock": null
    }
  ]
}

The Customer object

Attributes

idstring

addressnullable dictionary

descriptionnullable string

emailnullable string

metadatadictionary

namenullable string

phonenullable string

shippingnullable dictionary

taxdictionaryExpandable

More attributesExpand all

objectstring

balanceinteger

cash_balancenullable dictionaryExpandable

createdtimestamp

currencynullable string

default_sourcenullable stringExpandable

delinquentnullable boolean

discountnullable dictionary

invoice_credit_balancedictionaryExpandable

invoice_prefixnullable string

invoice_settingsdictionary

livemodeboolean

next_invoice_sequencenullable integer

preferred_localesnullable array of strings

sourcesnullable dictionaryExpandable

subscriptionsnullable dictionaryExpandable

tax_exemptnullable enum

tax_idsnullable dictionaryExpandable

test_clocknullable stringExpandable

Create a customer

Parameters

addressdictionaryRequired if calculating taxes

descriptionstring

emailstring

metadatadictionary

namestring

payment_methodstring

phonestring

shippingdictionary

taxdictionaryRecommended if calculating taxes

More parametersExpand all

balanceinteger

cash_balancedictionary

invoice_prefixstring

invoice_settingsdictionary

next_invoice_sequenceinteger

preferred_localesarray of strings

sourcestring

tax_exemptenum

tax_id_dataarray of dictionaries

test_clockstring

Returns

Update a customer

Parameters

addressdictionaryRequired if calculating taxes

descriptionstring

emailstring

metadatadictionary

namestring

phonestring

shippingdictionary

taxdictionaryRecommended if calculating taxes

More parametersExpand all

balanceinteger

cash_balancedictionary

default_sourcestring

invoice_prefixstring

invoice_settingsdictionary

next_invoice_sequenceinteger

preferred_localesarray of strings

sourcestring

tax_exemptenum

Returns

Retrieve a customer

Parameters

Returns

List all customers

Parameters

More attributes

More parameters

More parameters

More parameters