Customers
Get customers
Customers
Wallets
Invoices
Entitlements
Environments
Events
Features
Payments
Integrations
Subscriptions
Tenants
Users
Customers
Get customers
Get customers
GET
/
customers
curl --request GET \
--url https://api.cloud.flexprice.io/v1/customers \
--header 'x-api-key: <api-key>'
{
"items": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"address_postal_code": "<string>",
"address_state": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"email": "<string>",
"environment_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"status": "published",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}
Authorizations
Enter your API key in the format x-api-key <api-key>*
Query Parameters
Required range:
1 <= x <= 1000
Required range:
x >= 0
Available options:
asc
, desc
Available options:
published
, deleted
, archived
Response
200
application/json
OK
The response is of type object
.
curl --request GET \
--url https://api.cloud.flexprice.io/v1/customers \
--header 'x-api-key: <api-key>'
{
"items": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"address_postal_code": "<string>",
"address_state": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"email": "<string>",
"environment_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"status": "published",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}