Create a customer

POST {{baseUrl}}/v1/customers

Creates a new customer object.

Request Body

[{"name"=>"address[city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[postal_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"address[state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"balance", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"cash_balance[settings][reconciliation_mode]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"coupon", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"description", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"email", "value"=>"{{email}}", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_prefix", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[custom_fields][0][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[custom_fields][0][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[custom_fields][1][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[custom_fields][1][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[default_payment_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[footer]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_settings[rendering_options][amount_tax_display]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"name", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"next_invoice_sequence", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phone", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"preferred_locales[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"preferred_locales[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"promotion_code", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][postal_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[phone]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"source", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax[ip_address]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_exempt", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_id_data[0][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_id_data[0][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_id_data[1][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_id_data[1][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"test_clock", "value"=>"<string>", "datatype"=>"string"}]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;id&quot;:&quot;cus_NKPbPxZOeEhHO1&quot;,&quot;object&quot;:&quot;customer&quot;,&quot;address&quot;:null,&quot;balance&quot;:0,&quot;created&quot;:1675990078,&quot;currency&quot;:null,&quot;default_source&quot;:null,&quot;delinquent&quot;:false,&quot;description&quot;:null,&quot;discount&quot;:null,&quot;email&quot;:&quot;lenny@example.com&quot;,&quot;invoice_prefix&quot;:&quot;326ECDAF&quot;,&quot;invoice_settings&quot;:{&quot;custom_fields&quot;:null,&quot;default_payment_method&quot;:null,&quot;footer&quot;:null,&quot;rendering_options&quot;:null},&quot;livemode&quot;:false,&quot;metadata&quot;:{},&quot;name&quot;:null,&quot;next_invoice_sequence&quot;:1,&quot;phone&quot;:null,&quot;preferred_locales&quot;:[],&quot;shipping&quot;:null,&quot;tax_exempt&quot;:&quot;none&quot;,&quot;test_clock&quot;:null}