Get a specific customer

GET 
/api/v3/customer/:customer_id

Get a specific customer using their customer_id.

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

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

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "superuser_id": 364,
    "external_key": null,
    "token": "fozdqj169569",
    "company": "Karli Marie",
    "bill_addr1": "56 Wintergreen Street",
    "bill_addr2": "",
    "bill_addr3": "",
    "bill_city": "Hamden",
    "bill_state": "CT",
    "bill_postcode": "06517",
    "bill_country": "United States",
    "bill_notes": null,
    "ship_addr1": null,
    "ship_addr2": null,
    "ship_addr3": null,
    "ship_city": null,
    "ship_state": null,
    "ship_postcode": null,
    "ship_country": null,
    "ship_notes": null,
    "terms_id": 3,
    "class_id": 0,
    "custom_1": "",
    "custom_2": null,
    "custom_3": null,
    "custom_4": null,
    "custom_5": null,
    "custom_6": null,
    "admin_id": 4,
    "campaign_id": 0,
    "currency_id": 1,
    "language_id": 1,
    "brand_id": 1,
    "default_paymethod": "crd",
    "default_creditcard_id": 51,
    "default_ach_id": null,
    "no_taxes": false,
    "no_dunning": false,
    "write_datetime": "2017-05-18 09:36:19",
    "write_ipaddr": "130.215.123.7",
    "mod_datetime": "2017-12-01 21:37:50",
    "mod_ipaddr": "192.168.21.14",
    "terms_name": "Due on Receipt",
    "terms_days": 0,
    "class_name": "",
    "paid": 1145.46,
    "total": 2656.11,
    "balance": 1510.65,
    "url_paymethodlink": "https://dev.chargeover.com/r/paymethod/i/fozdqj169569",
    "url_self": "https://dev.chargeover.com/admin/r/customer/view/16",
    "admin_name": "ChargeOver Support",
    "admin_email": "support@chargeover.com",
    "currency_symbol": "$",
    "currency_iso4217": "USD",
    "display_as": "Karli Marie",
    "ship_block": "",
    "bill_block": "56 Wintergreen Street\nHamden CT 06517\nUnited States",
    "superuser_name": "Karli Marie",
    "superuser_first_name": "Karli",
    "superuser_last_name": "Marie",
    "superuser_phone": "860-249-1317",
    "superuser_email": "karli@chargeover.com",
    "superuser_token": "1892mske1j64",
    "customer_id": 16,
    "parent_customer_id": null,
    "invoice_delivery": "email",
    "dunning_delivery": "email",
    "customer_status_id": 2,
    "customer_status_name": "Over Due",
    "customer_status_str": "active-overdue",
    "customer_status_state": "a",
    "superuser_username": "QATPM1zD4CLE",
    "tags": [
      "tag1",
      "tag2"
    ]
  }
}

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
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

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

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...