API documentation
Integrations
Analytics
Bank Accounts
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTRenew subscription
- POSTSimulate subscription updates
- POSTTransition subscription to next phase
Subscriptions > Templates
Third-party apps
Wallets
Create customers batch
Copy
Ask AI
curl --request POST \
--url https://api.hyperline.co/v1/customers/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customers": [
{
"batch_customer_id": "customer-123",
"name": "Acme",
"type": "corporate",
"currency": "EUR",
"country": "FR",
"is_government_affiliated": false,
"vat_number": "FR123456789",
"vat_rate_custom": 50,
"registration_number": "36252187900034",
"external_id": "<string>",
"invoicing_entity_id": "<string>",
"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": "[email protected]",
"invoice_emails": [
"[email protected]"
],
"language": "fr",
"timezone": "Europe/Paris",
"available_payment_methods": [
"card",
"direct_debit"
],
"payment_method_type": "card",
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"custom_payment_delay": 30,
"organisation_id": "<string>",
"organisation_invoicing": "none",
"properties": {},
"custom_properties": {},
"invoice_reminders_enabled": true
}
]
}
'Copy
Ask AI
{
"successes": [
{
"id": "cus_Typ0px2W0aiEtl",
"name": "Acme",
"type": "corporate",
"status": "active",
"currency": "EUR",
"country": "FR",
"vat_number": "FR123456789",
"vat_number_valid": true,
"vat_rate_custom": null,
"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": "[email protected]",
"invoice_emails": [
"[email protected]"
],
"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,
"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"
}
],
"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,
"providers": {
"stripe": "<string>",
"mollie": "<string>",
"gocardless": "<string>",
"airwallex": "<string>",
"salesforce": "<string>",
"hubspot": "<string>",
"attio": "<string>",
"xero": "<string>",
"pennylane": "<string>",
"exact-online": "<string>",
"quickbooks": "<string>",
"netsuite": "<string>",
"anrok": "<string>"
},
"current_payment_method": {
"id": "pm_1xMpj5bwRqN7LM",
"status": "active",
"type": "card",
"last_4_digits": 2718,
"expiration_date": "2027-11",
"brand": "<string>"
},
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"organisation_id": null,
"organisation_invoicing": null,
"batch_customer_id": "customer-123"
}
],
"errors": [
{
"batch_customer_id": "<string>",
"customer_payload": {
"name": "Acme",
"type": "corporate",
"currency": "EUR",
"country": "FR",
"is_government_affiliated": false,
"vat_number": "FR123456789",
"vat_rate_custom": 50,
"registration_number": "36252187900034",
"external_id": "<string>",
"invoicing_entity_id": "<string>",
"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": "[email protected]",
"invoice_emails": [
"[email protected]"
],
"language": "fr",
"timezone": "Europe/Paris",
"available_payment_methods": [
"card",
"direct_debit"
],
"payment_method_type": "card",
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"custom_payment_delay": 30,
"organisation_id": "<string>",
"organisation_invoicing": "none",
"properties": {},
"custom_properties": {},
"invoice_reminders_enabled": true
},
"error": "<unknown>"
}
]
}Customers
Create customers batch
Create a batch of new customers.
POST
/
v1
/
customers
/
batch
Create customers batch
Copy
Ask AI
curl --request POST \
--url https://api.hyperline.co/v1/customers/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customers": [
{
"batch_customer_id": "customer-123",
"name": "Acme",
"type": "corporate",
"currency": "EUR",
"country": "FR",
"is_government_affiliated": false,
"vat_number": "FR123456789",
"vat_rate_custom": 50,
"registration_number": "36252187900034",
"external_id": "<string>",
"invoicing_entity_id": "<string>",
"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": "[email protected]",
"invoice_emails": [
"[email protected]"
],
"language": "fr",
"timezone": "Europe/Paris",
"available_payment_methods": [
"card",
"direct_debit"
],
"payment_method_type": "card",
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"custom_payment_delay": 30,
"organisation_id": "<string>",
"organisation_invoicing": "none",
"properties": {},
"custom_properties": {},
"invoice_reminders_enabled": true
}
]
}
'Copy
Ask AI
{
"successes": [
{
"id": "cus_Typ0px2W0aiEtl",
"name": "Acme",
"type": "corporate",
"status": "active",
"currency": "EUR",
"country": "FR",
"vat_number": "FR123456789",
"vat_number_valid": true,
"vat_rate_custom": null,
"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": "[email protected]",
"invoice_emails": [
"[email protected]"
],
"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,
"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"
}
],
"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,
"providers": {
"stripe": "<string>",
"mollie": "<string>",
"gocardless": "<string>",
"airwallex": "<string>",
"salesforce": "<string>",
"hubspot": "<string>",
"attio": "<string>",
"xero": "<string>",
"pennylane": "<string>",
"exact-online": "<string>",
"quickbooks": "<string>",
"netsuite": "<string>",
"anrok": "<string>"
},
"current_payment_method": {
"id": "pm_1xMpj5bwRqN7LM",
"status": "active",
"type": "card",
"last_4_digits": 2718,
"expiration_date": "2027-11",
"brand": "<string>"
},
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"organisation_id": null,
"organisation_invoicing": null,
"batch_customer_id": "customer-123"
}
],
"errors": [
{
"batch_customer_id": "<string>",
"customer_payload": {
"name": "Acme",
"type": "corporate",
"currency": "EUR",
"country": "FR",
"is_government_affiliated": false,
"vat_number": "FR123456789",
"vat_rate_custom": 50,
"registration_number": "36252187900034",
"external_id": "<string>",
"invoicing_entity_id": "<string>",
"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": "[email protected]",
"invoice_emails": [
"[email protected]"
],
"language": "fr",
"timezone": "Europe/Paris",
"available_payment_methods": [
"card",
"direct_debit"
],
"payment_method_type": "card",
"bank_account": {
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
},
"custom_payment_delay": 30,
"organisation_id": "<string>",
"organisation_invoicing": "none",
"properties": {},
"custom_properties": {},
"invoice_reminders_enabled": true
},
"error": "<unknown>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Create customers batch payload
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
A unique identifier for the customers in the batch
Example:
"customer-123"
Customer name.
Example:
"Acme"
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 Example:
"corporate"
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 Example:
"EUR"
Deprecated field, please use billing_address.country.
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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Indicates if the customer is affiliated with a government entity.
Example:
false
Customer tax ID.
Example:
"FR123456789"
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.
Required range:
0 <= x <= 100Customer registration number.
Example:
"36252187900034"
ID of the customer in your system. This helps matching your customer with the one on Hyperline.
ID of the invoicing entity this customer will be attached to.
Customer billing address.
Show child attributes
Show child attributes
Address name.
Example:
"Acme"
Address first line.
Example:
"5 rue de Paradis"
Address second line (optional).
Example:
null
Address city.
Example:
"Paris"
Address ZIP code.
Example:
"75010"
Only for US country. Second part of subdivision code in ISO format. See ISO 3166-2:US.
Available options:
AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY Example:
"CA"
Two-letter country code in ISO format. See ISO 3166-1 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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Customer shipping address.
Show child attributes
Show child attributes
Address name.
Example:
"Acme"
Address first line.
Example:
"5 rue de Paradis"
Address second line (optional).
Example:
null
Address city.
Example:
"Paris"
Address ZIP code.
Example:
"75010"
Only for US country. Second part of subdivision code in ISO format. See ISO 3166-2:US.
Available options:
AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY Example:
"CA"
Two-letter country code in ISO format. See ISO 3166-1 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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Email to which all communications will be sent.
Example:
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.
Example:
Language used for invoices, emails, and hosted pages.
Available options:
fr, en, de, it, nl, es, pt, pl Example:
"fr"
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 Example:
"Europe/Paris"
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, apple_pay, google_pay, direct_debit, direct_debit_ach, direct_debit_bacs, stripe_link, transfer, transfer_automated Example:
["card", "direct_debit"]Default payment method type used to pay subscriptions and one-off invoices.
Available options:
card, apple_pay, google_pay, direct_debit, direct_debit_ach, direct_debit_bacs, stripe_link, transfer, transfer_automated, external Example:
"card"
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.
- Option 1
- Option 2
- Option 3
- Option 4
Example:
{
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
}Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.
Example:
30
Parent organization ID to which the client is attached.
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 Indicates if invoice reminders are enabled for the customer.
Response
201 - application/json
Show child attributes
Show child attributes
Customer ID.
Example:
"cus_Typ0px2W0aiEtl"
Customer name.
Example:
"Acme"
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 Example:
"corporate"
Customer status.
Available options:
active, archived Example:
"active"
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 Example:
"EUR"
Two-letter country code in ISO format. See ISO 3166-1 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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Customer tax ID.
Example:
"FR123456789"
Indicates customer's tax ID validity.
Example:
true
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.
Example:
null
Customer registration number.
Example:
"36252187900034"
Indicates if the customer is affiliated with a government entity.
Example:
false
Language used for invoices, emails, and hosted pages.
Available options:
fr, en, de, it, nl, es, pt, pl Example:
"fr"
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 Example:
"Europe/Paris"
ID of the customer in your system. This helps matching your customer with the one on Hyperline.
Example:
null
Customer billing address.
Show child attributes
Show child attributes
Address name.
Example:
"Acme"
Address first line.
Example:
"5 rue de Paradis"
Address second line (optional).
Example:
null
Address city.
Example:
"Paris"
Address ZIP code.
Example:
"75010"
Only for US country. Second part of subdivision code in ISO format. See ISO 3166-2:US.
Available options:
AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY Example:
"CA"
Two-letter country code in ISO format. See ISO 3166-1 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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Customer shipping address.
Show child attributes
Show child attributes
Address name.
Example:
"Acme"
Address first line.
Example:
"5 rue de Paradis"
Address second line (optional).
Example:
null
Address city.
Example:
"Paris"
Address ZIP code.
Example:
"75010"
Only for US country. Second part of subdivision code in ISO format. See ISO 3166-2:US.
Available options:
AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY Example:
"CA"
Two-letter country code in ISO format. See ISO 3166-1 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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Email to which all communications will be sent.
Example:
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.
Example:
ID of the invoicing entity this customer will be attached to.
Example:
"ive_484dn4U48E"
Indicates if invoice reminders are enabled for the customer.
Default price book ID assigned to the customer.
Example:
"prib_613_WbVIZ1329e"
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, apple_pay, google_pay, direct_debit, direct_debit_ach, direct_debit_bacs, stripe_link, transfer, transfer_automated Example:
["card", "direct_debit"]Default payment method type used to pay subscriptions and one-off invoices.
Available options:
card, apple_pay, google_pay, direct_debit, direct_debit_ach, direct_debit_bacs, stripe_link, transfer, transfer_automated, external Example:
"card"
ID of the default payment method of the customer. Only applies to card and direct debit.
Example:
"pm_UTclbc1US8GzCe"
Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.
Example:
30
Show child attributes
Show child attributes
Subscription ID.
Example:
"sub_0kIc7jrF7gV00V"
Status of the subscription.
Available options:
draft, pending, trialing, active, paused, errored, cancelled, voided, archived Example:
"active"
Plan ID.
Example:
"plan_34hdd843hReh"
Checkout session ID.
Example:
"che_949djdj39RJj"
Show child attributes
Show child attributes
ID of the entity in the provider.
Provider name.
Available options:
stripe, mollie, gocardless, airwallex, salesforce, hubspot, attio, xero, pennylane, exact-online, quickbooks, netsuite, anrok ID of the connected provider account.
Deprecated field, please use integrations.
Show child attributes
Show child attributes
Default payment method of the customer. Only applies to card and direct debit.
- Card
- Card (errored)
- Direct Debit
- Direct Debit (errored)
- Stripe Link
- Stripe Link (errored)
Show child attributes
Show child attributes
Payment method ID.
Example:
"pm_1xMpj5bwRqN7LM"
Payment method status.
active: The payment method is ready to be used.pending: The payment method is pending activation or being validated.
Available options:
active, pending Example:
"active"
Payment method type.
card: Credit or debit cardapple_pay: Apple Paygoogle_pay: Google Paydirect_debit_sepa: SEPA Direct Debitdirect_debit_ach: ACH Direct Debitdirect_debit_bacs: Bacs Direct Debitstripe_link: Stripe Link
Available options:
card, apple_pay, google_pay Example:
"card"
Last four digits of the card.
Example:
2718
Expiration date of the card using YYYY-MM format.
Example:
"2027-11"
Brand of the card.
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.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
- Option 36
- Option 37
- Option 38
- Option 39
- Option 40
- Option 41
- Option 42
- Option 43
- Option 44
- Option 45
- Option 46
- Option 47
- Option 48
- Option 49
- Option 50
- Option 51
- Option 52
- Option 53
- Option 54
- Option 55
- Option 56
- Option 57
- Option 58
- Option 59
- Option 60
- Option 61
- Option 62
- Option 63
- Option 64
Show child attributes
Show child attributes
Bank account ID. Bank account ID.
Example:
"bac_KJyPrMA1toAqRG"
Bank account currency. Bank account currency.
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 Example:
"EUR"
Bank name. Bank name.
Example:
"Fake bank"
Available options:
iban_bic_swift Example:
{
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
}Parent organization ID to which the client is attached.
Example:
null
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 Example:
null
A unique identifier for the customers in the batch
Example:
"customer-123"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Customer name.
Example:
"Acme"
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 Example:
"corporate"
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 Example:
"EUR"
Deprecated field, please use billing_address.country.
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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Indicates if the customer is affiliated with a government entity.
Example:
false
Customer tax ID.
Example:
"FR123456789"
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.
Required range:
0 <= x <= 100Customer registration number.
Example:
"36252187900034"
ID of the customer in your system. This helps matching your customer with the one on Hyperline.
ID of the invoicing entity this customer will be attached to.
Customer billing address.
Show child attributes
Show child attributes
Address name.
Example:
"Acme"
Address first line.
Example:
"5 rue de Paradis"
Address second line (optional).
Example:
null
Address city.
Example:
"Paris"
Address ZIP code.
Example:
"75010"
Only for US country. Second part of subdivision code in ISO format. See ISO 3166-2:US.
Available options:
AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY Example:
"CA"
Two-letter country code in ISO format. See ISO 3166-1 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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Customer shipping address.
Show child attributes
Show child attributes
Address name.
Example:
"Acme"
Address first line.
Example:
"5 rue de Paradis"
Address second line (optional).
Example:
null
Address city.
Example:
"Paris"
Address ZIP code.
Example:
"75010"
Only for US country. Second part of subdivision code in ISO format. See ISO 3166-2:US.
Available options:
AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY Example:
"CA"
Two-letter country code in ISO format. See ISO 3166-1 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, IC, 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, PT-20, PT-30, 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 Example:
"FR"
Email to which all communications will be sent.
Example:
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.
Example:
Language used for invoices, emails, and hosted pages.
Available options:
fr, en, de, it, nl, es, pt, pl Example:
"fr"
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 Example:
"Europe/Paris"
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, apple_pay, google_pay, direct_debit, direct_debit_ach, direct_debit_bacs, stripe_link, transfer, transfer_automated Example:
["card", "direct_debit"]Default payment method type used to pay subscriptions and one-off invoices.
Available options:
card, apple_pay, google_pay, direct_debit, direct_debit_ach, direct_debit_bacs, stripe_link, transfer, transfer_automated, external Example:
"card"
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.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Available options:
iban_bic_swift Bank name.
Example:
"Fake bank"
Example:
{
"format": "iban_bic_swift",
"iban": "FR76XXXXXXXXXXXXXXXXXXXXXXX",
"bic_swift": "XXXXXXXX"
}Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.
Example:
30
Parent organization ID to which the client is attached.
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 Indicates if invoice reminders are enabled for the customer.
Was this page helpful?
⌘I