Create a customer

POST 
https://example.chargeover.com/api/v3/customer

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

Request

application/json

Body

parent_customer_id integer

Parent customer ID #

external_key string

External key value

company stringrequired

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 number

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

(Deprecated)

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

(Deprecated)

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 number

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

201

Object was created successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

id integer

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "id": 0
  }
}

Example 1

{
  "code": 201,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "id": 1234
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Authorization: http

name: basictype: httpscheme: basic

• php
• nodejs
• python
• curl
• csharp
• go
• ruby
• java
• powershell
• dart
• c
• objective-c
• ocaml
• r
• swift
• kotlin
• rust

• CURL
• GUZZLE
• HTTP_REQUEST2
• PECL_HTTP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://example.chargeover.com/api/v3/customer',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
  "parent_customer_id": 0,
  "external_key": "string",
  "company": "string",
  "language_id": 0,
  "currency_id": 0,
  "class_id": 0,
  "admin_id": 0,
  "campaign_id": 0,
  "campaign_details": "string",
  "superuser_username": "string",
  "superuser_email": "string",
  "superuser_name": "string",
  "superuser_first_name": "string",
  "superuser_last_name": "string",
  "superuser_phone": "string",
  "bill_addr1": "string",
  "bill_addr2": "string",
  "bill_addr3": "string",
  "bill_city": "string",
  "bill_state": "string",
  "bill_postcode": "string",
  "bill_country": "string",
  "ship_addr1": "string",
  "ship_addr2": "string",
  "ship_addr3": "string",
  "ship_city": "string",
  "ship_state": "string",
  "ship_postcode": "string",
  "ship_country": "string",
  "custom_1": "string",
  "custom_2": "string",
  "custom_3": "string",
  "custom_4": "string",
  "custom_5": "string",
  "custom_6": "string",
  "custom_7": "string",
  "custom_8": "string",
  "custom_9": "string",
  "custom_10": "string",
  "custom_11": "string",
  "custom_12": "string",
  "custom_13": "string",
  "custom_14": "string",
  "custom_15": "string",
  "custom_16": "string",
  "custom_17": "string",
  "custom_18": "string",
  "custom_19": "string",
  "custom_20": "string",
  "brand_id": 0,
  "terms_id": 0,
  "no_taxes": true,
  "no_dunning": true,
  "no_latefees": true,
  "no_procfees": true,
  "invoice_delivery": "print",
  "dunning_delivery": "print",
  "tax_ident": "string",
  "tags": [
    "string"
  ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Accept: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Request Collapse all

Base URL

https://example.chargeover.com

Auth

Username

Password

Body

• Example (from schema)
• Example 1

{
  "parent_customer_id": 0,
  "external_key": "string",
  "company": "string",
  "language_id": 0,
  "currency_id": 0,
  "class_id": 0,
  "admin_id": 0,
  "campaign_id": 0,
  "campaign_details": "string",
  "superuser_username": "string",
  "superuser_email": "string",
  "superuser_name": "string",
  "superuser_first_name": "string",
  "superuser_last_name": "string",
  "superuser_phone": "string",
  "bill_addr1": "string",
  "bill_addr2": "string",
  "bill_addr3": "string",
  "bill_city": "string",
  "bill_state": "string",
  "bill_postcode": "string",
  "bill_country": "string",
  "ship_addr1": "string",
  "ship_addr2": "string",
  "ship_addr3": "string",
  "ship_city": "string",
  "ship_state": "string",
  "ship_postcode": "string",
  "ship_country": "string",
  "custom_1": "string",
  "custom_2": "string",
  "custom_3": "string",
  "custom_4": "string",
  "custom_5": "string",
  "custom_6": "string",
  "custom_7": "string",
  "custom_8": "string",
  "custom_9": "string",
  "custom_10": "string",
  "custom_11": "string",
  "custom_12": "string",
  "custom_13": "string",
  "custom_14": "string",
  "custom_15": "string",
  "custom_16": "string",
  "custom_17": "string",
  "custom_18": "string",
  "custom_19": "string",
  "custom_20": "string",
  "brand_id": 0,
  "terms_id": 0,
  "no_taxes": true,
  "no_dunning": true,
  "no_latefees": true,
  "no_procfees": true,
  "invoice_delivery": "print",
  "dunning_delivery": "print",
  "tax_ident": "string",
  "tags": [
    "string"
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!