CustomerBase

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.

  • address

    The customer's address.

    • city
      Type: string | null
      max length:  
      100

      City, district, suburb, town, or village.

    • country
      Type: string | null
      max length:  
      2

      Two-letter country code (ISO 3166-1 alpha-2).

    • line1
      Type: string | null
      max length:  
      100

      Address line 1 (e.g., street, PO Box, or company name).

    • line2
      Type: string | null
      max length:  
      100

      Address line 2 (e.g., apartment, suite, unit, or building).

    • postal_code
      Type: string | null
      max length:  
      100

      ZIP or postal code.

    • state
      Type: string | null
      max length:  
      100

      State, county, province, or region.

  • email
    Type: string | null
    max length:  
    1000

    The customer's email address.

  • invoice_settings

    Customer invoice settings

    • default_payment_method

      ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.

      • Type: string · PaymentMethodId

        ID of the payment method to attach to this PaymentIntent.

  • 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 string[] | null

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