Customer object

This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer.

  • This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer.

    • created
      Type: stringFormat: date-time
      required

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

    • livemode
      Type: boolean
      required

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

    • email
      Type: string | null
      max length:  
      1000

      The customer's email address.

    • name
      Type: string | null
      max length:  
      5000

      The customer's full name or business name.

    • phone
      Type: string | null
      max length:  
      5000

      The customer's phone number.

    • preferred_locales
      Type: array of string | null
      max length:  
      5000

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

    • address
      Type: Address

      The customer's address.

      Properties: 6
    • invoice_settings
      Type: CustomerInvoiceSetting

      Customer invoice settings

      Properties: 1
    • id
      Type: string
      max length:  
      100
      required

      Unique identifier for the object.