GET
/
v1
/
customers
curl --request GET \
  --url https://api.hyperline.co/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 123
  },
  "data": [
    {
      "id": "cus_Typ0px2W0aiEtl",
      "name": "Acme",
      "type": "corporate",
      "status": "active",
      "currency": "EUR",
      "country": "FR",
      "vat_number": "FR123456789",
      "vat_number_valid": true,
      "vat_rate_custom": 123,
      "language": "fr",
      "external_id": "<string>",
      "properties": "<string>",
      "custom_properties": {},
      "billing_address": {
        "name": "Acme",
        "line1": "5 rue de Paradis",
        "line2": "<string>",
        "city": "Paris",
        "zip": "75010",
        "state": "<string>",
        "country": "FR"
      },
      "billing_email": "billing@acme.com",
      "invoice_emails": [
        "accounting@acme.com"
      ],
      "invoicing_entity_id": "ive_484dn4U48E",
      "available_payment_methods": [
        "card",
        "direct_debit"
      ],
      "current_payment_method_type": "card",
      "current_payment_method_id": "pm_UTclbc1US8GzCe",
      "transaction_provider_id": "<string>",
      "subscriptions": [
        {
          "id": "sub_0kIc7jrF7gV00V",
          "status": "active",
          "current_period_started_at": "2024-10-12T07:00:01.860Z",
          "current_period_ends_at": "2024-11-12T07:00:01.860Z",
          "plan_id": "plan_34hdd843hReh",
          "checkout_session_id": "che_949djdj39RJj"
        }
      ],
      "created_at": "2024-10-12T07:00:01.860Z",
      "updated_at": "2024-10-12T07:00:01.860Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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
skip
number | null
default: 0
id
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
subscriptionStatus
Available options:
active,
pending,
cancelled,
paused,
trialing,
errored,
draft,
none
subscriptionStatus__in
Available options:
active,
pending,
cancelled,
paused,
trialing,
errored,
draft,
none
subscriptionStatus__notIn
Available options:
active,
pending,
cancelled,
paused,
trialing,
errored,
draft,
none
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
deleted_at
string
deleted_at__not
string
deleted_at__isNull
string
deleted_at__isNotNull
string
deleted_at__equals
string
deleted_at__lt
string
deleted_at__lte
string
deleted_at__gt
string
deleted_at__gte
string

Response

200 - application/json
meta
object
required
data
object[]
required

List of Customer.