Skip to main content

Create a customer

POST 
/api/v3/customer

Note that the response/id value will be the customer_id value for the newly created customer.

Request​

Body

    parent_customer_id integer

    Parent customer ID #

    external_key string

    External key value

    company string

    Company/customer name

    language_id integer

    Language ID #

    currency_id integer

    Currency ID #

    class_id integer

    Default class tracking ID #

    admin_id integer

    Admin/Worker ID #

    campaign_id integer

    Campaign/lead source ID #

    campaign_details string

    Campaign/lead source details

    superuser_username string

    Main contact username

    superuser_email string

    Main contact e-mail address

    superuser_name string

    Main contact name

    superuser_first_name string

    Main contact first name

    superuser_last_name string

    Main contact last name

    superuser_phone string

    Main contact phone number

    bill_addr1 string

    Billing address line 1

    bill_addr2 string

    Billing address line 2

    bill_addr3 string

    Billing address line 3

    bill_city string

    Billing address city

    bill_state string

    Billing address state/province

    bill_postcode string

    Billing address postal code

    bill_country string

    Billing address country

    ship_addr1 string

    Shipping address line 1

    ship_addr2 string

    Shipping address line 2

    ship_addr3 string

    Shipping address line 3

    ship_city string

    Shipping address city

    ship_state string

    Shipping address state

    ship_postcode string

    Shipping address postal code

    ship_country string

    Shipping address country

    custom_1 string

    Custom field #1

    custom_2 string

    Custom field #2

    custom_3 string

    Custom field #3

    custom_4 string

    Custom field #4

    custom_5 string

    Custom field #5

    custom_6 string

    Custom field #6

    custom_7 string

    Custom field #7

    custom_8 string

    Custom field #8

    custom_9 string

    Custom field #9

    custom_10 string

    Custom field #10

    custom_11 string

    Custom field #11

    custom_12 string

    Custom field #12

    custom_13 string

    Custom field #13

    custom_14 string

    Custom field #14

    custom_15 string

    Custom field #15

    custom_16 string

    Custom field #16

    custom_17 string

    Custom field #17

    custom_18 string

    Custom field #18

    custom_19 string

    Custom field #19

    custom_20 string

    Custom field #20

    brand_id integer

    Brand ID #

    terms_id integer

    Default terms ID #

    no_taxes boolean

    Flag to disable charging of taxes

    no_dunning boolean

    Flag to disable dunning

    no_latefees boolean

    Flag to disable late fees

    no_procfees boolean

    Flag to disable processing fees

    invoice_delivery string

    Delivery method for initial invoices ("email" or "print" for printed hard-copy)

    Possible values: [print, email]

    dunning_delivery string

    Delivery method for dunning/reminder invoices ("email" or "print" for printed hard-copy via Docsaway, Lob, etc.)

    Possible values: [print, email]

    tax_ident string

    Tax ID #/VAT #

    tags string[]

    A list of tags

Responses​

Object was created successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable

    response

    object

    id integer
Loading...