List customers

We recommend using the GET /v2/customers endpoint instead.

GET /v1/customers

List customers

cURL

curl --request GET \
  --url https://api.hyperline.co/v1/customers \
  --header 'Authorization: Bearer <token>'

200

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "cus_Typ0px2W0aiEtl",
      "name": "Acme",
      "type": "corporate",
      "status": "active",
      "currency": "EUR",
      "country": "FR",
      "vat_number": "<string>",
      "vat_number_valid": true,
      "vat_rate_custom": 123,
      "tax_ids": [
        {
          "value": "FR123456789",
          "status": "valid"
        }
      ],
      "tax_rate_custom": 50,
      "registration_number": "36252187900034",
      "is_government_affiliated": false,
      "language": "fr",
      "timezone": "Europe/Paris",
      "external_id": null,
      "properties": null,
      "custom_properties": {},
      "billing_address": {
        "name": "Acme",
        "line1": "5 rue de Paradis",
        "line2": null,
        "city": "Paris",
        "zip": "75010",
        "state": "CA",
        "country": "FR"
      },
      "shipping_address": {
        "name": "Acme",
        "line1": "5 rue de Paradis",
        "line2": null,
        "city": "Paris",
        "zip": "75010",
        "state": "CA",
        "country": "FR"
      },
      "billing_email": "[e-mail]",
      "invoice_emails": [
        "[e-mail]"
      ],
      "invoicing_entity_id": "ive_484dn4U48E",
      "invoice_reminders_enabled": true,
      "price_book_id": "prib_613_WbVIZ1329e",
      "available_payment_methods": [
        "card",
        "direct_debit"
      ],
      "current_payment_method_type": "card",
      "current_payment_method_id": "pm_UTclbc1US8GzCe",
      "custom_payment_delay": 30,
      "custom_payment_initiation_delay": 7,
      "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"
        }
      ],
      "segment_ids": [
        "seg_0kIc7jrF7gV00V"
      ],
      "integrations": [
        {
          "entity_id": "123456789",
          "provider_name": "stripe",
          "provider_account_id": "acc_1234567890"
        }
      ],
      "created_at": "2024-10-12T07:00:01.860Z",
      "updated_at": "2024-10-12T07:00:01.860Z",
      "deleted_at": null
    }
  ]
}

Authorizations

Authorization · string · header · required

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

name · string

name__not · string

name__isNull · string

name__isNotNull · string

name__equals · string

name__contains · string

name__startsWith · string

name__endWith · string

type · enum<string> string

Available options: corporate, person

type__in · enum<string> string

Available options: corporate, person

status · enum<string> string

Available options: all, active, inactive, imported, archived

status__in · enum<string> string

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

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

search · string

tax_id · string

tax_id__not · string

tax_id__isNull · string

tax_id__isNotNull · string

tax_id__equals · string

tax_id__contains · string

tax_id__startsWith · string

tax_id__endWith · string

subscription_status · enum<string> string

Available options: active, pending, cancelled, paused, trialing, errored, draft, none

subscription_status__in · enum<string> string

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

segment_id · string

custom_properties · string

payment_method_type · enum<string> string

Available options: card, direct_debit, direct_debit_ach, direct_debit_bacs, transfer, external, missing, errored

payment_method_type__in · enum<string> string

Available options: card, direct_debit, direct_debit_ach, direct_debit_bacs, transfer, external, missing, errored

integration_entity_id · string

created_at · string<date-time>

created_at__not · string<date-time>

created_at__isNull · string<date-time>

created_at__isNotNull · string<date-time>

created_at__equals · string<date-time>

created_at__lt · string<date-time>

created_at__lte · string<date-time>

created_at__gt · string<date-time>

created_at__gte · string<date-time>

updated_at · string<date-time>

updated_at__not · string<date-time>

updated_at__isNull · string<date-time>

updated_at__isNotNull · string<date-time>

updated_at__equals · string<date-time>

updated_at__lt · string<date-time>

updated_at__lte · string<date-time>

updated_at__gt · string<date-time>

updated_at__gte · string<date-time>

Response

200 - application/json

meta · object · required

Show child attributes

data · object[] · required

List of CustomerV1.

Show child attributes