GET
/
v1
/
customers
/
{id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

Customer ID.

name
string
required

Customer legal name.

type
enum<string> | null
required

Customer type.

  • corporate: The customer is a business entity.
  • person: The customer is a natural person.
  • automatically_created: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
Available options:
corporate,
person,
automatically_created
status
enum<string>
required

Customer status.

Available options:
active,
archived
currency
enum<string> | null
required

Currency code. See ISO 4217.

Available options:
EUR,
AED,
AFN,
XCD,
ALL,
AMD,
AOA,
ARS,
USD,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
XOF,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
NOK,
BWP,
BYR,
BZD,
CAD,
CDF,
XAF,
CHF,
NZD,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
ANG,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
MAD,
ERN,
ETB,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
XPF,
NGN,
NIO,
NPR,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STD,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
UYU,
UZS,
VEF,
VND,
VUV,
WST,
YER,
ZAR,
ZMW,
ZWL
country
enum<string> | null
required

Two-letter country code in ISO format. See ISO 3166 Alpha 2.

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XK,
YE,
YT,
ZA,
ZM,
ZW
vat_number
string | null
required

Customer tax number.

vat_number_valid
boolean
required

Indicates customer's tax number validity.

vat_rate_custom
number | null
required

Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.

language
enum<string> | null
required

Language used for invoices, emails, and hosted pages.

Available options:
fr,
en,
de,
it,
nl,
es,
pt,
pl
timezone
enum<string> | null
required

Customer timezone.

Available options:
Pacific/Niue,
Pacific/Midway,
Pacific/Pago_Pago,
Pacific/Rarotonga,
America/Adak,
Pacific/Honolulu,
Pacific/Tahiti,
Pacific/Marquesas,
America/Anchorage,
Pacific/Gambier,
America/Los_Angeles,
America/Tijuana,
America/Vancouver,
Pacific/Pitcairn,
America/Hermosillo,
America/Edmonton,
America/Ciudad_Juarez,
America/Denver,
America/Phoenix,
America/Whitehorse,
America/Belize,
America/Chicago,
America/Guatemala,
America/Managua,
America/Mexico_City,
America/Matamoros,
America/Costa_Rica,
America/El_Salvador,
America/Regina,
America/Tegucigalpa,
America/Winnipeg,
Pacific/Galapagos,
America/Rio_Branco,
America/Bogota,
America/Havana,
Pacific/Easter,
America/Atikokan,
America/Cancun,
America/Grand_Turk,
America/Cayman,
America/Jamaica,
America/Nassau,
America/New_York,
America/Panama,
America/Port-au-Prince,
America/Toronto,
America/Guayaquil,
America/Lima,
America/Manaus,
America/St_Kitts,
America/Blanc-Sablon,
America/Montserrat,
America/Barbados,
America/St_Lucia,
America/Port_of_Spain,
America/Martinique,
America/St_Barthelemy,
America/Halifax,
Atlantic/Bermuda,
America/St_Vincent,
America/Kralendijk,
America/Guadeloupe,
America/Marigot,
America/Aruba,
America/Lower_Princes,
America/Tortola,
America/Dominica,
America/St_Thomas,
America/Grenada,
America/Antigua,
America/Puerto_Rico,
America/Santo_Domingo,
America/Anguilla,
America/Thule,
America/Curacao,
America/La_Paz,
America/Guyana,
America/Caracas,
America/St_Johns,
America/Argentina/Buenos_Aires,
America/Sao_Paulo,
Antarctica/Palmer,
America/Punta_Arenas,
America/Santiago,
Atlantic/Stanley,
America/Cayenne,
America/Asuncion,
America/Miquelon,
America/Paramaribo,
America/Montevideo,
America/Scoresbysund,
America/Noronha,
Atlantic/South_Georgia,
America/Nuuk,
Atlantic/Azores,
Atlantic/Cape_Verde,
Etc/UTC,
Africa/Abidjan,
Africa/Bamako,
Africa/Bissau,
Africa/Conakry,
Africa/Dakar,
America/Danmarkshavn,
Europe/Isle_of_Man,
Europe/Dublin,
Africa/Freetown,
Atlantic/St_Helena,
Africa/Accra,
Africa/Lome,
Europe/London,
Africa/Monrovia,
Africa/Nouakchott,
Africa/Ouagadougou,
Atlantic/Reykjavik,
Europe/Jersey,
Europe/Guernsey,
Africa/Sao_Tome,
Africa/Banjul,
Antarctica/Troll,
Atlantic/Canary,
Europe/Lisbon,
Atlantic/Faroe,
Africa/Algiers,
Europe/Amsterdam,
Europe/Andorra,
Europe/Belgrade,
Europe/Berlin,
Europe/Bratislava,
Europe/Brussels,
Europe/Budapest,
Europe/Copenhagen,
Europe/Gibraltar,
Europe/Ljubljana,
Arctic/Longyearbyen,
Europe/Luxembourg,
Europe/Madrid,
Europe/Monaco,
Europe/Oslo,
Europe/Paris,
Europe/Podgorica,
Europe/Prague,
Europe/Rome,
Europe/San_Marino,
Europe/Malta,
Europe/Sarajevo,
Europe/Skopje,
Europe/Stockholm,
Europe/Tirane,
Africa/Tunis,
Europe/Vaduz,
Europe/Vatican,
Europe/Vienna,
Europe/Warsaw,
Europe/Zagreb,
Europe/Zurich,
Africa/Bangui,
Africa/Malabo,
Africa/Brazzaville,
Africa/Porto-Novo,
Africa/Douala,
Africa/Kinshasa,
Africa/Lagos,
Africa/Libreville,
Africa/Luanda,
Africa/Ndjamena,
Africa/Niamey,
Africa/Casablanca,
Africa/El_Aaiun,
Africa/Bujumbura,
Africa/Gaborone,
Africa/Harare,
Africa/Juba,
Africa/Khartoum,
Africa/Kigali,
Africa/Blantyre,
Africa/Lubumbashi,
Africa/Lusaka,
Africa/Maputo,
Africa/Windhoek,
Europe/Athens,
Asia/Beirut,
Europe/Bucharest,
Africa/Cairo,
Europe/Chisinau,
Asia/Hebron,
Europe/Helsinki,
Europe/Kaliningrad,
Europe/Kyiv,
Europe/Mariehamn,
Asia/Nicosia,
Europe/Riga,
Europe/Sofia,
Europe/Tallinn,
Africa/Tripoli,
Europe/Vilnius,
Asia/Jerusalem,
Africa/Johannesburg,
Africa/Mbabane,
Africa/Maseru,
Asia/Kuwait,
Asia/Bahrain,
Asia/Baghdad,
Asia/Qatar,
Asia/Riyadh,
Asia/Aden,
Asia/Amman,
Asia/Damascus,
Africa/Addis_Ababa,
Indian/Antananarivo,
Africa/Asmara,
Africa/Dar_es_Salaam,
Africa/Djibouti,
Africa/Kampala,
Indian/Mayotte,
Africa/Mogadishu,
Indian/Comoro,
Africa/Nairobi,
Europe/Minsk,
Europe/Moscow,
Europe/Simferopol,
Antarctica/Syowa,
Europe/Istanbul,
Asia/Tehran,
Asia/Yerevan,
Asia/Baku,
Asia/Tbilisi,
Asia/Dubai,
Asia/Muscat,
Indian/Mauritius,
Indian/Reunion,
Europe/Samara,
Indian/Mahe,
Asia/Kabul,
Asia/Almaty,
Indian/Kerguelen,
Indian/Maldives,
Antarctica/Mawson,
Asia/Karachi,
Asia/Dushanbe,
Asia/Ashgabat,
Asia/Tashkent,
Antarctica/Vostok,
Asia/Aqtobe,
Asia/Yekaterinburg,
Asia/Colombo,
Asia/Kolkata,
Asia/Kathmandu,
Asia/Dhaka,
Asia/Thimphu,
Asia/Urumqi,
Indian/Chagos,
Asia/Bishkek,
Asia/Omsk,
Indian/Cocos,
Asia/Yangon,
Indian/Christmas,
Antarctica/Davis,
Asia/Hovd,
Asia/Bangkok,
Asia/Ho_Chi_Minh,
Asia/Phnom_Penh,
Asia/Vientiane,
Asia/Novosibirsk,
Asia/Jakarta,
Australia/Perth,
Asia/Brunei,
Antarctica/Casey,
Asia/Makassar,
Asia/Macau,
Asia/Shanghai,
Asia/Hong_Kong,
Asia/Irkutsk,
Asia/Kuala_Lumpur,
Asia/Manila,
Asia/Singapore,
Asia/Taipei,
Asia/Ulaanbaatar,
Australia/Eucla,
Asia/Dili,
Asia/Jayapura,
Asia/Tokyo,
Asia/Pyongyang,
Asia/Seoul,
Pacific/Palau,
Asia/Chita,
Australia/Darwin,
Australia/Brisbane,
Pacific/Guam,
Pacific/Saipan,
Pacific/Chuuk,
Antarctica/DumontDUrville,
Pacific/Port_Moresby,
Asia/Vladivostok,
Australia/Adelaide,
Australia/Sydney,
Pacific/Bougainville,
Pacific/Kosrae,
Australia/Lord_Howe,
Pacific/Noumea,
Asia/Sakhalin,
Pacific/Guadalcanal,
Pacific/Efate,
Pacific/Fiji,
Pacific/Tarawa,
Pacific/Majuro,
Pacific/Nauru,
Pacific/Norfolk,
Asia/Kamchatka,
Pacific/Funafuti,
Pacific/Wake,
Pacific/Wallis,
Pacific/Apia,
Pacific/Auckland,
Antarctica/McMurdo,
Pacific/Kanton,
Pacific/Fakaofo,
Pacific/Tongatapu,
Pacific/Chatham,
Pacific/Kiritimati
external_id
string | null
required

ID of the customer in your system. This helps matching your customer with the one on Hyperline.

properties
object | null
required

Key/value pairs to store any information you find useful.

custom_properties
object | null
required

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

billing_address
object
required

Address of the default invoicing entity

billing_email
string | null
required

Email to which all communications will be sent.

invoice_emails
string[]
required

Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the billing_email; otherwise, they won't be sent to the billing_email.

invoicing_entity_id
string
required

ID of the invoicing entity this customer will be attached to.

invoice_reminders_enabled
required

Indicates if invoice reminders are enabled for the customer.

available_payment_methods
enum<string>[]
required

List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.

Available options:
card,
direct_debit,
direct_debit_ach,
direct_debit_bacs,
transfer,
transfer_automated
current_payment_method_type
enum<string> | null
required

Default payment method type used to pay subscriptions and one-off invoices.

Available options:
card,
direct_debit,
direct_debit_ach,
direct_debit_bacs,
transfer,
transfer_automated,
external
current_payment_method_id
string | null
required

ID of the default payment method of the customer. Only applies to card and direct debit.

custom_payment_delay
number | null
required

Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.

subscriptions
object[]
required
created_at
string
required

Customer creation date. UTC date time string in the ISO 8601 format.

updated_at
string
required

Customer last edition date. UTC date time string in the ISO 8601 format.

deleted_at
string
required

UTC date time string in the ISO 8601 format.

providers
object
required

Provider/ID mapping of the customer in the related providers. Provider (key) can be gocardless, mollie, stripe, hubspot, salesforce.

current_payment_method
object | null
required

Default payment method of the customer. Only applies to card and direct debit.

bank_account
object | null
required

Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.

organisation_id
string | null
required

Parent organization ID to which the client is attached.

organisation_invoicing
enum<string> | null
required

How customer invoices are issued from the parent organisation.

  • none: Invoices will keep being issued from this customer.
  • every_invoice: Customer invoices will be issued from the organisation individually.
  • concat: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
Available options:
none,
every_invoice,
concat

Was this page helpful?

Create customerUpdate customer