Get Customer

GET

/api/:account_id/customers/:customer_id

GET

/api/:account_id/customers/:customer_id

$ curl https://app.paymentkit.com/api/account_id/customers/customer_id \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "string",
3   "name": "string",
4   "first_name": "string",
5   "last_name": "string",
6   "email": "string",
7   "phone": "string",
8   "billing_email": "string",
9   "business_name": "string",
10   "address": {
11     "id": "string",
12     "line1": "string",
13     "line2": "string",
14     "line3": "string",
15     "city": "string",
16     "state": "string",
17     "zip_code": "string",
18     "country": "string"
19   },
20   "shipping_address": {
21     "id": "string",
22     "line1": "string",
23     "line2": "string",
24     "line3": "string",
25     "city": "string",
26     "state": "string",
27     "zip_code": "string",
28     "country": "string"
29   },
30   "tax_ids": [
31     "string"
32   ],
33   "currency": "aed",
34   "language": "string",
35   "invoice_settings": {},
36   "total_spent": {
37     "amount_atom": 1,
38     "currency": "aed"
39   },
40   "metadata": {},
41   "created_at": "2024-01-15T09:30:00Z",
42   "updated_at": "2024-01-15T09:30:00Z",
43   "credit_balance": {
44     "amount_atom": 1,
45     "currency": "aed"
46   },
47   "credit_balances": [
48     {
49       "amount_atom": 1,
50       "currency": "aed"
51     }
52   ],
53   "custom_fields": {}
54 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customer_idstringRequired

account_idstringRequired

Query parameters

expandlist of strings or nullOptional

Response

Successful Response

idstring

namestring or null

first_namestring or null

last_namestring or null

emailstring or null

phonestring or null

billing_emailstring or null

business_namestring or null

addressobject or null

shipping_addressobject or null

tax_idslist of strings or null

currencyenum or null

ISO 4217 currency codes.

languagestring or null

invoice_settingsmap from strings to any or null

total_spentobject or null

Cash captured from this customer, minus refunds and chargebacks. Null when no cash was captured — including invoices settled outside the platform and customers who were fully refunded.

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

credit_balanceobject or nullOptional

Primary credit balance (largest currency). Deprecated: use credit_balances.

credit_balanceslist of objects or nullOptional

Credit balances per currency

custom_fieldsmap from strings to any or nullOptional

Custom field values. Only included when expand=custom_fields is specified.

Errors

422

Unprocessable Entity Error