Reference
- Pricing
- Checkout
- Contracts
- Credits
- Customer Dashboards
- Customers
- Entitlements
- Events
- Invoices
- Objects
- One-Time
- Payments
- Metrics
- Subscriptions
Customers
Find Customers
Search customers with given parameters
POST
/
companies
/
{company_id}
/
customers
/
find
curl --request POST \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/customers/find \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"include_meta": true,
"pagination": {
"from_key": "<string>",
"limit": 20
},
"query": {
"email": "<string>",
"exclude_from_metrics": true,
"identifier": "<string>",
"managed_externally": true,
"mrr": {
"eq": 123,
"gte": 123,
"lte": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": "<string>",
"parent_customer_id": "<string>",
"phone": "<string>",
"search": "<string>",
"status": "ACTIVE",
"statuses": [
"<string>"
],
"title": "<string>"
},
"sort_key": "createdAtDesc"
}'
{
"pagination": {
"from_key": "<string>",
"limit": 123
},
"results": [
{
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"country": "<string>",
"place_id": "<string>",
"state": "<string>",
"zip": "<string>"
},
"arr": {
"currency": "<string>",
"value_in_cents": 123
},
"company_id": "<string>",
"computed_entitlements": [
{
"entitlement_id": "<string>",
"inherited_from_id": "<string>",
"inherited_from_type": "<string>",
"key": "<string>",
"name": "<string>",
"original_value": "<any>",
"overridden": true,
"type": "<string>",
"value": "<any>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"customer_integration_metadata": {},
"email": "<string>",
"exclude_from_metrics": true,
"id": "<string>",
"identifier": "<string>",
"locale": "<string>",
"managed_externally": true,
"metadata": {},
"mrr": {
"currency": "<string>",
"value_in_cents": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": "<string>",
"parent_customer_id": "<string>",
"phone": "<string>",
"status": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The idempotency key that will be used to ensure the request is only performed once
Path Parameters
Company ID. It should have a prefix 'cmp_'.
Body
application/json
Response
200 - application/json
OK
The response is of type object
.
curl --request POST \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/customers/find \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"include_meta": true,
"pagination": {
"from_key": "<string>",
"limit": 20
},
"query": {
"email": "<string>",
"exclude_from_metrics": true,
"identifier": "<string>",
"managed_externally": true,
"mrr": {
"eq": 123,
"gte": 123,
"lte": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": "<string>",
"parent_customer_id": "<string>",
"phone": "<string>",
"search": "<string>",
"status": "ACTIVE",
"statuses": [
"<string>"
],
"title": "<string>"
},
"sort_key": "createdAtDesc"
}'
{
"pagination": {
"from_key": "<string>",
"limit": 123
},
"results": [
{
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"country": "<string>",
"place_id": "<string>",
"state": "<string>",
"zip": "<string>"
},
"arr": {
"currency": "<string>",
"value_in_cents": 123
},
"company_id": "<string>",
"computed_entitlements": [
{
"entitlement_id": "<string>",
"inherited_from_id": "<string>",
"inherited_from_type": "<string>",
"key": "<string>",
"name": "<string>",
"original_value": "<any>",
"overridden": true,
"type": "<string>",
"value": "<any>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"customer_integration_metadata": {},
"email": "<string>",
"exclude_from_metrics": true,
"id": "<string>",
"identifier": "<string>",
"locale": "<string>",
"managed_externally": true,
"metadata": {},
"mrr": {
"currency": "<string>",
"value_in_cents": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": "<string>",
"parent_customer_id": "<string>",
"phone": "<string>",
"status": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.