POST /v1/customers

Creates a new customer object.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
source String No
tax Object No

Tax details about the customer.

tax.validate_location String No

Possible values:

  • "deferred"
  • "immediately"
tax.ip_address No
description String No

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

expand[] Array No

Specifies which fields in the response should be expanded.

metadata No

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.

payment_method String No
next_invoice_sequence Integer No

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

email String No

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.

name String No

The customer's full name or business name.

test_clock String No

ID of the test clock to attach to the customer.

cash_balance Object No

Balance information and default balance settings for this customer.

cash_balance.settings Object No
cash_balance.settings.reconciliation_mode String No

Possible values:

  • "manual"
  • "automatic"
  • "merchant_default"
invoice_prefix String No

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

phone String No

The customer's phone number.

balance Integer No

An integer amount in cents (or local equivalent) 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.

shipping No

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

preferred_locales[] Array No

Customer's preferred languages, ordered by preference.

tax_id_data[] Array No

The customer's tax IDs.

tax_id_data[].type String Yes

Possible values:

  • "br_cnpj"
  • "ng_tin"
  • "my_sst"
  • "bj_ifu"
  • "ca_gst_hst"
  • "tz_vat"
  • "eu_oss_vat"
  • "aw_tin"
  • "ad_nrt"
  • "my_frp"
  • "bo_tin"
  • "kg_tin"
  • "au_arn"
  • "mx_rfc"
  • "pe_ruc"
  • "hk_br"
  • "nz_gst"
  • "sg_uen"
  • "zw_tin"
  • "me_pib"
  • "br_cpf"
  • "au_abn"
  • "ge_vat"
  • "kr_brn"
  • "cd_nif"
  • "eu_vat"
  • "bg_uic"
  • "eg_tin"
  • "al_tin"
  • "sv_nit"
  • "il_vat"
  • "ro_tin"
  • "sg_gst"
  • "jp_rn"
  • "np_pan"
  • "vn_tin"
  • "sa_vat"
  • "ba_tin"
  • "ao_tin"
  • "az_tin"
  • "ca_qst"
  • "ca_pst_mb"
  • "tw_vat"
  • "mk_vat"
  • "bb_tin"
  • "li_uid"
  • "om_vat"
  • "za_vat"
  • "md_vat"
  • "ec_ruc"
  • "tr_tin"
  • "uz_tin"
  • "si_tin"
  • "ma_vat"
  • "bf_ifu"
  • "hr_oib"
  • "bd_bin"
  • "co_nit"
  • "ru_kpp"
  • "no_voec"
  • "ke_pin"
  • "us_ein"
  • "ug_tin"
  • "do_rcn"
  • "th_vat"
  • "mr_nif"
  • "ch_vat"
  • "ar_cuit"
  • "jp_cn"
  • "cn_tin"
  • "rs_pib"
  • "ca_bn"
  • "de_stn"
  • "es_cif"
  • "ua_vat"
  • "ca_pst_bc"
  • "li_vat"
  • "ae_trn"
  • "ph_tin"
  • "id_npwp"
  • "jp_trn"
  • "is_vat"
  • "gb_vat"
  • "hu_tin"
  • "sr_fin"
  • "gn_nif"
  • "zm_tin"
  • "cm_niu"
  • "no_vat"
  • "bs_tin"
  • "ch_uid"
  • "la_tin"
  • "kz_bin"
  • "uz_vat"
  • "ca_pst_sk"
  • "by_tin"
  • "cv_nif"
  • "kh_tin"
  • "bh_vat"
  • "in_gst"
  • "my_itn"
  • "am_tin"
  • "cl_tin"
  • "uy_ruc"
  • "ve_rif"
  • "ru_inn"
  • "sn_ninea"
  • "et_tin"
  • "cr_tin"
  • "tj_tin"
tax_id_data[].value String Yes
address No

The customer's address.

tax_exempt String No

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

Possible values:

  • ""
  • "reverse"
  • "exempt"
  • "none"
invoice_settings Object No

Default invoice settings for this customer.

invoice_settings.default_payment_method String No
invoice_settings.rendering_options No
invoice_settings.custom_fields No
invoice_settings.footer String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.