Documentation

Fields

• postCustomersRequestBodyAddress :: Maybe PostCustomersRequestBodyAddress'Variants

  address: The customer's address.

• postCustomersRequestBodyBalance :: Maybe Integer

  balance: An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.

• postCustomersRequestBodyCoupon :: Maybe String

  coupon

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyDescription :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyEmail :: Maybe String

  email: 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*.

  Constraints:

  • Maximum length of 512
• postCustomersRequestBodyExpand :: Maybe ([] String)

  expand: Specifies which fields in the response should be expanded.

• postCustomersRequestBodyInvoicePrefix :: Maybe String

  invoice_prefix: The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyInvoiceSettings :: Maybe PostCustomersRequestBodyInvoiceSettings'

  invoice_settings: Default invoice settings for this customer.

• postCustomersRequestBodyMetadata :: Maybe PostCustomersRequestBodyMetadata'

  metadata: 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`.

• postCustomersRequestBodyName :: Maybe String

  name: The customer's full name or business name.

  Constraints:

  • Maximum length of 256
• postCustomersRequestBodyNextInvoiceSequence :: Maybe Integer

  next_invoice_sequence: The sequence to be used on the customer's next invoice. Defaults to 1.

• postCustomersRequestBodyPaymentMethod :: Maybe String

  payment_method

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyPhone :: Maybe String

  phone: The customer's phone number.

  Constraints:

  • Maximum length of 20
• postCustomersRequestBodyPreferredLocales :: Maybe ([] String)

  preferred_locales: Customer's preferred languages, ordered by preference.

• postCustomersRequestBodyShipping :: Maybe PostCustomersRequestBodyShipping'Variants

  shipping: The customer's shipping information. Appears on invoices emailed to this customer.

• postCustomersRequestBodySource :: Maybe String

  source

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyTaxExempt :: Maybe PostCustomersRequestBodyTaxExempt'

  tax_exempt: The customer's tax exemption. One of `none`, `exempt`, or `reverse`.

• postCustomersRequestBodyTaxIdData :: Maybe ([] PostCustomersRequestBodyTaxIdData')

  tax_id_data: The customer's tax IDs.

Fields

• postCustomersRequestBodyAddress'OneOf2City :: Maybe String

  city

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyAddress'OneOf2Country :: Maybe String

  country

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyAddress'OneOf2Line1 :: String

  line1

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyAddress'OneOf2Line2 :: Maybe String

  line2

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyAddress'OneOf2PostalCode :: Maybe String

  postal_code

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyAddress'OneOf2State :: Maybe String

  state

  Constraints:

  • Maximum length of 5000

Fields

• postCustomersRequestBodyInvoiceSettings'CustomFields :: Maybe PostCustomersRequestBodyInvoiceSettings'CustomFields'Variants

  custom_fields

• postCustomersRequestBodyInvoiceSettings'DefaultPaymentMethod :: Maybe String

  default_payment_method

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyInvoiceSettings'Footer :: Maybe String

  footer

  Constraints:

  • Maximum length of 5000

Fields

• postCustomersRequestBodyInvoiceSettings'CustomFields'OneOf2Name :: String

  name

  Constraints:

  • Maximum length of 30
• postCustomersRequestBodyInvoiceSettings'CustomFields'OneOf2Value :: String

  value

  Constraints:

  • Maximum length of 30

Fields

• postCustomersRequestBodyShipping'OneOf2Address :: PostCustomersRequestBodyShipping'OneOf2Address'

  address

• postCustomersRequestBodyShipping'OneOf2Name :: String

  name

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyShipping'OneOf2Phone :: Maybe String

  phone

  Constraints:

  • Maximum length of 5000

Fields

• postCustomersRequestBodyShipping'OneOf2Address'City :: Maybe String

  city

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyShipping'OneOf2Address'Country :: Maybe String

  country

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyShipping'OneOf2Address'Line1 :: String

  line1

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyShipping'OneOf2Address'Line2 :: Maybe String

  line2

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyShipping'OneOf2Address'PostalCode :: Maybe String

  postal_code

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyShipping'OneOf2Address'State :: Maybe String

  state

  Constraints:

  • Maximum length of 5000

Fields

• postCustomersRequestBodyTaxIdData'Type :: PostCustomersRequestBodyTaxIdData'Type'

  type

  Constraints:

  • Maximum length of 5000
• postCustomersRequestBodyTaxIdData'Value :: String

  value