Get customers

GET

customers

take

number

skip

number

string

id__not

string

id__isNull

string

id__isNotNull

string

id__equals

string

id__contains

string

id__startsWith

string

id__endWith

string

name

string

name__not

string

name__isNull

string

name__isNotNull

string

name__equals

string

name__contains

string

name__startsWith

string

name__endWith

string

type

string

type__not

string

type__isNull

string

type__isNotNull

string

type__equals

string

type__contains

string

type__startsWith

string

type__endWith

string

status

enum<string>

status__in

enum<string>

status__notIn

enum<string>

currency

string

currency__not

string

currency__isNull

string

currency__isNotNull

string

currency__equals

string

currency__contains

string

currency__startsWith

string

currency__endWith

string

country

string

country__not

string

country__isNull

string

country__isNotNull

string

country__equals

string

country__contains

string

country__startsWith

string

country__endWith

string

vat_number

string

vat_number__not

string

vat_number__isNull

string

vat_number__isNotNull

string

vat_number__equals

string

vat_number__contains

string

vat_number__startsWith

string

vat_number__endWith

string

external_id

string

external_id__not

string

external_id__isNull

string

external_id__isNotNull

string

external_id__equals

string

external_id__contains

string

external_id__startsWith

string

external_id__endWith

string

billing_email

string

billing_email__not

string

billing_email__isNull

string

billing_email__isNotNull

string

billing_email__equals

string

billing_email__contains

string

billing_email__startsWith

string

billing_email__endWith

string

subscription_status

enum<string>

subscription_status__in

enum<string>

subscription_status__notIn

enum<string>

invoicing_entity_id

string

invoicing_entity_id__not

string

invoicing_entity_id__isNull

string

invoicing_entity_id__isNotNull

string

invoicing_entity_id__equals

string

invoicing_entity_id__contains

string

invoicing_entity_id__startsWith

string

invoicing_entity_id__endWith

string

created_at

string

created_at__not

string

created_at__isNull

string

created_at__isNotNull

string

created_at__equals

string

created_at__lt

string

created_at__lte

string

created_at__gt

string

created_at__gte

string

updated_at

string

updated_at__not

string

updated_at__isNull

string

updated_at__isNotNull

string

updated_at__equals

string

updated_at__lt

string

updated_at__lte

string

updated_at__gt

string

updated_at__gte

string

Authorizations

Authorization

string

headerrequired

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

Query Parameters

take

number | null

default: 50

Required range: 0 < x < 100

skip

number | null

default: 0

Required range: x > 0

string

id__not

string

id__isNull

string

id__isNotNull

string

id__equals

string

id__contains

string

id__startsWith

string

id__endWith

string

name

string

name__not

string

name__isNull

string

name__isNotNull

string

name__equals

string

name__contains

string

name__startsWith

string

name__endWith

string

type

string

type__not

string

type__isNull

string

type__isNotNull

string

type__equals

string

type__contains

string

type__startsWith

string

type__endWith

string

status

Available options:

all,

active,

inactive,

imported,

archived

status__in

Available options:

all,

active,

inactive,

imported,

archived

status__notIn

Available options:

all,

active,

inactive,

imported,

archived

currency

string

currency__not

string

currency__isNull

string

currency__isNotNull

string

currency__equals

string

currency__contains

string

currency__startsWith

string

currency__endWith

string

country

string

country__not

string

country__isNull

string

country__isNotNull

string

country__equals

string

country__contains

string

country__startsWith

string

country__endWith

string

vat_number

string

vat_number__not

string

vat_number__isNull

string

vat_number__isNotNull

string

vat_number__equals

string

vat_number__contains

string

vat_number__startsWith

string

vat_number__endWith

string

external_id

string

external_id__not

string

external_id__isNull

string

external_id__isNotNull

string

external_id__equals

string

external_id__contains

string

external_id__startsWith

string

external_id__endWith

string

billing_email

string

billing_email__not

string

billing_email__isNull

string

billing_email__isNotNull

string

billing_email__equals

string

billing_email__contains

string

billing_email__startsWith

string

billing_email__endWith

string

subscription_status

Available options:

active,

pending,

cancelled,

paused,

trialing,

errored,

draft,

none

subscription_status__in

Available options:

active,

pending,

cancelled,

paused,

trialing,

errored,

draft,

none

subscription_status__notIn

Available options:

active,

pending,

cancelled,

paused,

trialing,

errored,

draft,

none

invoicing_entity_id

string

invoicing_entity_id__not

string

invoicing_entity_id__isNull

string

invoicing_entity_id__isNotNull

string

invoicing_entity_id__equals

string

invoicing_entity_id__contains

string

invoicing_entity_id__startsWith

string

invoicing_entity_id__endWith

string

created_at

string

created_at__not

string

created_at__isNull

string

created_at__isNotNull

string

created_at__equals

string

created_at__lt

string

created_at__lte

string

created_at__gt

string

created_at__gte

string

updated_at

string

updated_at__not

string

updated_at__isNull

string

updated_at__isNotNull

string

updated_at__equals

string

updated_at__lt

string

updated_at__lte

string

updated_at__gt

string

updated_at__gte

string

Response

200 - application/json

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Authorizations

Query Parameters

Response