Get customer
GEThttps://apis.<domain>/customers/:id
Authorization: http
name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`
Get customer.
Authorization Action:
pay:customers:get
Request
Path Parameters
id stringrequired
Query Parameters
expand string[]
Specifies which fields in the response should be expanded.
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
address object
delinquent booleanrequired
When the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice isn't paid by its due date.
email string
The customer's email address.
name string
The customer's full name or business name.
phone string
The customer's phone number.
subscriptions object
The customer's current subscriptions, if any.
id stringrequired
Unique identifier for the object.
created numberrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
{
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postal_code": "string",
"state": "string"
},
"delinquent": true,
"email": "string",
"name": "string",
"phone": "string",
"subscriptions": {},
"id": "string",
"created": 0
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://apis.<domain>/customers/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'