@vrplatform/hyperline-client 1.0.30 → 1.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/build/main/_types.generated.d.ts +44928 -16283
  2. package/build/main/_types.generated.js.map +1 -1
  3. package/build/main/client.d.ts +1634 -428
  4. package/build/main/client.js +87 -62
  5. package/build/main/client.js.map +1 -1
  6. package/build/main/const.d.ts +19 -20
  7. package/build/main/const.js +31 -22
  8. package/build/main/const.js.map +1 -1
  9. package/build/main/hyperlineError.d.ts +5 -0
  10. package/build/main/hyperlineError.js +14 -0
  11. package/build/main/hyperlineError.js.map +1 -0
  12. package/build/main/index.d.ts +1 -0
  13. package/build/main/index.js +1 -0
  14. package/build/main/index.js.map +1 -1
  15. package/build/main/types.d.ts +3 -10
  16. package/build/main/types.js.map +1 -1
  17. package/build/main/utils/calculateMrr.d.ts +5 -5
  18. package/build/main/utils/calculateMrr.js +7 -16
  19. package/build/main/utils/calculateMrr.js.map +1 -1
  20. package/build/main/utils/index.d.ts +0 -1
  21. package/build/main/utils/index.js +0 -1
  22. package/build/main/utils/index.js.map +1 -1
  23. package/build/module/_types.generated.d.ts +44928 -16283
  24. package/build/module/_types.generated.js.map +1 -1
  25. package/build/module/client.d.ts +1634 -428
  26. package/build/module/client.js +87 -62
  27. package/build/module/client.js.map +1 -1
  28. package/build/module/const.d.ts +19 -20
  29. package/build/module/const.js +31 -22
  30. package/build/module/const.js.map +1 -1
  31. package/build/module/hyperlineError.d.ts +5 -0
  32. package/build/module/hyperlineError.js +16 -0
  33. package/build/module/hyperlineError.js.map +1 -0
  34. package/build/module/index.d.ts +1 -0
  35. package/build/module/index.js +1 -0
  36. package/build/module/index.js.map +1 -1
  37. package/build/module/types.d.ts +3 -10
  38. package/build/module/types.js.map +1 -1
  39. package/build/module/utils/calculateMrr.d.ts +5 -5
  40. package/build/module/utils/calculateMrr.js +7 -16
  41. package/build/module/utils/calculateMrr.js.map +1 -1
  42. package/build/module/utils/index.d.ts +0 -1
  43. package/build/module/utils/index.js +0 -1
  44. package/build/module/utils/index.js.map +1 -1
  45. package/package.json +4 -4
  46. package/src/_types.generated.ts +44918 -16274
  47. package/src/client.ts +152 -92
  48. package/src/const.ts +41 -28
  49. package/src/hyperlineError.ts +17 -0
  50. package/src/index.ts +1 -0
  51. package/src/types.ts +3 -11
  52. package/src/utils/calculateMrr.ts +15 -33
  53. package/src/utils/index.ts +0 -1
  54. package/build/main/utils/isTestingTeam.d.ts +0 -5
  55. package/build/main/utils/isTestingTeam.js +0 -4
  56. package/build/main/utils/isTestingTeam.js.map +0 -1
  57. package/build/module/utils/isTestingTeam.d.ts +0 -5
  58. package/build/module/utils/isTestingTeam.js +0 -4
  59. package/build/module/utils/isTestingTeam.js.map +0 -1
  60. package/src/utils/isTestingTeam.ts +0 -11
@@ -1,4 +1,4 @@
1
- import type { operations, paths } from './_types.generated';
1
+ import type { paths } from './_types.generated';
2
2
  import { BillableEvents, CreateBillableEvent } from './types';
3
3
  export type Logger = {
4
4
  error(message?: any, ...optionalParams: any[]): void;
@@ -21,18 +21,19 @@ export declare class HyperlineAPI {
21
21
  name: string;
22
22
  trade_name?: string;
23
23
  timezone: string;
24
- language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl";
24
+ language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl";
25
25
  is_default: boolean;
26
- currency: "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";
26
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
27
27
  accounting_currency: string;
28
28
  address_line1: string | null;
29
29
  address_line2: string | null;
30
30
  zip_code: string | null;
31
31
  state: string | null;
32
32
  city: string | null;
33
- country: "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";
33
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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";
34
+ registration_number: string | null;
34
35
  tax_id: string | null;
35
- tax_id_valid?: boolean;
36
+ tax_id_valid: boolean | null;
36
37
  billing_email: string | null;
37
38
  invoice_number_pattern: string;
38
39
  credit_note_number_pattern: string;
@@ -51,6 +52,8 @@ export declare class HyperlineAPI {
51
52
  favicon_url: string | null;
52
53
  brand_color: string | null;
53
54
  forced_customer_type: "corporate" | "person" | null;
55
+ credit_note_wallet_refund_enabled: boolean;
56
+ standalone_credit_note_creation_enabled: boolean;
54
57
  created_at: string;
55
58
  updated_at: string;
56
59
  deleted_at: string | null;
@@ -61,18 +64,19 @@ export declare class HyperlineAPI {
61
64
  name: string;
62
65
  trade_name?: string;
63
66
  timezone: string;
64
- language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl";
67
+ language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl";
65
68
  is_default: boolean;
66
- currency: "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";
69
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
67
70
  accounting_currency: string;
68
71
  address_line1: string | null;
69
72
  address_line2: string | null;
70
73
  zip_code: string | null;
71
74
  state: string | null;
72
75
  city: string | null;
73
- country: "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";
76
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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";
77
+ registration_number: string | null;
74
78
  tax_id: string | null;
75
- tax_id_valid?: boolean;
79
+ tax_id_valid: boolean | null;
76
80
  billing_email: string | null;
77
81
  invoice_number_pattern: string;
78
82
  credit_note_number_pattern: string;
@@ -91,40 +95,73 @@ export declare class HyperlineAPI {
91
95
  favicon_url: string | null;
92
96
  brand_color: string | null;
93
97
  forced_customer_type: "corporate" | "person" | null;
98
+ credit_note_wallet_refund_enabled: boolean;
99
+ standalone_credit_note_creation_enabled: boolean;
94
100
  created_at: string;
95
101
  updated_at: string;
96
102
  deleted_at: string | null;
97
103
  } | null>;
104
+ getOrganisation(id: string): Promise<{
105
+ id: string;
106
+ name: string;
107
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
108
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
109
+ invoice_schedule: "month" | "quarter" | "year" | null;
110
+ next_invoice_at: string | null;
111
+ child_customer_ids: string[];
112
+ } | null>;
113
+ updateOrganisation(id: string, data: NonNullable<paths['/v1/organisations/{id}']['patch']['requestBody']>['content']['application/json']): Promise<{
114
+ id: string;
115
+ name: string;
116
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
117
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
118
+ invoice_schedule: "month" | "quarter" | "year" | null;
119
+ next_invoice_at: string | null;
120
+ child_customer_ids: string[];
121
+ } | null>;
98
122
  getCustomer(id?: string): Promise<({
99
123
  id: string;
100
124
  name: string;
101
125
  type: "corporate" | "person" | "automatically_created" | null;
102
126
  status: "active" | "archived";
103
- currency: "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" | null;
104
- country: "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" | null;
105
- vat_number: string | null;
106
- vat_number_valid: boolean;
107
- vat_rate_custom: number | null;
127
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
128
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
129
+ domain: string | null;
130
+ tax_ids: {
131
+ value: string;
132
+ status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
133
+ }[];
134
+ local_tax_number: string | null;
135
+ tax_rate_custom: number | null;
136
+ taxability: "taxable" | "exempt";
108
137
  registration_number: string | null;
109
- language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
110
- timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "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/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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
138
+ is_government_affiliated: boolean;
139
+ language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
140
+ timezone: "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Niue" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Lucia" | "America/St_Barthelemy" | "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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Grand_Turk" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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/Amsterdam" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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" | "Indian/Kerguelen" | "Asia/Almaty" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "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" | "Antarctica/Casey" | "Australia/Perth" | "Asia/Brunei" | "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/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Dili" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Asia/Kamchatka" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Kanton" | "Pacific/Apia" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
111
141
  external_id: string | null;
112
142
  properties: {
113
143
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
114
144
  } | null;
115
145
  custom_properties: {
116
- [key: string]: string | number | boolean | null;
146
+ [key: string]: string | number | boolean | string[] | null;
117
147
  } | null;
118
148
  billing_address: import("./_types.generated").components["schemas"]["Address"];
149
+ shipping_address: {
150
+ name?: string | null;
151
+ line1?: string | null;
152
+ line2?: string | null;
153
+ city?: string | null;
154
+ zip?: string | null;
155
+ state?: "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" | null;
156
+ country?: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
157
+ } | null;
119
158
  billing_email: string | null;
120
159
  invoice_emails: string[];
121
160
  invoicing_entity_id: string;
122
161
  invoice_reminders_enabled: boolean | ("true" | "false");
162
+ force_invoice_draft: boolean | ("true" | "false");
123
163
  price_book_id: string | null;
124
164
  available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
125
- current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
126
- current_payment_method_id: string | null;
127
- custom_payment_delay: number | null;
128
165
  subscriptions: {
129
166
  id: string;
130
167
  status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
@@ -133,52 +170,37 @@ export declare class HyperlineAPI {
133
170
  plan_id: string | null;
134
171
  checkout_session_id: string | null;
135
172
  }[];
136
- created_at: string;
137
- updated_at: string;
138
- deleted_at: string | null;
139
- } & {
140
- providers: {
141
- stripe?: string;
142
- mollie?: string;
143
- gocardless?: string;
144
- airwallex?: string;
145
- salesforce?: string;
146
- hubspot?: string;
147
- attio?: string;
148
- xero?: string;
149
- pennylane?: string;
150
- "exact-online"?: string;
151
- quickbooks?: string;
152
- netsuite?: string;
153
- anrok?: string;
154
- };
173
+ segment_ids: string[];
155
174
  integrations: {
156
175
  entity_id: string;
157
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
176
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
158
177
  provider_account_id: string;
159
178
  }[];
160
- current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
161
- bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
179
+ created_at: string;
180
+ updated_at: string;
181
+ deleted_at: string | null;
182
+ owner_id: string | null;
183
+ owner: {
162
184
  id: string;
163
- currency: "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";
164
- bank_name: string | null;
165
- } & ({
166
- format: "iban_bic_swift";
167
- iban: string;
168
- bic_swift: string | null;
169
- } | {
170
- format: "sort_code_account_number";
171
- sort_code: string;
172
- account_number: string;
173
- } | {
174
- format: "account_number_routing_number";
175
- account_number: string;
176
- routing_number: string;
177
- } | {
178
- format: "account_number_bic_swift";
179
- account_number: string;
180
- bic_swift: string;
181
- })) | null);
185
+ email: string;
186
+ first_name: string | null;
187
+ last_name: string | null;
188
+ picture_url: string | null;
189
+ } | null;
190
+ followers: {
191
+ id: string;
192
+ email: string;
193
+ first_name: string | null;
194
+ last_name: string | null;
195
+ picture_url: string | null;
196
+ }[];
197
+ payment_terms: number | null;
198
+ payment_initiation_delay: number | null;
199
+ payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
200
+ payment_method_id: string | null;
201
+ } & {
202
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
203
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
182
204
  organisation_id: string | null;
183
205
  organisation_invoicing: "none" | "every_invoice" | "concat" | null;
184
206
  }) | null>;
@@ -187,31 +209,44 @@ export declare class HyperlineAPI {
187
209
  name: string;
188
210
  type: "corporate" | "person" | "automatically_created" | null;
189
211
  status: "active" | "archived";
190
- currency: "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" | null;
191
- country: "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" | null;
192
- vat_number: string | null;
193
- vat_number_valid: boolean;
194
- vat_rate_custom: number | null;
212
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
213
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
214
+ domain: string | null;
215
+ tax_ids: {
216
+ value: string;
217
+ status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
218
+ }[];
219
+ local_tax_number: string | null;
220
+ tax_rate_custom: number | null;
221
+ taxability: "taxable" | "exempt";
195
222
  registration_number: string | null;
196
- language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
197
- timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "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/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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
223
+ is_government_affiliated: boolean;
224
+ language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
225
+ timezone: "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Niue" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Lucia" | "America/St_Barthelemy" | "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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Grand_Turk" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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/Amsterdam" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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" | "Indian/Kerguelen" | "Asia/Almaty" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "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" | "Antarctica/Casey" | "Australia/Perth" | "Asia/Brunei" | "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/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Dili" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Asia/Kamchatka" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Kanton" | "Pacific/Apia" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
198
226
  external_id: string | null;
199
227
  properties: {
200
228
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
201
229
  } | null;
202
230
  custom_properties: {
203
- [key: string]: string | number | boolean | null;
231
+ [key: string]: string | number | boolean | string[] | null;
204
232
  } | null;
205
233
  billing_address: import("./_types.generated").components["schemas"]["Address"];
234
+ shipping_address: {
235
+ name?: string | null;
236
+ line1?: string | null;
237
+ line2?: string | null;
238
+ city?: string | null;
239
+ zip?: string | null;
240
+ state?: "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" | null;
241
+ country?: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
242
+ } | null;
206
243
  billing_email: string | null;
207
244
  invoice_emails: string[];
208
245
  invoicing_entity_id: string;
209
246
  invoice_reminders_enabled: boolean | ("true" | "false");
247
+ force_invoice_draft: boolean | ("true" | "false");
210
248
  price_book_id: string | null;
211
249
  available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
212
- current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
213
- current_payment_method_id: string | null;
214
- custom_payment_delay: number | null;
215
250
  subscriptions: {
216
251
  id: string;
217
252
  status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
@@ -220,49 +255,92 @@ export declare class HyperlineAPI {
220
255
  plan_id: string | null;
221
256
  checkout_session_id: string | null;
222
257
  }[];
258
+ segment_ids: string[];
259
+ integrations: {
260
+ entity_id: string;
261
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
262
+ provider_account_id: string;
263
+ }[];
223
264
  created_at: string;
224
265
  updated_at: string;
225
266
  deleted_at: string | null;
267
+ owner_id: string | null;
268
+ owner: {
269
+ id: string;
270
+ email: string;
271
+ first_name: string | null;
272
+ last_name: string | null;
273
+ picture_url: string | null;
274
+ } | null;
275
+ followers: {
276
+ id: string;
277
+ email: string;
278
+ first_name: string | null;
279
+ last_name: string | null;
280
+ picture_url: string | null;
281
+ }[];
282
+ payment_terms: number | null;
283
+ payment_initiation_delay: number | null;
284
+ payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
285
+ payment_method_id: string | null;
226
286
  } | undefined>;
227
- getCustomers(skip?: number, take?: number, query?: operations['getCustomers']['parameters']['query']): Promise<{
228
- meta: {
229
- total: number;
230
- taken: number;
231
- skipped: number;
232
- };
287
+ getCustomers(query?: paths['/v2/customers']['get']['parameters']['query']): Promise<{
233
288
  data: import("./_types.generated").components["schemas"]["Customer"][];
289
+ next_cursor: string | null;
290
+ has_more: boolean;
291
+ total?: number;
234
292
  } | null>;
235
- getAllCustomers(items?: paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getCustomers']['parameters']['query']): Promise<paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']>;
293
+ getAllCustomers(items?: paths['/v2/customers']['get']['responses'][200]['content']['application/json']['data'], query?: paths['/v2/customers']['get']['parameters']['query']): Promise<paths['/v2/customers']['get']['responses'][200]['content']['application/json']['data']>;
236
294
  createCustomer(data: NonNullable<paths['/v1/customers']['post']['requestBody']>['content']['application/json']): Promise<({
237
295
  id: string;
238
296
  name: string;
239
297
  type: "corporate" | "person" | "automatically_created" | null;
240
298
  status: "active" | "archived";
241
- currency: "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" | null;
242
- country: "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" | null;
299
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
300
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
301
+ domain: string | null;
243
302
  vat_number: string | null;
244
303
  vat_number_valid: boolean;
245
304
  vat_rate_custom: number | null;
305
+ tax_ids: {
306
+ value: string;
307
+ status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
308
+ }[];
309
+ local_tax_number: string | null;
310
+ tax_rate_custom: number | null;
311
+ taxability: "taxable" | "exempt";
246
312
  registration_number: string | null;
247
- language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
248
- timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "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/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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
313
+ is_government_affiliated: boolean;
314
+ language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
315
+ timezone: "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Niue" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Lucia" | "America/St_Barthelemy" | "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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Grand_Turk" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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/Amsterdam" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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" | "Indian/Kerguelen" | "Asia/Almaty" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "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" | "Antarctica/Casey" | "Australia/Perth" | "Asia/Brunei" | "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/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Dili" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Asia/Kamchatka" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Kanton" | "Pacific/Apia" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
249
316
  external_id: string | null;
250
317
  properties: {
251
318
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
252
319
  } | null;
253
320
  custom_properties: {
254
- [key: string]: string | number | boolean | null;
321
+ [key: string]: string | number | boolean | string[] | null;
255
322
  } | null;
256
323
  billing_address: import("./_types.generated").components["schemas"]["Address"];
324
+ shipping_address: {
325
+ name?: string | null;
326
+ line1?: string | null;
327
+ line2?: string | null;
328
+ city?: string | null;
329
+ zip?: string | null;
330
+ state?: "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" | null;
331
+ country?: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
332
+ } | null;
257
333
  billing_email: string | null;
258
334
  invoice_emails: string[];
259
335
  invoicing_entity_id: string;
260
336
  invoice_reminders_enabled: boolean | ("true" | "false");
337
+ force_invoice_draft: boolean | ("true" | "false");
261
338
  price_book_id: string | null;
262
339
  available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
263
340
  current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
264
341
  current_payment_method_id: string | null;
265
342
  custom_payment_delay: number | null;
343
+ custom_payment_initiation_delay: number | null;
266
344
  subscriptions: {
267
345
  id: string;
268
346
  status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
@@ -271,11 +349,18 @@ export declare class HyperlineAPI {
271
349
  plan_id: string | null;
272
350
  checkout_session_id: string | null;
273
351
  }[];
352
+ segment_ids: string[];
353
+ integrations: {
354
+ entity_id: string;
355
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
356
+ provider_account_id: string;
357
+ }[];
274
358
  created_at: string;
275
359
  updated_at: string;
276
360
  deleted_at: string | null;
277
361
  } & {
278
362
  providers: {
363
+ adyen?: string;
279
364
  stripe?: string;
280
365
  mollie?: string;
281
366
  gocardless?: string;
@@ -285,38 +370,29 @@ export declare class HyperlineAPI {
285
370
  attio?: string;
286
371
  xero?: string;
287
372
  pennylane?: string;
373
+ "zoho-books"?: string;
288
374
  "exact-online"?: string;
289
375
  quickbooks?: string;
290
376
  netsuite?: string;
377
+ rillet?: string;
378
+ datev?: string;
291
379
  anrok?: string;
380
+ chargebee?: string;
381
+ slack?: string;
382
+ plain?: string;
383
+ zendesk?: string;
384
+ pylon?: string;
385
+ intercom?: string;
386
+ front?: string;
387
+ helpscout?: string;
388
+ claap?: string;
389
+ grain?: string;
390
+ gong?: string;
391
+ jiminny?: string;
392
+ posthog?: string;
292
393
  };
293
- integrations: {
294
- entity_id: string;
295
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
296
- provider_account_id: string;
297
- }[];
298
- current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
299
- bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
300
- id: string;
301
- currency: "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";
302
- bank_name: string | null;
303
- } & ({
304
- format: "iban_bic_swift";
305
- iban: string;
306
- bic_swift: string | null;
307
- } | {
308
- format: "sort_code_account_number";
309
- sort_code: string;
310
- account_number: string;
311
- } | {
312
- format: "account_number_routing_number";
313
- account_number: string;
314
- routing_number: string;
315
- } | {
316
- format: "account_number_bic_swift";
317
- account_number: string;
318
- bic_swift: string;
319
- })) | null);
394
+ current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
395
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
320
396
  organisation_id: string | null;
321
397
  organisation_invoicing: "none" | "every_invoice" | "concat" | null;
322
398
  }) | null>;
@@ -325,31 +401,51 @@ export declare class HyperlineAPI {
325
401
  name: string;
326
402
  type: "corporate" | "person" | "automatically_created" | null;
327
403
  status: "active" | "archived";
328
- currency: "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" | null;
329
- country: "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" | null;
404
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
405
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
406
+ domain: string | null;
330
407
  vat_number: string | null;
331
408
  vat_number_valid: boolean;
332
409
  vat_rate_custom: number | null;
410
+ tax_ids: {
411
+ value: string;
412
+ status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
413
+ }[];
414
+ local_tax_number: string | null;
415
+ tax_rate_custom: number | null;
416
+ taxability: "taxable" | "exempt";
333
417
  registration_number: string | null;
334
- language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
335
- timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "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/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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
418
+ is_government_affiliated: boolean;
419
+ language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
420
+ timezone: "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Niue" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Lucia" | "America/St_Barthelemy" | "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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Grand_Turk" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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/Amsterdam" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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" | "Indian/Kerguelen" | "Asia/Almaty" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "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" | "Antarctica/Casey" | "Australia/Perth" | "Asia/Brunei" | "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/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Dili" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Asia/Kamchatka" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Kanton" | "Pacific/Apia" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
336
421
  external_id: string | null;
337
422
  properties: {
338
423
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
339
424
  } | null;
340
425
  custom_properties: {
341
- [key: string]: string | number | boolean | null;
426
+ [key: string]: string | number | boolean | string[] | null;
342
427
  } | null;
343
428
  billing_address: import("./_types.generated").components["schemas"]["Address"];
429
+ shipping_address: {
430
+ name?: string | null;
431
+ line1?: string | null;
432
+ line2?: string | null;
433
+ city?: string | null;
434
+ zip?: string | null;
435
+ state?: "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" | null;
436
+ country?: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
437
+ } | null;
344
438
  billing_email: string | null;
345
439
  invoice_emails: string[];
346
440
  invoicing_entity_id: string;
347
441
  invoice_reminders_enabled: boolean | ("true" | "false");
442
+ force_invoice_draft: boolean | ("true" | "false");
348
443
  price_book_id: string | null;
349
444
  available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
350
445
  current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
351
446
  current_payment_method_id: string | null;
352
447
  custom_payment_delay: number | null;
448
+ custom_payment_initiation_delay: number | null;
353
449
  subscriptions: {
354
450
  id: string;
355
451
  status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
@@ -358,11 +454,18 @@ export declare class HyperlineAPI {
358
454
  plan_id: string | null;
359
455
  checkout_session_id: string | null;
360
456
  }[];
457
+ segment_ids: string[];
458
+ integrations: {
459
+ entity_id: string;
460
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
461
+ provider_account_id: string;
462
+ }[];
361
463
  created_at: string;
362
464
  updated_at: string;
363
465
  deleted_at: string | null;
364
466
  } & {
365
467
  providers: {
468
+ adyen?: string;
366
469
  stripe?: string;
367
470
  mollie?: string;
368
471
  gocardless?: string;
@@ -372,38 +475,29 @@ export declare class HyperlineAPI {
372
475
  attio?: string;
373
476
  xero?: string;
374
477
  pennylane?: string;
478
+ "zoho-books"?: string;
375
479
  "exact-online"?: string;
376
480
  quickbooks?: string;
377
481
  netsuite?: string;
482
+ rillet?: string;
483
+ datev?: string;
378
484
  anrok?: string;
485
+ chargebee?: string;
486
+ slack?: string;
487
+ plain?: string;
488
+ zendesk?: string;
489
+ pylon?: string;
490
+ intercom?: string;
491
+ front?: string;
492
+ helpscout?: string;
493
+ claap?: string;
494
+ grain?: string;
495
+ gong?: string;
496
+ jiminny?: string;
497
+ posthog?: string;
379
498
  };
380
- integrations: {
381
- entity_id: string;
382
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
383
- provider_account_id: string;
384
- }[];
385
- current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
386
- bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
387
- id: string;
388
- currency: "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";
389
- bank_name: string | null;
390
- } & ({
391
- format: "iban_bic_swift";
392
- iban: string;
393
- bic_swift: string | null;
394
- } | {
395
- format: "sort_code_account_number";
396
- sort_code: string;
397
- account_number: string;
398
- } | {
399
- format: "account_number_routing_number";
400
- account_number: string;
401
- routing_number: string;
402
- } | {
403
- format: "account_number_bic_swift";
404
- account_number: string;
405
- bic_swift: string;
406
- })) | null);
499
+ current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
500
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
407
501
  organisation_id: string | null;
408
502
  organisation_invoicing: "none" | "every_invoice" | "concat" | null;
409
503
  }) | null>;
@@ -413,31 +507,51 @@ export declare class HyperlineAPI {
413
507
  name: string;
414
508
  type: "corporate" | "person" | "automatically_created" | null;
415
509
  status: "active" | "archived";
416
- currency: "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" | null;
417
- country: "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" | null;
510
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
511
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
512
+ domain: string | null;
418
513
  vat_number: string | null;
419
514
  vat_number_valid: boolean;
420
515
  vat_rate_custom: number | null;
516
+ tax_ids: {
517
+ value: string;
518
+ status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
519
+ }[];
520
+ local_tax_number: string | null;
521
+ tax_rate_custom: number | null;
522
+ taxability: "taxable" | "exempt";
421
523
  registration_number: string | null;
422
- language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
423
- timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "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/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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
524
+ is_government_affiliated: boolean;
525
+ language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
526
+ timezone: "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Niue" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Lucia" | "America/St_Barthelemy" | "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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Grand_Turk" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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/Amsterdam" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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" | "Indian/Kerguelen" | "Asia/Almaty" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "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" | "Antarctica/Casey" | "Australia/Perth" | "Asia/Brunei" | "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/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Dili" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Asia/Kamchatka" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Kanton" | "Pacific/Apia" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
424
527
  external_id: string | null;
425
528
  properties: {
426
529
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
427
530
  } | null;
428
531
  custom_properties: {
429
- [key: string]: string | number | boolean | null;
532
+ [key: string]: string | number | boolean | string[] | null;
430
533
  } | null;
431
534
  billing_address: import("./_types.generated").components["schemas"]["Address"];
535
+ shipping_address: {
536
+ name?: string | null;
537
+ line1?: string | null;
538
+ line2?: string | null;
539
+ city?: string | null;
540
+ zip?: string | null;
541
+ state?: "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" | null;
542
+ country?: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
543
+ } | null;
432
544
  billing_email: string | null;
433
545
  invoice_emails: string[];
434
546
  invoicing_entity_id: string;
435
547
  invoice_reminders_enabled: boolean | ("true" | "false");
548
+ force_invoice_draft: boolean | ("true" | "false");
436
549
  price_book_id: string | null;
437
550
  available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
438
551
  current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
439
552
  current_payment_method_id: string | null;
440
553
  custom_payment_delay: number | null;
554
+ custom_payment_initiation_delay: number | null;
441
555
  subscriptions: {
442
556
  id: string;
443
557
  status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
@@ -446,6 +560,12 @@ export declare class HyperlineAPI {
446
560
  plan_id: string | null;
447
561
  checkout_session_id: string | null;
448
562
  }[];
563
+ segment_ids: string[];
564
+ integrations: {
565
+ entity_id: string;
566
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
567
+ provider_account_id: string;
568
+ }[];
449
569
  created_at: string;
450
570
  updated_at: string;
451
571
  deleted_at: string | null;
@@ -455,31 +575,51 @@ export declare class HyperlineAPI {
455
575
  name: string;
456
576
  type: "corporate" | "person" | "automatically_created" | null;
457
577
  status: "active" | "archived";
458
- currency: "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" | null;
459
- country: "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" | null;
578
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
579
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
580
+ domain: string | null;
460
581
  vat_number: string | null;
461
582
  vat_number_valid: boolean;
462
583
  vat_rate_custom: number | null;
584
+ tax_ids: {
585
+ value: string;
586
+ status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
587
+ }[];
588
+ local_tax_number: string | null;
589
+ tax_rate_custom: number | null;
590
+ taxability: "taxable" | "exempt";
463
591
  registration_number: string | null;
464
- language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
465
- timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "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/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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
592
+ is_government_affiliated: boolean;
593
+ language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
594
+ timezone: "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Niue" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Lucia" | "America/St_Barthelemy" | "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/Curacao" | "America/La_Paz" | "America/Havana" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Grand_Turk" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "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" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "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/Amsterdam" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "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/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "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" | "Indian/Kerguelen" | "Asia/Almaty" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "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" | "Antarctica/Casey" | "Australia/Perth" | "Asia/Brunei" | "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/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Dili" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Asia/Kamchatka" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Kanton" | "Pacific/Apia" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
466
595
  external_id: string | null;
467
596
  properties: {
468
597
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
469
598
  } | null;
470
599
  custom_properties: {
471
- [key: string]: string | number | boolean | null;
600
+ [key: string]: string | number | boolean | string[] | null;
472
601
  } | null;
473
602
  billing_address: import("./_types.generated").components["schemas"]["Address"];
603
+ shipping_address: {
604
+ name?: string | null;
605
+ line1?: string | null;
606
+ line2?: string | null;
607
+ city?: string | null;
608
+ zip?: string | null;
609
+ state?: "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" | null;
610
+ country?: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
611
+ } | null;
474
612
  billing_email: string | null;
475
613
  invoice_emails: string[];
476
614
  invoicing_entity_id: string;
477
615
  invoice_reminders_enabled: boolean | ("true" | "false");
616
+ force_invoice_draft: boolean | ("true" | "false");
478
617
  price_book_id: string | null;
479
618
  available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
480
619
  current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
481
620
  current_payment_method_id: string | null;
482
621
  custom_payment_delay: number | null;
622
+ custom_payment_initiation_delay: number | null;
483
623
  subscriptions: {
484
624
  id: string;
485
625
  status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
@@ -488,6 +628,12 @@ export declare class HyperlineAPI {
488
628
  plan_id: string | null;
489
629
  checkout_session_id: string | null;
490
630
  }[];
631
+ segment_ids: string[];
632
+ integrations: {
633
+ entity_id: string;
634
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
635
+ provider_account_id: string;
636
+ }[];
491
637
  created_at: string;
492
638
  updated_at: string;
493
639
  deleted_at: string | null;
@@ -495,18 +641,292 @@ export declare class HyperlineAPI {
495
641
  getCustomerPortal(id: string): Promise<{
496
642
  url: string;
497
643
  } | null>;
644
+ getSubscriptionTemplate(id: string): Promise<{
645
+ id: string;
646
+ name: string;
647
+ description: string | null;
648
+ configurations: ({
649
+ id: string;
650
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
651
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "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" | "ES-CE" | "ES-ML" | "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" | null;
652
+ } & {
653
+ name: string | null;
654
+ minimum_invoice_fee: number | null;
655
+ cancel_at: string | null;
656
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
657
+ custom_properties: {
658
+ [key: string]: string | number | boolean | string[] | null;
659
+ } | null;
660
+ generate_document: boolean;
661
+ document_name: string | null;
662
+ add_tax_to_document: boolean;
663
+ generate_draft_invoices: boolean;
664
+ contract_terms: {
665
+ status: "active" | "pending" | "finished";
666
+ activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
667
+ end_strategy: "end_date" | "duration" | "manual";
668
+ starts_at: string | null;
669
+ ends_at: string | null;
670
+ duration: {
671
+ period: "days" | "weeks" | "months" | "years";
672
+ count: number;
673
+ } | null;
674
+ renew_automatically: boolean | ("true" | "false");
675
+ renew_for_duration: {
676
+ period: "days" | "weeks" | "months" | "years";
677
+ count: number;
678
+ } | null;
679
+ } | null;
680
+ phases: {
681
+ id: string;
682
+ type: "setup" | "trial" | "standard";
683
+ status: "pending" | "active" | "finished";
684
+ order: number;
685
+ activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
686
+ end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
687
+ duration: {
688
+ period: "days" | "weeks" | "months" | "years";
689
+ count: number;
690
+ } | null;
691
+ billing_date_setting: "phase_start" | "specific_date";
692
+ starts_at: string | null;
693
+ ends_at: string | null;
694
+ billing_cycle_alignment: "calendar_period" | "anniversary";
695
+ do_not_invoice_phase: boolean;
696
+ transition_calculation_method: "prorata" | "pay_in_full" | "none";
697
+ transition_invoicing_schedule: "immediately";
698
+ coupons: (({
699
+ description: string | null;
700
+ expiration_date: string | null;
701
+ redemption_limit: number | null;
702
+ repeat: "once" | "forever" | "custom" | "duration" | null;
703
+ duration: {
704
+ count: number;
705
+ period: "days" | "weeks" | "months" | "years";
706
+ } | null;
707
+ created_at: string;
708
+ type: "amount";
709
+ discount_amount: number;
710
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
711
+ } | {
712
+ description: string | null;
713
+ expiration_date: string | null;
714
+ redemption_limit: number | null;
715
+ repeat: "once" | "forever" | "custom" | "duration" | null;
716
+ duration: {
717
+ count: number;
718
+ period: "days" | "weeks" | "months" | "years";
719
+ } | null;
720
+ created_at: string;
721
+ type: "percent";
722
+ discount_percent: number;
723
+ }) & {
724
+ id: string | null;
725
+ promotion_code_id: string | null;
726
+ name: string | null;
727
+ subscription_coupon_id: string;
728
+ repeat: "once" | "forever" | "custom" | "duration";
729
+ duration_period: "days" | "weeks" | "months" | "years" | null;
730
+ duration_count: number | null;
731
+ product_ids: string[] | null;
732
+ apply_at: string | null;
733
+ expires_at: string | null;
734
+ })[];
735
+ products: ({
736
+ id: string;
737
+ type: "flat_fee";
738
+ count: number;
739
+ name: string;
740
+ description: string | null;
741
+ description_display_interval_dates: boolean;
742
+ payment_interval: {
743
+ period: "once";
744
+ } | {
745
+ period: "days" | "weeks" | "months" | "years";
746
+ count: number;
747
+ } | null;
748
+ payment_schedule: "start" | "end" | null;
749
+ prices: (import("./_types.generated").components["schemas"]["PriceFee"] & {
750
+ price_configuration_id: string | null;
751
+ })[];
752
+ } | {
753
+ id: string;
754
+ type: "seat";
755
+ count: number;
756
+ name: string;
757
+ description: string | null;
758
+ description_display_interval_dates: boolean;
759
+ unit_name: string | null;
760
+ payment_interval: {
761
+ period: "once";
762
+ } | {
763
+ period: "days" | "weeks" | "months" | "years";
764
+ count: number;
765
+ } | null;
766
+ payment_schedule: "start" | "end" | null;
767
+ prices: ((import("./_types.generated").components["schemas"]["PriceVolume"] & {
768
+ price_configuration_id: string | null;
769
+ }) | (import("./_types.generated").components["schemas"]["PricePackaged"] & {
770
+ price_configuration_id: string | null;
771
+ }) | (import("./_types.generated").components["schemas"]["PriceBulk"] & {
772
+ price_configuration_id: string | null;
773
+ }) | (import("./_types.generated").components["schemas"]["PriceBundle"] & {
774
+ price_configuration_id: string | null;
775
+ }))[];
776
+ } | {
777
+ id: string;
778
+ type: "dynamic";
779
+ name: string;
780
+ description: string | null;
781
+ description_display_interval_dates: boolean;
782
+ unit_name: string | null;
783
+ payment_interval: {
784
+ period: "once";
785
+ } | {
786
+ period: "days" | "weeks" | "months" | "years";
787
+ count: number;
788
+ } | null;
789
+ payment_schedule: "start" | "end" | null;
790
+ min_committed_count: number | null;
791
+ min_amount: number | null;
792
+ max_amount: number | null;
793
+ metering_interval_type: "subscription_commitment" | "payment_interval" | "full_database" | "phase_duration" | "custom" | null;
794
+ bill_usage_difference: boolean;
795
+ children_usage_aggregation: "sum" | "max" | null;
796
+ prices: ((import("./_types.generated").components["schemas"]["PriceVolume"] & {
797
+ price_configuration_id: string | null;
798
+ } & {
799
+ metering_filter?: {
800
+ name: string;
801
+ configuration: import("./_types.generated").components["schemas"]["MeteringFilterConfiguration"];
802
+ } | null;
803
+ }) | (import("./_types.generated").components["schemas"]["PricePackaged"] & {
804
+ price_configuration_id: string | null;
805
+ } & {
806
+ metering_filter?: {
807
+ name: string;
808
+ configuration: import("./_types.generated").components["schemas"]["MeteringFilterConfiguration"];
809
+ } | null;
810
+ }) | (import("./_types.generated").components["schemas"]["PriceBulk"] & {
811
+ price_configuration_id: string | null;
812
+ } & {
813
+ metering_filter?: {
814
+ name: string;
815
+ configuration: import("./_types.generated").components["schemas"]["MeteringFilterConfiguration"];
816
+ } | null;
817
+ }) | (import("./_types.generated").components["schemas"]["PriceBps"] & {
818
+ price_configuration_id: string | null;
819
+ } & {
820
+ metering_filter?: {
821
+ name: string;
822
+ configuration: import("./_types.generated").components["schemas"]["MeteringFilterConfiguration"];
823
+ } | null;
824
+ }))[];
825
+ } | {
826
+ id: string;
827
+ type: "credit";
828
+ count: number;
829
+ name: string;
830
+ description: string | null;
831
+ description_display_interval_dates: boolean;
832
+ unit_name: string | null;
833
+ payment_interval: {
834
+ period: "once";
835
+ } | {
836
+ period: "days" | "weeks" | "months" | "years";
837
+ count: number;
838
+ } | null;
839
+ payment_schedule: "start" | "end" | null;
840
+ credits_expiration_in_days: number | null;
841
+ expire_credits_at_end_of_period: boolean | ("true" | "false") | null;
842
+ prices: (import("./_types.generated").components["schemas"]["PriceFee"] & {
843
+ price_configuration_id: string | null;
844
+ })[];
845
+ } | {
846
+ id: string;
847
+ type: "bundle";
848
+ count: number;
849
+ name: string;
850
+ description: string | null;
851
+ description_display_interval_dates: boolean;
852
+ display_mode: "single_line" | "ventilated";
853
+ payment_interval: {
854
+ period: "once";
855
+ } | {
856
+ period: "days" | "weeks" | "months" | "years";
857
+ count: number;
858
+ } | null;
859
+ payment_schedule: "start" | "end" | null;
860
+ prices: ((import("./_types.generated").components["schemas"]["PriceVolume"] & {
861
+ price_configuration_id: string | null;
862
+ }) | (import("./_types.generated").components["schemas"]["PricePackaged"] & {
863
+ price_configuration_id: string | null;
864
+ }) | (import("./_types.generated").components["schemas"]["PriceBulk"] & {
865
+ price_configuration_id: string | null;
866
+ }) | (import("./_types.generated").components["schemas"]["PriceBundle"] & {
867
+ price_configuration_id: string | null;
868
+ }))[];
869
+ })[];
870
+ }[];
871
+ })[];
872
+ created_at: string;
873
+ updated_at: string;
874
+ } | null>;
875
+ previewSubscriptionTransition(data: NonNullable<paths['/v2/subscriptions/transitions/preview']['post']['requestBody']>['content']['application/json']): Promise<{
876
+ transition_invoice: import("./_types.generated").components["schemas"]["SimulateInvoiceDetails"] & (((import("./_types.generated").components["schemas"]["InvoiceDeprecated"] & {
877
+ public_url?: string | null;
878
+ }) & {
879
+ integrations: {
880
+ entity_id: string;
881
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
882
+ provider_account_id: string;
883
+ }[];
884
+ }) | null);
885
+ transition_credit_note: import("./_types.generated").components["schemas"]["SimulateInvoiceDetails"] & (((import("./_types.generated").components["schemas"]["InvoiceDeprecated"] & {
886
+ public_url?: string | null;
887
+ }) & {
888
+ integrations: {
889
+ entity_id: string;
890
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
891
+ provider_account_id: string;
892
+ }[];
893
+ }) | null);
894
+ next_invoice_after_transition: import("./_types.generated").components["schemas"]["SimulateInvoiceDetails"] & (((import("./_types.generated").components["schemas"]["InvoiceDeprecated"] & {
895
+ public_url?: string | null;
896
+ }) & {
897
+ integrations: {
898
+ entity_id: string;
899
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
900
+ provider_account_id: string;
901
+ }[];
902
+ }) | null);
903
+ } | null>;
904
+ createSubscriptionTransition(data: NonNullable<paths['/v2/subscriptions/transitions']['post']['requestBody']>['content']['application/json']): Promise<{
905
+ id: string;
906
+ customer_id: string;
907
+ base_subscription_id: string;
908
+ source_subscription_id: string;
909
+ target_subscription_id: string | null;
910
+ status: "scheduled" | "completed" | "failed" | "draft" | "pending_approval" | "changes_requested" | "cancelled" | "pending_quote_signature";
911
+ transitioned_at: string | null;
912
+ name: string | null;
913
+ transition_date: string | null;
914
+ application_schedule: "immediately" | "scheduled" | "next_renewal" | "last_renewal" | "quote_signature" | "scheduled_after_quote_signature";
915
+ billing_cycle_transition_method: "keep_current_billing_cycle" | "align_to_new_billing_cycle" | null;
916
+ calculation_method: "do_not_charge" | "pro_rata" | "pro_rata_separate_documents" | null;
917
+ } | null>;
498
918
  getSubscription(id: string, liveBilling?: boolean): Promise<({
499
919
  id: string;
500
920
  name: string | null;
501
- currency: "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";
502
- status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
921
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
922
+ status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
503
923
  purchase_order: string | null;
504
924
  customer_id: string;
925
+ invoicing_entity_id: string | null;
505
926
  plan_id: string | null;
506
- invoicing_entity_id: string;
927
+ template_id: string | null;
507
928
  checkout_session_id: string | null;
508
929
  crm_opportunity_id: string | null;
509
- transition_from_subscription_id: string | null;
510
930
  minimum_invoice_fee: number | null;
511
931
  commitment_interval: {
512
932
  period: "days" | "weeks" | "months" | "years";
@@ -518,8 +938,8 @@ export declare class HyperlineAPI {
518
938
  count: number;
519
939
  } | null;
520
940
  activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
521
- starts_at: string;
522
- contract_start: string;
941
+ starts_at: string | null;
942
+ contract_start: string | null;
523
943
  contract_end: string | null;
524
944
  initial_billing_at: string | null;
525
945
  paused_at: string | null;
@@ -528,38 +948,54 @@ export declare class HyperlineAPI {
528
948
  cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
529
949
  cancellation_amount: number | null;
530
950
  cancellation_reason: string | null;
951
+ cancellation_source: "portal" | "app" | "api" | "system" | null;
531
952
  estimated_arr: number | null;
953
+ contract_value: number | null;
532
954
  current_period_started_at: string | null;
533
955
  current_period_ends_at: string | null;
534
956
  next_payment_at: string | null;
535
957
  next_payment_amount: number | null;
536
958
  renews_at: string | null;
537
959
  current_phase_id: string | null;
960
+ display_shipping_details: boolean | null;
538
961
  properties: {
539
962
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
540
963
  } | null;
541
964
  custom_properties: {
542
- [key: string]: string | number | boolean | null;
965
+ [key: string]: string | number | boolean | string[] | null;
543
966
  } | null;
967
+ invoice_schedule: "period_start" | "period_end" | null;
544
968
  generate_document: boolean;
545
969
  document_name: string | null;
546
970
  add_tax_to_document: boolean;
971
+ generate_draft_invoices: boolean;
972
+ do_not_charge_subscription: boolean;
973
+ invoice_custom_note: string | null;
547
974
  created_at: string;
548
975
  updated_at: string;
549
- } & {
550
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
976
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
551
977
  coupons: (({
552
978
  description: string | null;
553
979
  expiration_date: string | null;
554
980
  redemption_limit: number | null;
981
+ repeat: "once" | "forever" | "custom" | "duration" | null;
982
+ duration: {
983
+ count: number;
984
+ period: "days" | "weeks" | "months" | "years";
985
+ } | null;
555
986
  created_at: string;
556
987
  type: "amount";
557
988
  discount_amount: number;
558
- currency: "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" | null;
989
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
559
990
  } | {
560
991
  description: string | null;
561
992
  expiration_date: string | null;
562
993
  redemption_limit: number | null;
994
+ repeat: "once" | "forever" | "custom" | "duration" | null;
995
+ duration: {
996
+ count: number;
997
+ period: "days" | "weeks" | "months" | "years";
998
+ } | null;
563
999
  created_at: string;
564
1000
  type: "percent";
565
1001
  discount_percent: number;
@@ -568,13 +1004,22 @@ export declare class HyperlineAPI {
568
1004
  promotion_code_id: string | null;
569
1005
  name: string | null;
570
1006
  subscription_coupon_id: string;
571
- repeat: "once" | "forever" | "custom";
572
- product_ids: string[];
1007
+ repeat: "once" | "forever" | "custom" | "duration";
1008
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1009
+ duration_count: number | null;
1010
+ product_ids: string[] | null;
573
1011
  apply_at: string | null;
574
1012
  expires_at: string | null;
575
1013
  })[];
1014
+ integrations: {
1015
+ entity_id: string;
1016
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1017
+ provider_account_id: string;
1018
+ }[];
1019
+ } & {
576
1020
  phases: {
577
1021
  id: string;
1022
+ name: string | null;
578
1023
  type: "setup" | "trial" | "standard";
579
1024
  status: "pending" | "active" | "finished";
580
1025
  order: number;
@@ -592,19 +1037,29 @@ export declare class HyperlineAPI {
592
1037
  do_not_invoice_phase: boolean;
593
1038
  transition_calculation_method: "prorata" | "pay_in_full" | "none";
594
1039
  transition_invoicing_schedule: "immediately";
595
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1040
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
596
1041
  coupons: (({
597
1042
  description: string | null;
598
1043
  expiration_date: string | null;
599
1044
  redemption_limit: number | null;
1045
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1046
+ duration: {
1047
+ count: number;
1048
+ period: "days" | "weeks" | "months" | "years";
1049
+ } | null;
600
1050
  created_at: string;
601
1051
  type: "amount";
602
1052
  discount_amount: number;
603
- currency: "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" | null;
1053
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
604
1054
  } | {
605
1055
  description: string | null;
606
1056
  expiration_date: string | null;
607
1057
  redemption_limit: number | null;
1058
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1059
+ duration: {
1060
+ count: number;
1061
+ period: "days" | "weeks" | "months" | "years";
1062
+ } | null;
608
1063
  created_at: string;
609
1064
  type: "percent";
610
1065
  discount_percent: number;
@@ -613,8 +1068,10 @@ export declare class HyperlineAPI {
613
1068
  promotion_code_id: string | null;
614
1069
  name: string | null;
615
1070
  subscription_coupon_id: string;
616
- repeat: "once" | "forever" | "custom";
617
- product_ids: string[];
1071
+ repeat: "once" | "forever" | "custom" | "duration";
1072
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1073
+ duration_count: number | null;
1074
+ product_ids: string[] | null;
618
1075
  apply_at: string | null;
619
1076
  expires_at: string | null;
620
1077
  })[];
@@ -629,13 +1086,14 @@ export declare class HyperlineAPI {
629
1086
  id: string;
630
1087
  name: string;
631
1088
  } | null;
1089
+ template: {
1090
+ id: string;
1091
+ name: string;
1092
+ configurationId: string;
1093
+ } | null;
632
1094
  checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
633
1095
  payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
634
1096
  payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
635
- generate_draft_invoices: boolean;
636
- generate_document: boolean;
637
- document_name: string | null;
638
- add_tax_to_document: boolean;
639
1097
  contract_terms: {
640
1098
  status: "active" | "pending" | "finished";
641
1099
  activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
@@ -657,7 +1115,7 @@ export declare class HyperlineAPI {
657
1115
  } & {
658
1116
  live_billing?: import("./_types.generated").components["schemas"]["LiveBilling"];
659
1117
  }) | null>;
660
- getSubscriptions(skip?: number, take?: number, query?: operations['getSubscriptions']['parameters']['query']): Promise<{
1118
+ getSubscriptions(skip?: number, take?: number, query?: paths['/v2/subscriptions']['get']['parameters']['query']): Promise<{
661
1119
  meta: {
662
1120
  total: number;
663
1121
  taken: number;
@@ -665,19 +1123,19 @@ export declare class HyperlineAPI {
665
1123
  };
666
1124
  data: import("./_types.generated").components["schemas"]["Subscription"][];
667
1125
  } | null>;
668
- getAllSubscriptions(items?: paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getSubscriptions']['parameters']['query']): Promise<paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data']>;
1126
+ getAllSubscriptions(items?: paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data'], query?: paths['/v2/subscriptions']['get']['parameters']['query']): Promise<paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data']>;
669
1127
  createSubscription(data: NonNullable<paths['/v2/subscriptions']['post']['requestBody']>['content']['application/json']): Promise<({
670
1128
  id: string;
671
1129
  name: string | null;
672
- currency: "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";
673
- status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
1130
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1131
+ status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
674
1132
  purchase_order: string | null;
675
1133
  customer_id: string;
1134
+ invoicing_entity_id: string | null;
676
1135
  plan_id: string | null;
677
- invoicing_entity_id: string;
1136
+ template_id: string | null;
678
1137
  checkout_session_id: string | null;
679
1138
  crm_opportunity_id: string | null;
680
- transition_from_subscription_id: string | null;
681
1139
  minimum_invoice_fee: number | null;
682
1140
  commitment_interval: {
683
1141
  period: "days" | "weeks" | "months" | "years";
@@ -689,8 +1147,8 @@ export declare class HyperlineAPI {
689
1147
  count: number;
690
1148
  } | null;
691
1149
  activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
692
- starts_at: string;
693
- contract_start: string;
1150
+ starts_at: string | null;
1151
+ contract_start: string | null;
694
1152
  contract_end: string | null;
695
1153
  initial_billing_at: string | null;
696
1154
  paused_at: string | null;
@@ -699,38 +1157,54 @@ export declare class HyperlineAPI {
699
1157
  cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
700
1158
  cancellation_amount: number | null;
701
1159
  cancellation_reason: string | null;
1160
+ cancellation_source: "portal" | "app" | "api" | "system" | null;
702
1161
  estimated_arr: number | null;
1162
+ contract_value: number | null;
703
1163
  current_period_started_at: string | null;
704
1164
  current_period_ends_at: string | null;
705
1165
  next_payment_at: string | null;
706
1166
  next_payment_amount: number | null;
707
1167
  renews_at: string | null;
708
1168
  current_phase_id: string | null;
1169
+ display_shipping_details: boolean | null;
709
1170
  properties: {
710
1171
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
711
1172
  } | null;
712
1173
  custom_properties: {
713
- [key: string]: string | number | boolean | null;
1174
+ [key: string]: string | number | boolean | string[] | null;
714
1175
  } | null;
1176
+ invoice_schedule: "period_start" | "period_end" | null;
715
1177
  generate_document: boolean;
716
1178
  document_name: string | null;
717
1179
  add_tax_to_document: boolean;
1180
+ generate_draft_invoices: boolean;
1181
+ do_not_charge_subscription: boolean;
1182
+ invoice_custom_note: string | null;
718
1183
  created_at: string;
719
1184
  updated_at: string;
720
- } & {
721
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1185
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
722
1186
  coupons: (({
723
1187
  description: string | null;
724
1188
  expiration_date: string | null;
725
1189
  redemption_limit: number | null;
1190
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1191
+ duration: {
1192
+ count: number;
1193
+ period: "days" | "weeks" | "months" | "years";
1194
+ } | null;
726
1195
  created_at: string;
727
1196
  type: "amount";
728
1197
  discount_amount: number;
729
- currency: "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" | null;
1198
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
730
1199
  } | {
731
1200
  description: string | null;
732
1201
  expiration_date: string | null;
733
1202
  redemption_limit: number | null;
1203
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1204
+ duration: {
1205
+ count: number;
1206
+ period: "days" | "weeks" | "months" | "years";
1207
+ } | null;
734
1208
  created_at: string;
735
1209
  type: "percent";
736
1210
  discount_percent: number;
@@ -739,13 +1213,22 @@ export declare class HyperlineAPI {
739
1213
  promotion_code_id: string | null;
740
1214
  name: string | null;
741
1215
  subscription_coupon_id: string;
742
- repeat: "once" | "forever" | "custom";
743
- product_ids: string[];
1216
+ repeat: "once" | "forever" | "custom" | "duration";
1217
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1218
+ duration_count: number | null;
1219
+ product_ids: string[] | null;
744
1220
  apply_at: string | null;
745
1221
  expires_at: string | null;
746
1222
  })[];
1223
+ integrations: {
1224
+ entity_id: string;
1225
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1226
+ provider_account_id: string;
1227
+ }[];
1228
+ } & {
747
1229
  phases: {
748
1230
  id: string;
1231
+ name: string | null;
749
1232
  type: "setup" | "trial" | "standard";
750
1233
  status: "pending" | "active" | "finished";
751
1234
  order: number;
@@ -763,19 +1246,29 @@ export declare class HyperlineAPI {
763
1246
  do_not_invoice_phase: boolean;
764
1247
  transition_calculation_method: "prorata" | "pay_in_full" | "none";
765
1248
  transition_invoicing_schedule: "immediately";
766
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1249
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
767
1250
  coupons: (({
768
1251
  description: string | null;
769
1252
  expiration_date: string | null;
770
1253
  redemption_limit: number | null;
1254
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1255
+ duration: {
1256
+ count: number;
1257
+ period: "days" | "weeks" | "months" | "years";
1258
+ } | null;
771
1259
  created_at: string;
772
1260
  type: "amount";
773
1261
  discount_amount: number;
774
- currency: "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" | null;
1262
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
775
1263
  } | {
776
1264
  description: string | null;
777
1265
  expiration_date: string | null;
778
1266
  redemption_limit: number | null;
1267
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1268
+ duration: {
1269
+ count: number;
1270
+ period: "days" | "weeks" | "months" | "years";
1271
+ } | null;
779
1272
  created_at: string;
780
1273
  type: "percent";
781
1274
  discount_percent: number;
@@ -784,8 +1277,10 @@ export declare class HyperlineAPI {
784
1277
  promotion_code_id: string | null;
785
1278
  name: string | null;
786
1279
  subscription_coupon_id: string;
787
- repeat: "once" | "forever" | "custom";
788
- product_ids: string[];
1280
+ repeat: "once" | "forever" | "custom" | "duration";
1281
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1282
+ duration_count: number | null;
1283
+ product_ids: string[] | null;
789
1284
  apply_at: string | null;
790
1285
  expires_at: string | null;
791
1286
  })[];
@@ -800,13 +1295,14 @@ export declare class HyperlineAPI {
800
1295
  id: string;
801
1296
  name: string;
802
1297
  } | null;
1298
+ template: {
1299
+ id: string;
1300
+ name: string;
1301
+ configurationId: string;
1302
+ } | null;
803
1303
  checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
804
1304
  payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
805
1305
  payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
806
- generate_draft_invoices: boolean;
807
- generate_document: boolean;
808
- document_name: string | null;
809
- add_tax_to_document: boolean;
810
1306
  contract_terms: {
811
1307
  status: "active" | "pending" | "finished";
812
1308
  activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
@@ -826,18 +1322,18 @@ export declare class HyperlineAPI {
826
1322
  current_period_ends_at: string | null;
827
1323
  } | null;
828
1324
  }) | null>;
829
- updateSubscription(id: string, data: NonNullable<paths['/v2/subscriptions/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
1325
+ activateSubscription(id: string): Promise<({
830
1326
  id: string;
831
1327
  name: string | null;
832
- currency: "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";
833
- status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
1328
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1329
+ status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
834
1330
  purchase_order: string | null;
835
1331
  customer_id: string;
1332
+ invoicing_entity_id: string | null;
836
1333
  plan_id: string | null;
837
- invoicing_entity_id: string;
1334
+ template_id: string | null;
838
1335
  checkout_session_id: string | null;
839
1336
  crm_opportunity_id: string | null;
840
- transition_from_subscription_id: string | null;
841
1337
  minimum_invoice_fee: number | null;
842
1338
  commitment_interval: {
843
1339
  period: "days" | "weeks" | "months" | "years";
@@ -849,8 +1345,8 @@ export declare class HyperlineAPI {
849
1345
  count: number;
850
1346
  } | null;
851
1347
  activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
852
- starts_at: string;
853
- contract_start: string;
1348
+ starts_at: string | null;
1349
+ contract_start: string | null;
854
1350
  contract_end: string | null;
855
1351
  initial_billing_at: string | null;
856
1352
  paused_at: string | null;
@@ -859,38 +1355,54 @@ export declare class HyperlineAPI {
859
1355
  cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
860
1356
  cancellation_amount: number | null;
861
1357
  cancellation_reason: string | null;
1358
+ cancellation_source: "portal" | "app" | "api" | "system" | null;
862
1359
  estimated_arr: number | null;
1360
+ contract_value: number | null;
863
1361
  current_period_started_at: string | null;
864
1362
  current_period_ends_at: string | null;
865
1363
  next_payment_at: string | null;
866
1364
  next_payment_amount: number | null;
867
1365
  renews_at: string | null;
868
1366
  current_phase_id: string | null;
1367
+ display_shipping_details: boolean | null;
869
1368
  properties: {
870
1369
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
871
1370
  } | null;
872
1371
  custom_properties: {
873
- [key: string]: string | number | boolean | null;
1372
+ [key: string]: string | number | boolean | string[] | null;
874
1373
  } | null;
1374
+ invoice_schedule: "period_start" | "period_end" | null;
875
1375
  generate_document: boolean;
876
1376
  document_name: string | null;
877
1377
  add_tax_to_document: boolean;
1378
+ generate_draft_invoices: boolean;
1379
+ do_not_charge_subscription: boolean;
1380
+ invoice_custom_note: string | null;
878
1381
  created_at: string;
879
1382
  updated_at: string;
880
- } & {
881
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1383
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
882
1384
  coupons: (({
883
1385
  description: string | null;
884
1386
  expiration_date: string | null;
885
1387
  redemption_limit: number | null;
1388
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1389
+ duration: {
1390
+ count: number;
1391
+ period: "days" | "weeks" | "months" | "years";
1392
+ } | null;
886
1393
  created_at: string;
887
1394
  type: "amount";
888
1395
  discount_amount: number;
889
- currency: "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" | null;
1396
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
890
1397
  } | {
891
1398
  description: string | null;
892
1399
  expiration_date: string | null;
893
1400
  redemption_limit: number | null;
1401
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1402
+ duration: {
1403
+ count: number;
1404
+ period: "days" | "weeks" | "months" | "years";
1405
+ } | null;
894
1406
  created_at: string;
895
1407
  type: "percent";
896
1408
  discount_percent: number;
@@ -899,13 +1411,22 @@ export declare class HyperlineAPI {
899
1411
  promotion_code_id: string | null;
900
1412
  name: string | null;
901
1413
  subscription_coupon_id: string;
902
- repeat: "once" | "forever" | "custom";
903
- product_ids: string[];
1414
+ repeat: "once" | "forever" | "custom" | "duration";
1415
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1416
+ duration_count: number | null;
1417
+ product_ids: string[] | null;
904
1418
  apply_at: string | null;
905
1419
  expires_at: string | null;
906
1420
  })[];
1421
+ integrations: {
1422
+ entity_id: string;
1423
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1424
+ provider_account_id: string;
1425
+ }[];
1426
+ } & {
907
1427
  phases: {
908
1428
  id: string;
1429
+ name: string | null;
909
1430
  type: "setup" | "trial" | "standard";
910
1431
  status: "pending" | "active" | "finished";
911
1432
  order: number;
@@ -923,19 +1444,29 @@ export declare class HyperlineAPI {
923
1444
  do_not_invoice_phase: boolean;
924
1445
  transition_calculation_method: "prorata" | "pay_in_full" | "none";
925
1446
  transition_invoicing_schedule: "immediately";
926
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1447
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
927
1448
  coupons: (({
928
1449
  description: string | null;
929
1450
  expiration_date: string | null;
930
1451
  redemption_limit: number | null;
1452
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1453
+ duration: {
1454
+ count: number;
1455
+ period: "days" | "weeks" | "months" | "years";
1456
+ } | null;
931
1457
  created_at: string;
932
1458
  type: "amount";
933
1459
  discount_amount: number;
934
- currency: "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" | null;
1460
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
935
1461
  } | {
936
1462
  description: string | null;
937
1463
  expiration_date: string | null;
938
1464
  redemption_limit: number | null;
1465
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1466
+ duration: {
1467
+ count: number;
1468
+ period: "days" | "weeks" | "months" | "years";
1469
+ } | null;
939
1470
  created_at: string;
940
1471
  type: "percent";
941
1472
  discount_percent: number;
@@ -944,8 +1475,10 @@ export declare class HyperlineAPI {
944
1475
  promotion_code_id: string | null;
945
1476
  name: string | null;
946
1477
  subscription_coupon_id: string;
947
- repeat: "once" | "forever" | "custom";
948
- product_ids: string[];
1478
+ repeat: "once" | "forever" | "custom" | "duration";
1479
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1480
+ duration_count: number | null;
1481
+ product_ids: string[] | null;
949
1482
  apply_at: string | null;
950
1483
  expires_at: string | null;
951
1484
  })[];
@@ -960,13 +1493,14 @@ export declare class HyperlineAPI {
960
1493
  id: string;
961
1494
  name: string;
962
1495
  } | null;
1496
+ template: {
1497
+ id: string;
1498
+ name: string;
1499
+ configurationId: string;
1500
+ } | null;
963
1501
  checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
964
1502
  payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
965
1503
  payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
966
- generate_draft_invoices: boolean;
967
- generate_document: boolean;
968
- document_name: string | null;
969
- add_tax_to_document: boolean;
970
1504
  contract_terms: {
971
1505
  status: "active" | "pending" | "finished";
972
1506
  activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
@@ -986,21 +1520,18 @@ export declare class HyperlineAPI {
986
1520
  current_period_ends_at: string | null;
987
1521
  } | null;
988
1522
  }) | null>;
989
- createSubscriptionUpdate(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update']['post']['requestBody']>['content']['application/json']): Promise<{
990
- id: string;
991
- } | null>;
992
- cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
1523
+ updateSubscription(id: string, data: NonNullable<paths['/v2/subscriptions/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
993
1524
  id: string;
994
1525
  name: string | null;
995
- currency: "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";
996
- status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
1526
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1527
+ status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
997
1528
  purchase_order: string | null;
998
1529
  customer_id: string;
1530
+ invoicing_entity_id: string | null;
999
1531
  plan_id: string | null;
1000
- invoicing_entity_id: string;
1532
+ template_id: string | null;
1001
1533
  checkout_session_id: string | null;
1002
1534
  crm_opportunity_id: string | null;
1003
- transition_from_subscription_id: string | null;
1004
1535
  minimum_invoice_fee: number | null;
1005
1536
  commitment_interval: {
1006
1537
  period: "days" | "weeks" | "months" | "years";
@@ -1012,8 +1543,8 @@ export declare class HyperlineAPI {
1012
1543
  count: number;
1013
1544
  } | null;
1014
1545
  activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
1015
- starts_at: string;
1016
- contract_start: string;
1546
+ starts_at: string | null;
1547
+ contract_start: string | null;
1017
1548
  contract_end: string | null;
1018
1549
  initial_billing_at: string | null;
1019
1550
  paused_at: string | null;
@@ -1022,38 +1553,54 @@ export declare class HyperlineAPI {
1022
1553
  cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
1023
1554
  cancellation_amount: number | null;
1024
1555
  cancellation_reason: string | null;
1556
+ cancellation_source: "portal" | "app" | "api" | "system" | null;
1025
1557
  estimated_arr: number | null;
1558
+ contract_value: number | null;
1026
1559
  current_period_started_at: string | null;
1027
1560
  current_period_ends_at: string | null;
1028
1561
  next_payment_at: string | null;
1029
1562
  next_payment_amount: number | null;
1030
1563
  renews_at: string | null;
1031
1564
  current_phase_id: string | null;
1565
+ display_shipping_details: boolean | null;
1032
1566
  properties: {
1033
1567
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
1034
1568
  } | null;
1035
1569
  custom_properties: {
1036
- [key: string]: string | number | boolean | null;
1570
+ [key: string]: string | number | boolean | string[] | null;
1037
1571
  } | null;
1572
+ invoice_schedule: "period_start" | "period_end" | null;
1038
1573
  generate_document: boolean;
1039
1574
  document_name: string | null;
1040
1575
  add_tax_to_document: boolean;
1576
+ generate_draft_invoices: boolean;
1577
+ do_not_charge_subscription: boolean;
1578
+ invoice_custom_note: string | null;
1041
1579
  created_at: string;
1042
1580
  updated_at: string;
1043
- } & {
1044
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1581
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
1045
1582
  coupons: (({
1046
1583
  description: string | null;
1047
1584
  expiration_date: string | null;
1048
1585
  redemption_limit: number | null;
1586
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1587
+ duration: {
1588
+ count: number;
1589
+ period: "days" | "weeks" | "months" | "years";
1590
+ } | null;
1049
1591
  created_at: string;
1050
1592
  type: "amount";
1051
1593
  discount_amount: number;
1052
- currency: "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" | null;
1594
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
1053
1595
  } | {
1054
1596
  description: string | null;
1055
1597
  expiration_date: string | null;
1056
1598
  redemption_limit: number | null;
1599
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1600
+ duration: {
1601
+ count: number;
1602
+ period: "days" | "weeks" | "months" | "years";
1603
+ } | null;
1057
1604
  created_at: string;
1058
1605
  type: "percent";
1059
1606
  discount_percent: number;
@@ -1062,13 +1609,22 @@ export declare class HyperlineAPI {
1062
1609
  promotion_code_id: string | null;
1063
1610
  name: string | null;
1064
1611
  subscription_coupon_id: string;
1065
- repeat: "once" | "forever" | "custom";
1066
- product_ids: string[];
1612
+ repeat: "once" | "forever" | "custom" | "duration";
1613
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1614
+ duration_count: number | null;
1615
+ product_ids: string[] | null;
1067
1616
  apply_at: string | null;
1068
1617
  expires_at: string | null;
1069
1618
  })[];
1619
+ integrations: {
1620
+ entity_id: string;
1621
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1622
+ provider_account_id: string;
1623
+ }[];
1624
+ } & {
1070
1625
  phases: {
1071
1626
  id: string;
1627
+ name: string | null;
1072
1628
  type: "setup" | "trial" | "standard";
1073
1629
  status: "pending" | "active" | "finished";
1074
1630
  order: number;
@@ -1086,19 +1642,29 @@ export declare class HyperlineAPI {
1086
1642
  do_not_invoice_phase: boolean;
1087
1643
  transition_calculation_method: "prorata" | "pay_in_full" | "none";
1088
1644
  transition_invoicing_schedule: "immediately";
1089
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1645
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
1090
1646
  coupons: (({
1091
1647
  description: string | null;
1092
1648
  expiration_date: string | null;
1093
1649
  redemption_limit: number | null;
1650
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1651
+ duration: {
1652
+ count: number;
1653
+ period: "days" | "weeks" | "months" | "years";
1654
+ } | null;
1094
1655
  created_at: string;
1095
1656
  type: "amount";
1096
1657
  discount_amount: number;
1097
- currency: "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" | null;
1658
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
1098
1659
  } | {
1099
1660
  description: string | null;
1100
1661
  expiration_date: string | null;
1101
1662
  redemption_limit: number | null;
1663
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1664
+ duration: {
1665
+ count: number;
1666
+ period: "days" | "weeks" | "months" | "years";
1667
+ } | null;
1102
1668
  created_at: string;
1103
1669
  type: "percent";
1104
1670
  discount_percent: number;
@@ -1107,8 +1673,10 @@ export declare class HyperlineAPI {
1107
1673
  promotion_code_id: string | null;
1108
1674
  name: string | null;
1109
1675
  subscription_coupon_id: string;
1110
- repeat: "once" | "forever" | "custom";
1111
- product_ids: string[];
1676
+ repeat: "once" | "forever" | "custom" | "duration";
1677
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1678
+ duration_count: number | null;
1679
+ product_ids: string[] | null;
1112
1680
  apply_at: string | null;
1113
1681
  expires_at: string | null;
1114
1682
  })[];
@@ -1123,13 +1691,14 @@ export declare class HyperlineAPI {
1123
1691
  id: string;
1124
1692
  name: string;
1125
1693
  } | null;
1694
+ template: {
1695
+ id: string;
1696
+ name: string;
1697
+ configurationId: string;
1698
+ } | null;
1126
1699
  checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
1127
1700
  payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
1128
1701
  payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
1129
- generate_draft_invoices: boolean;
1130
- generate_document: boolean;
1131
- document_name: string | null;
1132
- add_tax_to_document: boolean;
1133
1702
  contract_terms: {
1134
1703
  status: "active" | "pending" | "finished";
1135
1704
  activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
@@ -1149,18 +1718,24 @@ export declare class HyperlineAPI {
1149
1718
  current_period_ends_at: string | null;
1150
1719
  } | null;
1151
1720
  }) | null>;
1152
- reinstateSubscription(id: string): Promise<({
1721
+ createSubscriptionUpdate(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update']['post']['requestBody']>['content']['application/json']): Promise<{
1722
+ id: string;
1723
+ } | null>;
1724
+ createSubscriptionUpdates(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update-many']['post']['requestBody']>['content']['application/json']): Promise<{
1725
+ id: string;
1726
+ }[] | null>;
1727
+ cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
1153
1728
  id: string;
1154
1729
  name: string | null;
1155
- currency: "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";
1156
- status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
1730
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1731
+ status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
1157
1732
  purchase_order: string | null;
1158
1733
  customer_id: string;
1734
+ invoicing_entity_id: string | null;
1159
1735
  plan_id: string | null;
1160
- invoicing_entity_id: string;
1736
+ template_id: string | null;
1161
1737
  checkout_session_id: string | null;
1162
1738
  crm_opportunity_id: string | null;
1163
- transition_from_subscription_id: string | null;
1164
1739
  minimum_invoice_fee: number | null;
1165
1740
  commitment_interval: {
1166
1741
  period: "days" | "weeks" | "months" | "years";
@@ -1172,8 +1747,8 @@ export declare class HyperlineAPI {
1172
1747
  count: number;
1173
1748
  } | null;
1174
1749
  activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
1175
- starts_at: string;
1176
- contract_start: string;
1750
+ starts_at: string | null;
1751
+ contract_start: string | null;
1177
1752
  contract_end: string | null;
1178
1753
  initial_billing_at: string | null;
1179
1754
  paused_at: string | null;
@@ -1182,53 +1757,78 @@ export declare class HyperlineAPI {
1182
1757
  cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
1183
1758
  cancellation_amount: number | null;
1184
1759
  cancellation_reason: string | null;
1760
+ cancellation_source: "portal" | "app" | "api" | "system" | null;
1185
1761
  estimated_arr: number | null;
1762
+ contract_value: number | null;
1186
1763
  current_period_started_at: string | null;
1187
1764
  current_period_ends_at: string | null;
1188
1765
  next_payment_at: string | null;
1189
1766
  next_payment_amount: number | null;
1190
1767
  renews_at: string | null;
1191
1768
  current_phase_id: string | null;
1769
+ display_shipping_details: boolean | null;
1192
1770
  properties: {
1193
1771
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
1194
1772
  } | null;
1195
1773
  custom_properties: {
1196
- [key: string]: string | number | boolean | null;
1774
+ [key: string]: string | number | boolean | string[] | null;
1197
1775
  } | null;
1776
+ invoice_schedule: "period_start" | "period_end" | null;
1198
1777
  generate_document: boolean;
1199
1778
  document_name: string | null;
1200
1779
  add_tax_to_document: boolean;
1780
+ generate_draft_invoices: boolean;
1781
+ do_not_charge_subscription: boolean;
1782
+ invoice_custom_note: string | null;
1201
1783
  created_at: string;
1202
1784
  updated_at: string;
1203
- } & {
1204
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1785
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
1205
1786
  coupons: (({
1206
1787
  description: string | null;
1207
1788
  expiration_date: string | null;
1208
1789
  redemption_limit: number | null;
1790
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1791
+ duration: {
1792
+ count: number;
1793
+ period: "days" | "weeks" | "months" | "years";
1794
+ } | null;
1209
1795
  created_at: string;
1210
1796
  type: "amount";
1211
1797
  discount_amount: number;
1212
- currency: "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" | null;
1798
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
1213
1799
  } | {
1214
1800
  description: string | null;
1215
1801
  expiration_date: string | null;
1216
1802
  redemption_limit: number | null;
1217
- created_at: string;
1218
- type: "percent";
1219
- discount_percent: number;
1803
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1804
+ duration: {
1805
+ count: number;
1806
+ period: "days" | "weeks" | "months" | "years";
1807
+ } | null;
1808
+ created_at: string;
1809
+ type: "percent";
1810
+ discount_percent: number;
1220
1811
  }) & {
1221
1812
  id: string | null;
1222
1813
  promotion_code_id: string | null;
1223
1814
  name: string | null;
1224
1815
  subscription_coupon_id: string;
1225
- repeat: "once" | "forever" | "custom";
1226
- product_ids: string[];
1816
+ repeat: "once" | "forever" | "custom" | "duration";
1817
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1818
+ duration_count: number | null;
1819
+ product_ids: string[] | null;
1227
1820
  apply_at: string | null;
1228
1821
  expires_at: string | null;
1229
1822
  })[];
1823
+ integrations: {
1824
+ entity_id: string;
1825
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1826
+ provider_account_id: string;
1827
+ }[];
1828
+ } & {
1230
1829
  phases: {
1231
1830
  id: string;
1831
+ name: string | null;
1232
1832
  type: "setup" | "trial" | "standard";
1233
1833
  status: "pending" | "active" | "finished";
1234
1834
  order: number;
@@ -1246,19 +1846,29 @@ export declare class HyperlineAPI {
1246
1846
  do_not_invoice_phase: boolean;
1247
1847
  transition_calculation_method: "prorata" | "pay_in_full" | "none";
1248
1848
  transition_invoicing_schedule: "immediately";
1249
- products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
1849
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
1250
1850
  coupons: (({
1251
1851
  description: string | null;
1252
1852
  expiration_date: string | null;
1253
1853
  redemption_limit: number | null;
1854
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1855
+ duration: {
1856
+ count: number;
1857
+ period: "days" | "weeks" | "months" | "years";
1858
+ } | null;
1254
1859
  created_at: string;
1255
1860
  type: "amount";
1256
1861
  discount_amount: number;
1257
- currency: "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" | null;
1862
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
1258
1863
  } | {
1259
1864
  description: string | null;
1260
1865
  expiration_date: string | null;
1261
1866
  redemption_limit: number | null;
1867
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1868
+ duration: {
1869
+ count: number;
1870
+ period: "days" | "weeks" | "months" | "years";
1871
+ } | null;
1262
1872
  created_at: string;
1263
1873
  type: "percent";
1264
1874
  discount_percent: number;
@@ -1267,8 +1877,10 @@ export declare class HyperlineAPI {
1267
1877
  promotion_code_id: string | null;
1268
1878
  name: string | null;
1269
1879
  subscription_coupon_id: string;
1270
- repeat: "once" | "forever" | "custom";
1271
- product_ids: string[];
1880
+ repeat: "once" | "forever" | "custom" | "duration";
1881
+ duration_period: "days" | "weeks" | "months" | "years" | null;
1882
+ duration_count: number | null;
1883
+ product_ids: string[] | null;
1272
1884
  apply_at: string | null;
1273
1885
  expires_at: string | null;
1274
1886
  })[];
@@ -1283,13 +1895,14 @@ export declare class HyperlineAPI {
1283
1895
  id: string;
1284
1896
  name: string;
1285
1897
  } | null;
1898
+ template: {
1899
+ id: string;
1900
+ name: string;
1901
+ configurationId: string;
1902
+ } | null;
1286
1903
  checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
1287
1904
  payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
1288
1905
  payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
1289
- generate_draft_invoices: boolean;
1290
- generate_document: boolean;
1291
- document_name: string | null;
1292
- add_tax_to_document: boolean;
1293
1906
  contract_terms: {
1294
1907
  status: "active" | "pending" | "finished";
1295
1908
  activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
@@ -1309,51 +1922,213 @@ export declare class HyperlineAPI {
1309
1922
  current_period_ends_at: string | null;
1310
1923
  } | null;
1311
1924
  }) | null>;
1312
- getPlan(id: string): Promise<{
1925
+ reinstateSubscription(id: string): Promise<({
1313
1926
  id: string;
1314
- name: string;
1315
- description: string | null;
1927
+ name: string | null;
1928
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1929
+ status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
1930
+ purchase_order: string | null;
1931
+ customer_id: string;
1932
+ invoicing_entity_id: string | null;
1933
+ plan_id: string | null;
1934
+ template_id: string | null;
1935
+ checkout_session_id: string | null;
1936
+ crm_opportunity_id: string | null;
1937
+ minimum_invoice_fee: number | null;
1316
1938
  commitment_interval: {
1317
1939
  period: "days" | "weeks" | "months" | "years";
1318
1940
  count: number;
1319
1941
  } | null;
1320
- contract_start_strategy: "start_date" | "immediately" | "manual" | "manual_with_latest" | "quote_signature" | "checkout";
1321
- contract_start: string | null;
1322
- contract_end_strategy: "duration" | "manual" | "end_date";
1323
- contract_end: string | null;
1324
- contract_duration: {
1325
- period: "days" | "weeks" | "months" | "years" | "forever";
1326
- count: number | null;
1327
- } | null;
1328
1942
  renew_automatically: boolean;
1329
1943
  renew_for: {
1330
1944
  period: "days" | "weeks" | "months" | "years";
1331
- count: number | null;
1945
+ count: number;
1946
+ } | null;
1947
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
1948
+ starts_at: string | null;
1949
+ contract_start: string | null;
1950
+ contract_end: string | null;
1951
+ initial_billing_at: string | null;
1952
+ paused_at: string | null;
1953
+ reactivate_at: string | null;
1954
+ cancel_at: string | null;
1955
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
1956
+ cancellation_amount: number | null;
1957
+ cancellation_reason: string | null;
1958
+ cancellation_source: "portal" | "app" | "api" | "system" | null;
1959
+ estimated_arr: number | null;
1960
+ contract_value: number | null;
1961
+ current_period_started_at: string | null;
1962
+ current_period_ends_at: string | null;
1963
+ next_payment_at: string | null;
1964
+ next_payment_amount: number | null;
1965
+ renews_at: string | null;
1966
+ current_phase_id: string | null;
1967
+ display_shipping_details: boolean | null;
1968
+ properties: {
1969
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
1332
1970
  } | null;
1333
- products: (import("./_types.generated").components["schemas"]["PlanProductFee"] | import("./_types.generated").components["schemas"]["PlanProductSeat"] | import("./_types.generated").components["schemas"]["PlanProductDynamic"] | import("./_types.generated").components["schemas"]["PlanProductCredit"])[];
1334
1971
  custom_properties: {
1335
- [key: string]: string | number | boolean | null;
1972
+ [key: string]: string | number | boolean | string[] | null;
1336
1973
  } | null;
1337
- } | null>;
1338
- getPlans(skip?: number, take?: number): Promise<{
1339
- meta: {
1340
- total: number;
1341
- taken: number;
1342
- skipped: number;
1343
- };
1344
- data: import("./_types.generated").components["schemas"]["PlanSimple"][];
1345
- } | null>;
1346
- getInvoice(id: string): Promise<({
1974
+ invoice_schedule: "period_start" | "period_end" | null;
1975
+ generate_document: boolean;
1976
+ document_name: string | null;
1977
+ add_tax_to_document: boolean;
1978
+ generate_draft_invoices: boolean;
1979
+ do_not_charge_subscription: boolean;
1980
+ invoice_custom_note: string | null;
1981
+ created_at: string;
1982
+ updated_at: string;
1983
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
1984
+ coupons: (({
1985
+ description: string | null;
1986
+ expiration_date: string | null;
1987
+ redemption_limit: number | null;
1988
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1989
+ duration: {
1990
+ count: number;
1991
+ period: "days" | "weeks" | "months" | "years";
1992
+ } | null;
1993
+ created_at: string;
1994
+ type: "amount";
1995
+ discount_amount: number;
1996
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
1997
+ } | {
1998
+ description: string | null;
1999
+ expiration_date: string | null;
2000
+ redemption_limit: number | null;
2001
+ repeat: "once" | "forever" | "custom" | "duration" | null;
2002
+ duration: {
2003
+ count: number;
2004
+ period: "days" | "weeks" | "months" | "years";
2005
+ } | null;
2006
+ created_at: string;
2007
+ type: "percent";
2008
+ discount_percent: number;
2009
+ }) & {
2010
+ id: string | null;
2011
+ promotion_code_id: string | null;
2012
+ name: string | null;
2013
+ subscription_coupon_id: string;
2014
+ repeat: "once" | "forever" | "custom" | "duration";
2015
+ duration_period: "days" | "weeks" | "months" | "years" | null;
2016
+ duration_count: number | null;
2017
+ product_ids: string[] | null;
2018
+ apply_at: string | null;
2019
+ expires_at: string | null;
2020
+ })[];
2021
+ integrations: {
2022
+ entity_id: string;
2023
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2024
+ provider_account_id: string;
2025
+ }[];
2026
+ } & {
2027
+ phases: {
2028
+ id: string;
2029
+ name: string | null;
2030
+ type: "setup" | "trial" | "standard";
2031
+ status: "pending" | "active" | "finished";
2032
+ order: number;
2033
+ activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
2034
+ end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
2035
+ duration: {
2036
+ period: "days" | "weeks" | "months" | "years";
2037
+ count: number;
2038
+ } | null;
2039
+ billing_date_setting: "phase_start" | "specific_date";
2040
+ initial_billing_at: string | null;
2041
+ starts_at: string | null;
2042
+ ends_at: string | null;
2043
+ billing_cycle_alignment: "calendar_period" | "anniversary";
2044
+ do_not_invoice_phase: boolean;
2045
+ transition_calculation_method: "prorata" | "pay_in_full" | "none";
2046
+ transition_invoicing_schedule: "immediately";
2047
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
2048
+ coupons: (({
2049
+ description: string | null;
2050
+ expiration_date: string | null;
2051
+ redemption_limit: number | null;
2052
+ repeat: "once" | "forever" | "custom" | "duration" | null;
2053
+ duration: {
2054
+ count: number;
2055
+ period: "days" | "weeks" | "months" | "years";
2056
+ } | null;
2057
+ created_at: string;
2058
+ type: "amount";
2059
+ discount_amount: number;
2060
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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" | null;
2061
+ } | {
2062
+ description: string | null;
2063
+ expiration_date: string | null;
2064
+ redemption_limit: number | null;
2065
+ repeat: "once" | "forever" | "custom" | "duration" | null;
2066
+ duration: {
2067
+ count: number;
2068
+ period: "days" | "weeks" | "months" | "years";
2069
+ } | null;
2070
+ created_at: string;
2071
+ type: "percent";
2072
+ discount_percent: number;
2073
+ }) & {
2074
+ id: string | null;
2075
+ promotion_code_id: string | null;
2076
+ name: string | null;
2077
+ subscription_coupon_id: string;
2078
+ repeat: "once" | "forever" | "custom" | "duration";
2079
+ duration_period: "days" | "weeks" | "months" | "years" | null;
2080
+ duration_count: number | null;
2081
+ product_ids: string[] | null;
2082
+ apply_at: string | null;
2083
+ expires_at: string | null;
2084
+ })[];
2085
+ created_at: string;
2086
+ updated_at: string;
2087
+ }[];
2088
+ quote: {
2089
+ id: string;
2090
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
2091
+ } | null;
2092
+ plan: {
2093
+ id: string;
2094
+ name: string;
2095
+ } | null;
2096
+ template: {
2097
+ id: string;
2098
+ name: string;
2099
+ configurationId: string;
2100
+ } | null;
2101
+ checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
2102
+ payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
2103
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
2104
+ contract_terms: {
2105
+ status: "active" | "pending" | "finished";
2106
+ activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
2107
+ end_strategy: "end_date" | "duration" | "manual";
2108
+ starts_at: string | null;
2109
+ ends_at: string | null;
2110
+ duration: {
2111
+ period: "days" | "weeks" | "months" | "years";
2112
+ count: number;
2113
+ } | null;
2114
+ renew_automatically: boolean | ("true" | "false");
2115
+ renew_for_duration: {
2116
+ period: "days" | "weeks" | "months" | "years";
2117
+ count: number;
2118
+ } | null;
2119
+ current_period_started_at: string | null;
2120
+ current_period_ends_at: string | null;
2121
+ } | null;
2122
+ }) | null>;
2123
+ createInvoice(data: NonNullable<paths['/v1/invoices']['post']['requestBody']>['content']['application/json']): Promise<({
1347
2124
  id: string;
1348
2125
  number: string;
1349
2126
  type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
1350
2127
  document_name: string | null;
1351
- status: "draft" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "uncollectible";
2128
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
1352
2129
  reference: string | null;
1353
2130
  purchase_order: string | null;
1354
- original_invoice_id: string | null;
1355
- original_invoice_number: string | null;
1356
- currency: "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";
2131
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1357
2132
  source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
1358
2133
  total_amount: number;
1359
2134
  amount_due: number;
@@ -1378,13 +2153,17 @@ export declare class HyperlineAPI {
1378
2153
  email: string | null;
1379
2154
  external_id: string | null;
1380
2155
  vat_number: string | null;
2156
+ tax_id: string | null;
2157
+ local_tax_number: string | null;
2158
+ registration_number: string | null;
1381
2159
  address: import("./_types.generated").components["schemas"]["Address"];
1382
2160
  };
1383
2161
  seller: {
1384
2162
  id: string;
1385
2163
  name: string;
1386
2164
  tax_id: string | null;
1387
- address: import("./_types.generated").components["schemas"]["Address"];
2165
+ registration_number: string | null;
2166
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
1388
2167
  };
1389
2168
  subscription_id: string | null;
1390
2169
  period_starts_at: string | null;
@@ -1398,53 +2177,61 @@ export declare class HyperlineAPI {
1398
2177
  properties: {
1399
2178
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
1400
2179
  } | null;
2180
+ custom_properties: {
2181
+ [key: string]: string | number | boolean | string[] | null;
2182
+ } | null;
2183
+ additional_display_fields: ({
2184
+ type: "standard";
2185
+ field: "customer_id" | "subscription_id" | "quote_id";
2186
+ } | {
2187
+ type: "custom_property";
2188
+ slug: string;
2189
+ } | {
2190
+ type: "custom";
2191
+ label: string;
2192
+ value: string;
2193
+ })[] | null;
2194
+ original_invoice_id: string | null;
2195
+ original_invoice_number: string | null;
1401
2196
  line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2197
+ allocations?: {
2198
+ invoice_id: string;
2199
+ amount: number;
2200
+ }[];
1402
2201
  coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
1403
2202
  transactions: ({
1404
2203
  id: string;
1405
- type: "subscription" | "one_time" | "refund";
2204
+ type: "subscription" | "one_time" | "refund" | "chargeback";
1406
2205
  amount: number;
1407
- currency: "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";
2206
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1408
2207
  customer_id: string;
1409
2208
  provider_id: string | null;
1410
2209
  process_at: string;
2210
+ settled_at: string | null;
1411
2211
  refunded_at: string | null;
2212
+ original_transaction_id: string | null;
2213
+ reversed_at: string | null;
1412
2214
  last_refreshed_at: string | null;
1413
2215
  provider_fee: {
1414
2216
  amount: number;
1415
- currency: "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";
2217
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1416
2218
  exchange_rate: number | null;
1417
2219
  } | null;
1418
2220
  chargeback: {
1419
2221
  amount: number;
1420
2222
  last_chargeback_at: string;
1421
2223
  } | null;
2224
+ integrations: {
2225
+ entity_id: string;
2226
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2227
+ provider_account_id: string;
2228
+ }[];
1422
2229
  } & ({
1423
2230
  payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
1424
2231
  payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
1425
2232
  } | {
1426
2233
  payment_method_type: "transfer" | "transfer_automated";
1427
- bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
1428
- id: string;
1429
- currency: "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";
1430
- bank_name: string | null;
1431
- } & ({
1432
- format: "iban_bic_swift";
1433
- iban: string;
1434
- bic_swift: string | null;
1435
- } | {
1436
- format: "sort_code_account_number";
1437
- sort_code: string;
1438
- account_number: string;
1439
- } | {
1440
- format: "account_number_routing_number";
1441
- account_number: string;
1442
- routing_number: string;
1443
- } | {
1444
- format: "account_number_bic_swift";
1445
- account_number: string;
1446
- bic_swift: string;
1447
- })) | null);
2234
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
1448
2235
  } | {
1449
2236
  payment_method_type: "wallet";
1450
2237
  wallet_id: string;
@@ -1454,45 +2241,26 @@ export declare class HyperlineAPI {
1454
2241
  status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
1455
2242
  } | {
1456
2243
  status: "failed";
1457
- error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
2244
+ error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "mandate_invalid" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
1458
2245
  error_message: string | null;
1459
2246
  }))[];
2247
+ public_url: string;
1460
2248
  } & {
1461
2249
  integrations: {
1462
2250
  entity_id: string;
1463
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
2251
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1464
2252
  provider_account_id: string;
1465
2253
  }[];
1466
2254
  }) | null>;
1467
- getInvoices(skip?: number, take?: number, query?: operations['getInvoices']['parameters']['query']): Promise<{
1468
- meta: {
1469
- total: number;
1470
- taken: number;
1471
- skipped: number;
1472
- };
1473
- data: import("./_types.generated").components["schemas"]["Invoice"][];
1474
- } | null>;
1475
- getInvoicesByCustomerId(id: string, filters?: Partial<operations['getInvoices']['parameters']['query']>): Promise<{
1476
- meta: {
1477
- total: number;
1478
- taken: number;
1479
- skipped: number;
1480
- };
1481
- data: import("./_types.generated").components["schemas"]["Invoice"][];
1482
- } | null>;
1483
- getInvoiceDownload(id: string): Promise<string | null>;
1484
- getAllInvoices(items?: paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getInvoices']['parameters']['query']): Promise<paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']>;
1485
- voidInvoice(id: string, data?: NonNullable<paths['/v1/invoices/{id}/void']['post']['requestBody']>['content']['application/json']): Promise<({
2255
+ updateInvoice(id: string, data: NonNullable<paths['/v1/invoices/{id}']['patch']['requestBody']>['content']['application/json']): Promise<({
1486
2256
  id: string;
1487
2257
  number: string;
1488
2258
  type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
1489
2259
  document_name: string | null;
1490
- status: "draft" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "uncollectible";
2260
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
1491
2261
  reference: string | null;
1492
2262
  purchase_order: string | null;
1493
- original_invoice_id: string | null;
1494
- original_invoice_number: string | null;
1495
- currency: "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";
2263
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1496
2264
  source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
1497
2265
  total_amount: number;
1498
2266
  amount_due: number;
@@ -1517,13 +2285,17 @@ export declare class HyperlineAPI {
1517
2285
  email: string | null;
1518
2286
  external_id: string | null;
1519
2287
  vat_number: string | null;
2288
+ tax_id: string | null;
2289
+ local_tax_number: string | null;
2290
+ registration_number: string | null;
1520
2291
  address: import("./_types.generated").components["schemas"]["Address"];
1521
2292
  };
1522
2293
  seller: {
1523
2294
  id: string;
1524
2295
  name: string;
1525
2296
  tax_id: string | null;
1526
- address: import("./_types.generated").components["schemas"]["Address"];
2297
+ registration_number: string | null;
2298
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
1527
2299
  };
1528
2300
  subscription_id: string | null;
1529
2301
  period_starts_at: string | null;
@@ -1537,53 +2309,61 @@ export declare class HyperlineAPI {
1537
2309
  properties: {
1538
2310
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
1539
2311
  } | null;
2312
+ custom_properties: {
2313
+ [key: string]: string | number | boolean | string[] | null;
2314
+ } | null;
2315
+ additional_display_fields: ({
2316
+ type: "standard";
2317
+ field: "customer_id" | "subscription_id" | "quote_id";
2318
+ } | {
2319
+ type: "custom_property";
2320
+ slug: string;
2321
+ } | {
2322
+ type: "custom";
2323
+ label: string;
2324
+ value: string;
2325
+ })[] | null;
2326
+ original_invoice_id: string | null;
2327
+ original_invoice_number: string | null;
1540
2328
  line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2329
+ allocations?: {
2330
+ invoice_id: string;
2331
+ amount: number;
2332
+ }[];
1541
2333
  coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
1542
2334
  transactions: ({
1543
2335
  id: string;
1544
- type: "subscription" | "one_time" | "refund";
2336
+ type: "subscription" | "one_time" | "refund" | "chargeback";
1545
2337
  amount: number;
1546
- currency: "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";
2338
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1547
2339
  customer_id: string;
1548
2340
  provider_id: string | null;
1549
2341
  process_at: string;
2342
+ settled_at: string | null;
1550
2343
  refunded_at: string | null;
2344
+ original_transaction_id: string | null;
2345
+ reversed_at: string | null;
1551
2346
  last_refreshed_at: string | null;
1552
2347
  provider_fee: {
1553
2348
  amount: number;
1554
- currency: "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";
2349
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
1555
2350
  exchange_rate: number | null;
1556
2351
  } | null;
1557
2352
  chargeback: {
1558
2353
  amount: number;
1559
2354
  last_chargeback_at: string;
1560
2355
  } | null;
2356
+ integrations: {
2357
+ entity_id: string;
2358
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2359
+ provider_account_id: string;
2360
+ }[];
1561
2361
  } & ({
1562
2362
  payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
1563
2363
  payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
1564
2364
  } | {
1565
2365
  payment_method_type: "transfer" | "transfer_automated";
1566
- bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
1567
- id: string;
1568
- currency: "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";
1569
- bank_name: string | null;
1570
- } & ({
1571
- format: "iban_bic_swift";
1572
- iban: string;
1573
- bic_swift: string | null;
1574
- } | {
1575
- format: "sort_code_account_number";
1576
- sort_code: string;
1577
- account_number: string;
1578
- } | {
1579
- format: "account_number_routing_number";
1580
- account_number: string;
1581
- routing_number: string;
1582
- } | {
1583
- format: "account_number_bic_swift";
1584
- account_number: string;
1585
- bic_swift: string;
1586
- })) | null);
2366
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
1587
2367
  } | {
1588
2368
  payment_method_type: "wallet";
1589
2369
  wallet_id: string;
@@ -1593,109 +2373,535 @@ export declare class HyperlineAPI {
1593
2373
  status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
1594
2374
  } | {
1595
2375
  status: "failed";
1596
- error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
2376
+ error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "mandate_invalid" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
1597
2377
  error_message: string | null;
1598
2378
  }))[];
2379
+ public_url: string;
1599
2380
  } & {
1600
2381
  integrations: {
1601
2382
  entity_id: string;
1602
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
2383
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1603
2384
  provider_account_id: string;
1604
2385
  }[];
1605
2386
  }) | null>;
1606
- deleteInvoice(id: string): Promise<null | undefined>;
1607
- getCustomerPaymentMethods(customerId: string): Promise<{
1608
- meta: {
1609
- total: number;
1610
- taken: number;
1611
- skipped: number;
1612
- };
1613
- data: (import("./_types.generated").components["schemas"]["PaymentMethod"] & (import("./_types.generated").components["schemas"]["PaymentMethodCard"] | import("./_types.generated").components["schemas"]["PaymentMethodDirectDebit"] | import("./_types.generated").components["schemas"]["PaymentMethodStripeLink"]))[];
1614
- } | null>;
1615
- getPaymentMethod(customerId: string, paymentMethodId: string): Promise<({
1616
- id: string;
1617
- } & {
1618
- status: "active" | "pending";
1619
- } & {
1620
- type: "card" | "apple_pay" | "google_pay";
1621
- last_4_digits: number | null;
1622
- expiration_date: string | null;
1623
- brand: string | null;
1624
- } & {
1625
- integration: {
1626
- entity_id: string;
1627
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
1628
- provider_account_id: string;
1629
- } | null;
1630
- }) | ({
2387
+ getInvoice(id: string): Promise<({
1631
2388
  id: string;
2389
+ number: string;
2390
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
2391
+ document_name: string | null;
2392
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
2393
+ reference: string | null;
2394
+ purchase_order: string | null;
2395
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2396
+ source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
2397
+ total_amount: number;
2398
+ amount_due: number;
2399
+ amount_paid: number;
2400
+ amount_fixed: number;
2401
+ amount_excluding_tax: number;
2402
+ tax_amount: number;
2403
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
2404
+ discount_amount: number;
2405
+ conversion_rate: number | null;
2406
+ converted_amount: number | null;
2407
+ converted_at: string | null;
2408
+ payment_method_id: string | null;
2409
+ bank_account_id: string | null;
2410
+ custom_note: string | null;
2411
+ additional_info: string | null;
2412
+ footer: string | null;
2413
+ customer: {
2414
+ id: string;
2415
+ name: string;
2416
+ email: string | null;
2417
+ external_id: string | null;
2418
+ tax_id: string | null;
2419
+ local_tax_number: string | null;
2420
+ registration_number: string | null;
2421
+ address: import("./_types.generated").components["schemas"]["Address"];
2422
+ };
2423
+ seller: {
2424
+ id: string;
2425
+ name: string;
2426
+ tax_id: string | null;
2427
+ registration_number: string | null;
2428
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
2429
+ };
2430
+ subscription_id: string | null;
2431
+ period_starts_at: string | null;
2432
+ period_ends_at: string | null;
2433
+ due_at: string;
2434
+ refunded_at: string | null;
2435
+ grace_period_ended_at: string | null;
2436
+ settled_at: string | null;
2437
+ updated_at: string | null;
2438
+ properties: {
2439
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
2440
+ } | null;
2441
+ custom_properties: {
2442
+ [key: string]: string | number | boolean | string[] | null;
2443
+ } | null;
2444
+ additional_display_fields: ({
2445
+ type: "standard";
2446
+ field: "customer_id" | "subscription_id" | "quote_id";
2447
+ } | {
2448
+ type: "custom_property";
2449
+ slug: string;
2450
+ } | {
2451
+ type: "custom";
2452
+ label: string;
2453
+ value: string;
2454
+ })[] | null;
2455
+ original_invoice_id: string | null;
2456
+ original_invoice_number: string | null;
2457
+ line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2458
+ allocations?: {
2459
+ invoice_id: string;
2460
+ amount: number;
2461
+ }[];
2462
+ coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
2463
+ transactions: ({
2464
+ id: string;
2465
+ type: "subscription" | "one_time" | "refund" | "chargeback";
2466
+ amount: number;
2467
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2468
+ customer_id: string;
2469
+ provider_id: string | null;
2470
+ process_at: string;
2471
+ settled_at: string | null;
2472
+ refunded_at: string | null;
2473
+ original_transaction_id: string | null;
2474
+ reversed_at: string | null;
2475
+ last_refreshed_at: string | null;
2476
+ provider_fee: {
2477
+ amount: number;
2478
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2479
+ exchange_rate: number | null;
2480
+ } | null;
2481
+ chargeback: {
2482
+ amount: number;
2483
+ last_chargeback_at: string;
2484
+ } | null;
2485
+ integrations: {
2486
+ entity_id: string;
2487
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2488
+ provider_account_id: string;
2489
+ }[];
2490
+ } & ({
2491
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
2492
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
2493
+ } | {
2494
+ payment_method_type: "transfer" | "transfer_automated";
2495
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
2496
+ } | {
2497
+ payment_method_type: "wallet";
2498
+ wallet_id: string;
2499
+ } | {
2500
+ payment_method_type: "external";
2501
+ }) & ({
2502
+ status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
2503
+ } | {
2504
+ status: "failed";
2505
+ error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "mandate_invalid" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
2506
+ error_message: string | null;
2507
+ }))[];
2508
+ public_url: string;
2509
+ issued_at: string;
1632
2510
  } & {
1633
- status: "errored";
1634
- error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
1635
- } & {
1636
- type: "card" | "apple_pay" | "google_pay";
1637
- last_4_digits: number | null;
1638
- expiration_date: string | null;
1639
- brand: string | null;
1640
- } & {
1641
- integration: {
2511
+ integrations: {
1642
2512
  entity_id: string;
1643
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
2513
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1644
2514
  provider_account_id: string;
1645
- } | null;
1646
- }) | ({
2515
+ }[];
2516
+ }) | null>;
2517
+ validateInvoice(id: string): Promise<({
1647
2518
  id: string;
2519
+ number: string;
2520
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
2521
+ document_name: string | null;
2522
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
2523
+ reference: string | null;
2524
+ purchase_order: string | null;
2525
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2526
+ source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
2527
+ total_amount: number;
2528
+ amount_due: number;
2529
+ amount_paid: number;
2530
+ amount_fixed: number;
2531
+ amount_excluding_tax: number;
2532
+ tax_rate: number;
2533
+ tax_amount: number;
2534
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
2535
+ discount_amount: number;
2536
+ conversion_rate: number | null;
2537
+ converted_amount: number | null;
2538
+ converted_at: string | null;
2539
+ payment_method_id: string | null;
2540
+ bank_account_id: string | null;
2541
+ custom_note: string | null;
2542
+ additional_info: string | null;
2543
+ footer: string | null;
2544
+ customer: {
2545
+ id: string;
2546
+ name: string;
2547
+ email: string | null;
2548
+ external_id: string | null;
2549
+ vat_number: string | null;
2550
+ tax_id: string | null;
2551
+ local_tax_number: string | null;
2552
+ registration_number: string | null;
2553
+ address: import("./_types.generated").components["schemas"]["Address"];
2554
+ };
2555
+ seller: {
2556
+ id: string;
2557
+ name: string;
2558
+ tax_id: string | null;
2559
+ registration_number: string | null;
2560
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
2561
+ };
2562
+ subscription_id: string | null;
2563
+ period_starts_at: string | null;
2564
+ period_ends_at: string | null;
2565
+ emitted_at: string;
2566
+ due_at: string;
2567
+ refunded_at: string | null;
2568
+ grace_period_ended_at: string | null;
2569
+ settled_at: string | null;
2570
+ updated_at: string | null;
2571
+ properties: {
2572
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
2573
+ } | null;
2574
+ custom_properties: {
2575
+ [key: string]: string | number | boolean | string[] | null;
2576
+ } | null;
2577
+ additional_display_fields: ({
2578
+ type: "standard";
2579
+ field: "customer_id" | "subscription_id" | "quote_id";
2580
+ } | {
2581
+ type: "custom_property";
2582
+ slug: string;
2583
+ } | {
2584
+ type: "custom";
2585
+ label: string;
2586
+ value: string;
2587
+ })[] | null;
2588
+ original_invoice_id: string | null;
2589
+ original_invoice_number: string | null;
2590
+ line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2591
+ allocations?: {
2592
+ invoice_id: string;
2593
+ amount: number;
2594
+ }[];
2595
+ coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
2596
+ transactions: ({
2597
+ id: string;
2598
+ type: "subscription" | "one_time" | "refund" | "chargeback";
2599
+ amount: number;
2600
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2601
+ customer_id: string;
2602
+ provider_id: string | null;
2603
+ process_at: string;
2604
+ settled_at: string | null;
2605
+ refunded_at: string | null;
2606
+ original_transaction_id: string | null;
2607
+ reversed_at: string | null;
2608
+ last_refreshed_at: string | null;
2609
+ provider_fee: {
2610
+ amount: number;
2611
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2612
+ exchange_rate: number | null;
2613
+ } | null;
2614
+ chargeback: {
2615
+ amount: number;
2616
+ last_chargeback_at: string;
2617
+ } | null;
2618
+ integrations: {
2619
+ entity_id: string;
2620
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2621
+ provider_account_id: string;
2622
+ }[];
2623
+ } & ({
2624
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
2625
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
2626
+ } | {
2627
+ payment_method_type: "transfer" | "transfer_automated";
2628
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
2629
+ } | {
2630
+ payment_method_type: "wallet";
2631
+ wallet_id: string;
2632
+ } | {
2633
+ payment_method_type: "external";
2634
+ }) & ({
2635
+ status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
2636
+ } | {
2637
+ status: "failed";
2638
+ error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "mandate_invalid" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
2639
+ error_message: string | null;
2640
+ }))[];
2641
+ public_url: string;
1648
2642
  } & {
1649
- status: "active" | "pending";
2643
+ integrations: {
2644
+ entity_id: string;
2645
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2646
+ provider_account_id: string;
2647
+ }[];
2648
+ }) | null>;
2649
+ getInvoices(query?: paths['/v2/invoices']['get']['parameters']['query']): Promise<{
2650
+ data: import("./_types.generated").components["schemas"]["Invoice"][];
2651
+ next_cursor: string | null;
2652
+ has_more: boolean;
2653
+ total?: number;
2654
+ } | null>;
2655
+ getInvoicesByCustomerId(id: string, filters?: paths['/v2/invoices']['get']['parameters']['query']): Promise<{
2656
+ data: import("./_types.generated").components["schemas"]["Invoice"][];
2657
+ next_cursor: string | null;
2658
+ has_more: boolean;
2659
+ total?: number;
2660
+ } | null>;
2661
+ getInvoiceDownload(id: string): Promise<string | null>;
2662
+ getAllInvoices(items?: paths['/v2/invoices']['get']['responses'][200]['content']['application/json']['data'], query?: paths['/v2/invoices']['get']['parameters']['query']): Promise<paths['/v2/invoices']['get']['responses'][200]['content']['application/json']['data']>;
2663
+ voidInvoice(id: string, data?: NonNullable<paths['/v1/invoices/{id}/void']['post']['requestBody']>['content']['application/json']): Promise<({
2664
+ id: string;
2665
+ number: string;
2666
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
2667
+ document_name: string | null;
2668
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
2669
+ reference: string | null;
2670
+ purchase_order: string | null;
2671
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2672
+ source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
2673
+ total_amount: number;
2674
+ amount_due: number;
2675
+ amount_paid: number;
2676
+ amount_fixed: number;
2677
+ amount_excluding_tax: number;
2678
+ tax_rate: number;
2679
+ tax_amount: number;
2680
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
2681
+ discount_amount: number;
2682
+ conversion_rate: number | null;
2683
+ converted_amount: number | null;
2684
+ converted_at: string | null;
2685
+ payment_method_id: string | null;
2686
+ bank_account_id: string | null;
2687
+ custom_note: string | null;
2688
+ additional_info: string | null;
2689
+ footer: string | null;
2690
+ customer: {
2691
+ id: string;
2692
+ name: string;
2693
+ email: string | null;
2694
+ external_id: string | null;
2695
+ vat_number: string | null;
2696
+ tax_id: string | null;
2697
+ local_tax_number: string | null;
2698
+ registration_number: string | null;
2699
+ address: import("./_types.generated").components["schemas"]["Address"];
2700
+ };
2701
+ seller: {
2702
+ id: string;
2703
+ name: string;
2704
+ tax_id: string | null;
2705
+ registration_number: string | null;
2706
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
2707
+ };
2708
+ subscription_id: string | null;
2709
+ period_starts_at: string | null;
2710
+ period_ends_at: string | null;
2711
+ emitted_at: string;
2712
+ due_at: string;
2713
+ refunded_at: string | null;
2714
+ grace_period_ended_at: string | null;
2715
+ settled_at: string | null;
2716
+ updated_at: string | null;
2717
+ properties: {
2718
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
2719
+ } | null;
2720
+ custom_properties: {
2721
+ [key: string]: string | number | boolean | string[] | null;
2722
+ } | null;
2723
+ additional_display_fields: ({
2724
+ type: "standard";
2725
+ field: "customer_id" | "subscription_id" | "quote_id";
2726
+ } | {
2727
+ type: "custom_property";
2728
+ slug: string;
2729
+ } | {
2730
+ type: "custom";
2731
+ label: string;
2732
+ value: string;
2733
+ })[] | null;
2734
+ original_invoice_id: string | null;
2735
+ original_invoice_number: string | null;
2736
+ line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2737
+ allocations?: {
2738
+ invoice_id: string;
2739
+ amount: number;
2740
+ }[];
2741
+ coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
2742
+ transactions: ({
2743
+ id: string;
2744
+ type: "subscription" | "one_time" | "refund" | "chargeback";
2745
+ amount: number;
2746
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2747
+ customer_id: string;
2748
+ provider_id: string | null;
2749
+ process_at: string;
2750
+ settled_at: string | null;
2751
+ refunded_at: string | null;
2752
+ original_transaction_id: string | null;
2753
+ reversed_at: string | null;
2754
+ last_refreshed_at: string | null;
2755
+ provider_fee: {
2756
+ amount: number;
2757
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "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";
2758
+ exchange_rate: number | null;
2759
+ } | null;
2760
+ chargeback: {
2761
+ amount: number;
2762
+ last_chargeback_at: string;
2763
+ } | null;
2764
+ integrations: {
2765
+ entity_id: string;
2766
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2767
+ provider_account_id: string;
2768
+ }[];
2769
+ } & ({
2770
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
2771
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
2772
+ } | {
2773
+ payment_method_type: "transfer" | "transfer_automated";
2774
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
2775
+ } | {
2776
+ payment_method_type: "wallet";
2777
+ wallet_id: string;
2778
+ } | {
2779
+ payment_method_type: "external";
2780
+ }) & ({
2781
+ status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
2782
+ } | {
2783
+ status: "failed";
2784
+ error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "mandate_invalid" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
2785
+ error_message: string | null;
2786
+ }))[];
2787
+ public_url: string;
1650
2788
  } & {
2789
+ integrations: {
2790
+ entity_id: string;
2791
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2792
+ provider_account_id: string;
2793
+ }[];
2794
+ }) | null>;
2795
+ deleteInvoice(id: string): Promise<null | undefined>;
2796
+ getCustomerPaymentMethods(customerId: string): Promise<{
2797
+ meta: {
2798
+ total: number;
2799
+ taken: number;
2800
+ skipped: number;
2801
+ };
2802
+ data: (import("./_types.generated").components["schemas"]["PaymentMethod"] & ({
2803
+ id: string;
2804
+ status: "active" | "pending" | "expired" | "errored";
2805
+ type: "card" | "apple_pay" | "google_pay";
2806
+ last_4_digits: number | null;
2807
+ expiration_date: string | null;
2808
+ brand: string | null;
2809
+ } | {
2810
+ id: string;
2811
+ status: "errored";
2812
+ error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
2813
+ type: "card" | "apple_pay" | "google_pay";
2814
+ last_4_digits: number | null;
2815
+ expiration_date: string | null;
2816
+ brand: string | null;
2817
+ } | {
2818
+ id: string;
2819
+ status: "active" | "pending" | "expired" | "errored";
2820
+ type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
2821
+ account_number_ending: string | null;
2822
+ } | {
2823
+ id: string;
2824
+ status: "errored";
2825
+ error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
2826
+ type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
2827
+ account_number_ending: string | null;
2828
+ } | {
2829
+ id: string;
2830
+ status: "active" | "pending" | "expired" | "errored";
2831
+ type: "stripe_link";
2832
+ } | {
2833
+ id: string;
2834
+ status: "errored";
2835
+ error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
2836
+ type: "stripe_link";
2837
+ }))[];
2838
+ } | null>;
2839
+ getPaymentMethod(customerId: string, paymentMethodId: string): Promise<{
2840
+ id: string;
2841
+ status: "active" | "pending" | "expired" | "errored";
2842
+ type: "card" | "apple_pay" | "google_pay";
2843
+ last_4_digits: number | null;
2844
+ expiration_date: string | null;
2845
+ brand: string | null;
2846
+ integration: {
2847
+ entity_id: string;
2848
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2849
+ provider_account_id: string;
2850
+ } | null;
2851
+ } | {
2852
+ id: string;
2853
+ status: "errored";
2854
+ error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
2855
+ type: "card" | "apple_pay" | "google_pay";
2856
+ last_4_digits: number | null;
2857
+ expiration_date: string | null;
2858
+ brand: string | null;
2859
+ integration: {
2860
+ entity_id: string;
2861
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2862
+ provider_account_id: string;
2863
+ } | null;
2864
+ } | {
2865
+ id: string;
2866
+ status: "active" | "pending" | "expired" | "errored";
1651
2867
  type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
1652
2868
  account_number_ending: string | null;
1653
- } & {
1654
2869
  integration: {
1655
2870
  entity_id: string;
1656
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
2871
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1657
2872
  provider_account_id: string;
1658
2873
  } | null;
1659
- }) | ({
2874
+ } | {
1660
2875
  id: string;
1661
- } & {
1662
2876
  status: "errored";
1663
- error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
1664
- } & {
2877
+ error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
1665
2878
  type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
1666
2879
  account_number_ending: string | null;
1667
- } & {
1668
2880
  integration: {
1669
2881
  entity_id: string;
1670
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
2882
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1671
2883
  provider_account_id: string;
1672
2884
  } | null;
1673
- }) | ({
2885
+ } | {
1674
2886
  id: string;
1675
- } & {
1676
- status: "active" | "pending";
1677
- } & {
2887
+ status: "active" | "pending" | "expired" | "errored";
1678
2888
  type: "stripe_link";
1679
- } & {
1680
2889
  integration: {
1681
2890
  entity_id: string;
1682
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
2891
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1683
2892
  provider_account_id: string;
1684
2893
  } | null;
1685
- }) | ({
2894
+ } | {
1686
2895
  id: string;
1687
- } & {
1688
2896
  status: "errored";
1689
- error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
1690
- } & {
2897
+ error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
1691
2898
  type: "stripe_link";
1692
- } & {
1693
2899
  integration: {
1694
2900
  entity_id: string;
1695
- provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
2901
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
1696
2902
  provider_account_id: string;
1697
2903
  } | null;
1698
- }) | null>;
2904
+ } | null>;
1699
2905
  createBillableEvent(data: CreateBillableEvent[]): Promise<BillableEvents | null>;
1700
2906
  getComponentToken(data: {
1701
2907
  customer_id: string;