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.

    • id
      Type: string
      max length:  
      100
      required

      Unique identifier for the object.

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

    • address

      The customer's address.

    • email
      Type: string | null
      max length:  
      1000

      The customer's email address.

    • invoice_settings

      Customer invoice settings

    • name
      Type: string | null
      max length:  
      5000

      The customer's full name or business name.

    • payment_methods
      Type: array object[] · PaymentMethod[]

      List of payment methods attached to the customer.

      PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    • phone
      Type: string | null
      max length:  
      5000

      The customer's phone number.

    • preferred_locales
      Type: array string[] | null

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