Skip to content

Search customers

POST
/v1/customers/search
curl -X POST "https://api.summerbase.com/v1/customers/search" \
-H "Authorization: Bearer sb_..." \
-H "Content-Type: application/json" \
-d '{
"filter": {
"equals": "paying",
"key": "customer.status"
},
"limit": 10,
"sort": "-mrr"
}'

Search the customers of the project you are working in.

search matches names and email addresses. filter is a condition over what is known about each customer: their own fields, what each source says about them, and their subscriptions and items — see FilterCondition. sort is the customers most recently first seen by a source first unless asked otherwise.

The list briefly lags a write: a customer just created or just changed appears here, under their new values, shortly after. The records themselves are current.

Media typeapplication/json
object
cursor

The next_cursor of the previous page, to read the page after it.

string
expand

Relationships to include in the response instead of fetching separately. A dotted path expands what an expanded record can expand in turn — at most 4 deep, 10 paths a request, and never back to a record already on the path.

Array<string>
<= 10 items
Allowed values: country erasures subscriptions
filter

Only customers the condition matches. A key that names nothing is refused, with what is filterable. A comparison reads the value now unless it names an instant; a list has no period, so window is refused.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not

Matches when the condition does not.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
has_subscription_item

Matches when there is an item that matches the condition — of the subscription the box is in, or of any subscription at the top level. Everything inside is about that one item.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription

Matches when the customer has a subscription that matches the condition. Everything inside is about that one subscription.

object
all

Matches when every condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
any

Matches when at least one condition in the list does. At least one.

Array<object>

A condition over what is known about a customer. Either a group — all or any over a list of conditions, or not over one — a box — has_subscription or has_subscription_item over one condition about one such record — or a comparison: a key beside exactly one operator. At most four levels deep, boxes not counted, twenty-five comparisons, and five boxes, a bare comparison about a subscription or an item counting as one.

A key is fully qualified. subject.field names a field the record carries itself — customer.name, customer.status, customer.mrr, subscription.status, subscription_item.plan_id — and subject.properties.source.key names what one source says about it — customer.properties.hubspot.industry. The subject is customer, subscription or subscription_item. A key that names nothing is refused, with what is filterable.

A value is read as what the key holds — a string, a number, a boolean or a datetime: 5, "5" and "5.000" are one number, "TRUE" is a boolean, a datetime is an ISO 8601 date or date and time — 2026-03-01, 2026-03-01T12:00:00Z — read as UTC when it names no zone, and a number or a boolean sent to a string key is its text. A value that does not read as the key’s kind is refused. customer.mrr is an amount in the project’s reporting currency, and customer.arr and subscription.annual_amount are their monthly amounts times twelve.

Everything inside a box is about the same record: has_subscription over all of “active” and “in euros” is one subscription that is both, and two has_subscription boxes side by side are one of each. A comparison about a subscription or an item outside a box is a box of its own. not around a box means the customer has no such record; not_equals and present: false match when no value says otherwise.

object
all
Array<object> recursive
any
Array<object> recursive
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
at
Any of:
string
Allowed values: window now
contains
Any of:
string
equals
Any of:
string
greater_than
Any of:
number
greater_than_or_equals
Any of:
number
has_subscription
object recursive
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
has_subscription_item
object recursive
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
key

What is compared — customer.status, subscription_item.quantity, customer.properties.hubspot.industry.

string
less_than
Any of:
number
less_than_or_equals
Any of:
number
not
object recursive
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
not_equals
Any of:
string
present

Whether there is any value at all.

boolean
include_total_count

Whether to add total_count, how many records match altogether. On the first page only: it is the same number on every page of one list, so keep the first page’s, and it is refused beside a cursor.

boolean
limit

How many records to return, 1 to 100. Defaults to 20.

integer
default: 20 >= 1 <= 100
search

Only customers whose name or email address contains this.

string
<= 255 characters
sort

The order — -mrr or -arr for the most valuable first, name, -first_paying_at for the newest cohort first, or properties.backend.seats for what a source said.

The order: a key, - before it for descending, commas between up to 3 keys — -created_at, name, -mrr,name. The keys are created_at, name, email, status, signed_up_at, country_code, first_seen_at, first_subscribed_at, first_paying_at, churned_at, mrr, arr, and properties.<source>.<key> for what a source said. Text sorts ignoring case; a record with no value for the key comes last, whichever way the list runs.

string

Example

{
"filter": {
"equals": "paying",
"key": "customer.status"
},
"limit": 10,
"sort": "-mrr"
}

Returns a list of customer objects, a page at a time. See Pagination.

Media typeapplication/json

Example

{
"data": [
{
"arr": "15000.00",
"churned_at": null,
"country_code": "US",
"created_at": "2025-11-03T16:20:04Z",
"email": "billing@northwind.example.com",
"first_paying_at": "2025-12-01T10:04:00Z",
"first_seen_at": "2025-11-03T16:20:00Z",
"first_subscribed_at": "2025-11-17T10:04:00Z",
"id": "0199a7c2-4e1b-7f38-b9d2-5a6c8e0f1d73",
"identities": [
"stripe:cus_QX7bN2kLp4Rt9v",
"backend:acct_4821"
],
"mrr": "1250.00",
"name": "Northwind Labs",
"object": "customer",
"properties": {
"seats": 25
},
"properties_by_source": {
"backend": {
"seats": 25
},
"stripe": {
"email": "billing@northwind.example.com",
"name": "Northwind Labs"
}
},
"signed_up_at": "2025-11-03T16:20:00Z",
"status": "paying"
}
],
"has_more": false,
"next_cursor": null,
"object": "list",
"total_count": 1
}