@vrplatform/hyperline-client 1.0.29 → 1.0.31
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.
- package/build/main/_types.generated.d.ts +44928 -16283
- package/build/main/_types.generated.js.map +1 -1
- package/build/main/client.d.ts +722 -405
- package/build/main/client.js +40 -62
- package/build/main/client.js.map +1 -1
- package/build/main/const.d.ts +1 -0
- package/build/main/const.js +1 -0
- package/build/main/const.js.map +1 -1
- package/build/main/types.d.ts +1 -0
- package/build/main/types.js.map +1 -1
- package/build/main/utils/calculateMrr.d.ts +3 -3
- package/build/main/utils/calculateMrr.js +1 -1
- package/build/main/utils/calculateMrr.js.map +1 -1
- package/build/module/_types.generated.d.ts +44928 -16283
- package/build/module/_types.generated.js.map +1 -1
- package/build/module/client.d.ts +722 -405
- package/build/module/client.js +40 -62
- package/build/module/client.js.map +1 -1
- package/build/module/const.d.ts +1 -0
- package/build/module/const.js +1 -0
- package/build/module/const.js.map +1 -1
- package/build/module/types.d.ts +1 -0
- package/build/module/types.js.map +1 -1
- package/build/module/utils/calculateMrr.d.ts +3 -3
- package/build/module/utils/calculateMrr.js +1 -1
- package/build/module/utils/calculateMrr.js.map +1 -1
- package/package.json +4 -4
- package/src/_types.generated.ts +44918 -16274
- package/src/client.ts +56 -97
- package/src/const.ts +2 -1
- package/src/types.ts +1 -0
- package/src/utils/calculateMrr.ts +5 -4
package/build/main/client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
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" | "
|
|
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" | "
|
|
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
|
|
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" | "
|
|
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" | "
|
|
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
|
|
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,6 +95,8 @@ 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;
|
|
@@ -100,31 +106,44 @@ export declare class HyperlineAPI {
|
|
|
100
106
|
name: string;
|
|
101
107
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
102
108
|
status: "active" | "archived";
|
|
103
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
104
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
109
|
+
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;
|
|
110
|
+
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;
|
|
111
|
+
domain: string | null;
|
|
112
|
+
tax_ids: {
|
|
113
|
+
value: string;
|
|
114
|
+
status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
|
|
115
|
+
}[];
|
|
116
|
+
local_tax_number: string | null;
|
|
117
|
+
tax_rate_custom: number | null;
|
|
118
|
+
taxability: "taxable" | "exempt";
|
|
108
119
|
registration_number: string | null;
|
|
109
|
-
|
|
110
|
-
|
|
120
|
+
is_government_affiliated: boolean;
|
|
121
|
+
language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
|
|
122
|
+
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
123
|
external_id: string | null;
|
|
112
124
|
properties: {
|
|
113
125
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
114
126
|
} | null;
|
|
115
127
|
custom_properties: {
|
|
116
|
-
[key: string]: string | number | boolean | null;
|
|
128
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
117
129
|
} | null;
|
|
118
130
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
131
|
+
shipping_address: {
|
|
132
|
+
name?: string | null;
|
|
133
|
+
line1?: string | null;
|
|
134
|
+
line2?: string | null;
|
|
135
|
+
city?: string | null;
|
|
136
|
+
zip?: string | null;
|
|
137
|
+
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;
|
|
138
|
+
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;
|
|
139
|
+
} | null;
|
|
119
140
|
billing_email: string | null;
|
|
120
141
|
invoice_emails: string[];
|
|
121
142
|
invoicing_entity_id: string;
|
|
122
143
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
144
|
+
force_invoice_draft: boolean | ("true" | "false");
|
|
123
145
|
price_book_id: string | null;
|
|
124
146
|
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
147
|
subscriptions: {
|
|
129
148
|
id: string;
|
|
130
149
|
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
@@ -133,52 +152,37 @@ export declare class HyperlineAPI {
|
|
|
133
152
|
plan_id: string | null;
|
|
134
153
|
checkout_session_id: string | null;
|
|
135
154
|
}[];
|
|
136
|
-
|
|
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
|
-
};
|
|
155
|
+
segment_ids: string[];
|
|
155
156
|
integrations: {
|
|
156
157
|
entity_id: string;
|
|
157
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
158
|
+
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
159
|
provider_account_id: string;
|
|
159
160
|
}[];
|
|
160
|
-
|
|
161
|
-
|
|
161
|
+
created_at: string;
|
|
162
|
+
updated_at: string;
|
|
163
|
+
deleted_at: string | null;
|
|
164
|
+
owner_id: string | null;
|
|
165
|
+
owner: {
|
|
162
166
|
id: string;
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
167
|
+
email: string;
|
|
168
|
+
first_name: string | null;
|
|
169
|
+
last_name: string | null;
|
|
170
|
+
picture_url: string | null;
|
|
171
|
+
} | null;
|
|
172
|
+
followers: {
|
|
173
|
+
id: string;
|
|
174
|
+
email: string;
|
|
175
|
+
first_name: string | null;
|
|
176
|
+
last_name: string | null;
|
|
177
|
+
picture_url: string | null;
|
|
178
|
+
}[];
|
|
179
|
+
payment_terms: number | null;
|
|
180
|
+
payment_initiation_delay: number | null;
|
|
181
|
+
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
182
|
+
payment_method_id: string | null;
|
|
183
|
+
} & {
|
|
184
|
+
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
185
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
|
|
182
186
|
organisation_id: string | null;
|
|
183
187
|
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
184
188
|
}) | null>;
|
|
@@ -187,31 +191,44 @@ export declare class HyperlineAPI {
|
|
|
187
191
|
name: string;
|
|
188
192
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
189
193
|
status: "active" | "archived";
|
|
190
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
191
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
194
|
+
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;
|
|
195
|
+
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;
|
|
196
|
+
domain: string | null;
|
|
197
|
+
tax_ids: {
|
|
198
|
+
value: string;
|
|
199
|
+
status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
|
|
200
|
+
}[];
|
|
201
|
+
local_tax_number: string | null;
|
|
202
|
+
tax_rate_custom: number | null;
|
|
203
|
+
taxability: "taxable" | "exempt";
|
|
195
204
|
registration_number: string | null;
|
|
196
|
-
|
|
197
|
-
|
|
205
|
+
is_government_affiliated: boolean;
|
|
206
|
+
language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
|
|
207
|
+
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
208
|
external_id: string | null;
|
|
199
209
|
properties: {
|
|
200
210
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
201
211
|
} | null;
|
|
202
212
|
custom_properties: {
|
|
203
|
-
[key: string]: string | number | boolean | null;
|
|
213
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
204
214
|
} | null;
|
|
205
215
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
216
|
+
shipping_address: {
|
|
217
|
+
name?: string | null;
|
|
218
|
+
line1?: string | null;
|
|
219
|
+
line2?: string | null;
|
|
220
|
+
city?: string | null;
|
|
221
|
+
zip?: string | null;
|
|
222
|
+
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;
|
|
223
|
+
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;
|
|
224
|
+
} | null;
|
|
206
225
|
billing_email: string | null;
|
|
207
226
|
invoice_emails: string[];
|
|
208
227
|
invoicing_entity_id: string;
|
|
209
228
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
229
|
+
force_invoice_draft: boolean | ("true" | "false");
|
|
210
230
|
price_book_id: string | null;
|
|
211
231
|
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
232
|
subscriptions: {
|
|
216
233
|
id: string;
|
|
217
234
|
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
@@ -220,49 +237,92 @@ export declare class HyperlineAPI {
|
|
|
220
237
|
plan_id: string | null;
|
|
221
238
|
checkout_session_id: string | null;
|
|
222
239
|
}[];
|
|
240
|
+
segment_ids: string[];
|
|
241
|
+
integrations: {
|
|
242
|
+
entity_id: string;
|
|
243
|
+
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";
|
|
244
|
+
provider_account_id: string;
|
|
245
|
+
}[];
|
|
223
246
|
created_at: string;
|
|
224
247
|
updated_at: string;
|
|
225
248
|
deleted_at: string | null;
|
|
249
|
+
owner_id: string | null;
|
|
250
|
+
owner: {
|
|
251
|
+
id: string;
|
|
252
|
+
email: string;
|
|
253
|
+
first_name: string | null;
|
|
254
|
+
last_name: string | null;
|
|
255
|
+
picture_url: string | null;
|
|
256
|
+
} | null;
|
|
257
|
+
followers: {
|
|
258
|
+
id: string;
|
|
259
|
+
email: string;
|
|
260
|
+
first_name: string | null;
|
|
261
|
+
last_name: string | null;
|
|
262
|
+
picture_url: string | null;
|
|
263
|
+
}[];
|
|
264
|
+
payment_terms: number | null;
|
|
265
|
+
payment_initiation_delay: number | null;
|
|
266
|
+
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
267
|
+
payment_method_id: string | null;
|
|
226
268
|
} | undefined>;
|
|
227
|
-
getCustomers(
|
|
228
|
-
meta: {
|
|
229
|
-
total: number;
|
|
230
|
-
taken: number;
|
|
231
|
-
skipped: number;
|
|
232
|
-
};
|
|
269
|
+
getCustomers(query?: paths['/v2/customers']['get']['parameters']['query']): Promise<{
|
|
233
270
|
data: import("./_types.generated").components["schemas"]["Customer"][];
|
|
271
|
+
next_cursor: string | null;
|
|
272
|
+
has_more: boolean;
|
|
273
|
+
total?: number;
|
|
234
274
|
} | null>;
|
|
235
|
-
getAllCustomers(items?: paths['/
|
|
275
|
+
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
276
|
createCustomer(data: NonNullable<paths['/v1/customers']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
237
277
|
id: string;
|
|
238
278
|
name: string;
|
|
239
279
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
240
280
|
status: "active" | "archived";
|
|
241
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
242
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "
|
|
281
|
+
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;
|
|
282
|
+
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;
|
|
283
|
+
domain: string | null;
|
|
243
284
|
vat_number: string | null;
|
|
244
285
|
vat_number_valid: boolean;
|
|
245
286
|
vat_rate_custom: number | null;
|
|
287
|
+
tax_ids: {
|
|
288
|
+
value: string;
|
|
289
|
+
status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
|
|
290
|
+
}[];
|
|
291
|
+
local_tax_number: string | null;
|
|
292
|
+
tax_rate_custom: number | null;
|
|
293
|
+
taxability: "taxable" | "exempt";
|
|
246
294
|
registration_number: string | null;
|
|
247
|
-
|
|
248
|
-
|
|
295
|
+
is_government_affiliated: boolean;
|
|
296
|
+
language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
|
|
297
|
+
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
298
|
external_id: string | null;
|
|
250
299
|
properties: {
|
|
251
300
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
252
301
|
} | null;
|
|
253
302
|
custom_properties: {
|
|
254
|
-
[key: string]: string | number | boolean | null;
|
|
303
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
255
304
|
} | null;
|
|
256
305
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
306
|
+
shipping_address: {
|
|
307
|
+
name?: string | null;
|
|
308
|
+
line1?: string | null;
|
|
309
|
+
line2?: string | null;
|
|
310
|
+
city?: string | null;
|
|
311
|
+
zip?: string | null;
|
|
312
|
+
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;
|
|
313
|
+
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;
|
|
314
|
+
} | null;
|
|
257
315
|
billing_email: string | null;
|
|
258
316
|
invoice_emails: string[];
|
|
259
317
|
invoicing_entity_id: string;
|
|
260
318
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
319
|
+
force_invoice_draft: boolean | ("true" | "false");
|
|
261
320
|
price_book_id: string | null;
|
|
262
321
|
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
263
322
|
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
323
|
current_payment_method_id: string | null;
|
|
265
324
|
custom_payment_delay: number | null;
|
|
325
|
+
custom_payment_initiation_delay: number | null;
|
|
266
326
|
subscriptions: {
|
|
267
327
|
id: string;
|
|
268
328
|
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
@@ -271,11 +331,18 @@ export declare class HyperlineAPI {
|
|
|
271
331
|
plan_id: string | null;
|
|
272
332
|
checkout_session_id: string | null;
|
|
273
333
|
}[];
|
|
334
|
+
segment_ids: string[];
|
|
335
|
+
integrations: {
|
|
336
|
+
entity_id: string;
|
|
337
|
+
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";
|
|
338
|
+
provider_account_id: string;
|
|
339
|
+
}[];
|
|
274
340
|
created_at: string;
|
|
275
341
|
updated_at: string;
|
|
276
342
|
deleted_at: string | null;
|
|
277
343
|
} & {
|
|
278
344
|
providers: {
|
|
345
|
+
adyen?: string;
|
|
279
346
|
stripe?: string;
|
|
280
347
|
mollie?: string;
|
|
281
348
|
gocardless?: string;
|
|
@@ -285,38 +352,29 @@ export declare class HyperlineAPI {
|
|
|
285
352
|
attio?: string;
|
|
286
353
|
xero?: string;
|
|
287
354
|
pennylane?: string;
|
|
355
|
+
"zoho-books"?: string;
|
|
288
356
|
"exact-online"?: string;
|
|
289
357
|
quickbooks?: string;
|
|
290
358
|
netsuite?: string;
|
|
359
|
+
rillet?: string;
|
|
360
|
+
datev?: string;
|
|
291
361
|
anrok?: string;
|
|
362
|
+
chargebee?: string;
|
|
363
|
+
slack?: string;
|
|
364
|
+
plain?: string;
|
|
365
|
+
zendesk?: string;
|
|
366
|
+
pylon?: string;
|
|
367
|
+
intercom?: string;
|
|
368
|
+
front?: string;
|
|
369
|
+
helpscout?: string;
|
|
370
|
+
claap?: string;
|
|
371
|
+
grain?: string;
|
|
372
|
+
gong?: string;
|
|
373
|
+
jiminny?: string;
|
|
374
|
+
posthog?: string;
|
|
292
375
|
};
|
|
293
|
-
|
|
294
|
-
|
|
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);
|
|
376
|
+
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
377
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
|
|
320
378
|
organisation_id: string | null;
|
|
321
379
|
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
322
380
|
}) | null>;
|
|
@@ -325,31 +383,51 @@ export declare class HyperlineAPI {
|
|
|
325
383
|
name: string;
|
|
326
384
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
327
385
|
status: "active" | "archived";
|
|
328
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
329
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "
|
|
386
|
+
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;
|
|
387
|
+
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;
|
|
388
|
+
domain: string | null;
|
|
330
389
|
vat_number: string | null;
|
|
331
390
|
vat_number_valid: boolean;
|
|
332
391
|
vat_rate_custom: number | null;
|
|
392
|
+
tax_ids: {
|
|
393
|
+
value: string;
|
|
394
|
+
status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
|
|
395
|
+
}[];
|
|
396
|
+
local_tax_number: string | null;
|
|
397
|
+
tax_rate_custom: number | null;
|
|
398
|
+
taxability: "taxable" | "exempt";
|
|
333
399
|
registration_number: string | null;
|
|
334
|
-
|
|
335
|
-
|
|
400
|
+
is_government_affiliated: boolean;
|
|
401
|
+
language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
|
|
402
|
+
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
403
|
external_id: string | null;
|
|
337
404
|
properties: {
|
|
338
405
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
339
406
|
} | null;
|
|
340
407
|
custom_properties: {
|
|
341
|
-
[key: string]: string | number | boolean | null;
|
|
408
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
342
409
|
} | null;
|
|
343
410
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
411
|
+
shipping_address: {
|
|
412
|
+
name?: string | null;
|
|
413
|
+
line1?: string | null;
|
|
414
|
+
line2?: string | null;
|
|
415
|
+
city?: string | null;
|
|
416
|
+
zip?: string | null;
|
|
417
|
+
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;
|
|
418
|
+
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;
|
|
419
|
+
} | null;
|
|
344
420
|
billing_email: string | null;
|
|
345
421
|
invoice_emails: string[];
|
|
346
422
|
invoicing_entity_id: string;
|
|
347
423
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
424
|
+
force_invoice_draft: boolean | ("true" | "false");
|
|
348
425
|
price_book_id: string | null;
|
|
349
426
|
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
350
427
|
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
428
|
current_payment_method_id: string | null;
|
|
352
429
|
custom_payment_delay: number | null;
|
|
430
|
+
custom_payment_initiation_delay: number | null;
|
|
353
431
|
subscriptions: {
|
|
354
432
|
id: string;
|
|
355
433
|
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
@@ -358,11 +436,18 @@ export declare class HyperlineAPI {
|
|
|
358
436
|
plan_id: string | null;
|
|
359
437
|
checkout_session_id: string | null;
|
|
360
438
|
}[];
|
|
439
|
+
segment_ids: string[];
|
|
440
|
+
integrations: {
|
|
441
|
+
entity_id: string;
|
|
442
|
+
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";
|
|
443
|
+
provider_account_id: string;
|
|
444
|
+
}[];
|
|
361
445
|
created_at: string;
|
|
362
446
|
updated_at: string;
|
|
363
447
|
deleted_at: string | null;
|
|
364
448
|
} & {
|
|
365
449
|
providers: {
|
|
450
|
+
adyen?: string;
|
|
366
451
|
stripe?: string;
|
|
367
452
|
mollie?: string;
|
|
368
453
|
gocardless?: string;
|
|
@@ -372,38 +457,29 @@ export declare class HyperlineAPI {
|
|
|
372
457
|
attio?: string;
|
|
373
458
|
xero?: string;
|
|
374
459
|
pennylane?: string;
|
|
460
|
+
"zoho-books"?: string;
|
|
375
461
|
"exact-online"?: string;
|
|
376
462
|
quickbooks?: string;
|
|
377
463
|
netsuite?: string;
|
|
464
|
+
rillet?: string;
|
|
465
|
+
datev?: string;
|
|
378
466
|
anrok?: string;
|
|
467
|
+
chargebee?: string;
|
|
468
|
+
slack?: string;
|
|
469
|
+
plain?: string;
|
|
470
|
+
zendesk?: string;
|
|
471
|
+
pylon?: string;
|
|
472
|
+
intercom?: string;
|
|
473
|
+
front?: string;
|
|
474
|
+
helpscout?: string;
|
|
475
|
+
claap?: string;
|
|
476
|
+
grain?: string;
|
|
477
|
+
gong?: string;
|
|
478
|
+
jiminny?: string;
|
|
479
|
+
posthog?: string;
|
|
379
480
|
};
|
|
380
|
-
|
|
381
|
-
|
|
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);
|
|
481
|
+
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
482
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
|
|
407
483
|
organisation_id: string | null;
|
|
408
484
|
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
409
485
|
}) | null>;
|
|
@@ -413,31 +489,51 @@ export declare class HyperlineAPI {
|
|
|
413
489
|
name: string;
|
|
414
490
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
415
491
|
status: "active" | "archived";
|
|
416
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
417
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "
|
|
492
|
+
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;
|
|
493
|
+
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;
|
|
494
|
+
domain: string | null;
|
|
418
495
|
vat_number: string | null;
|
|
419
496
|
vat_number_valid: boolean;
|
|
420
497
|
vat_rate_custom: number | null;
|
|
498
|
+
tax_ids: {
|
|
499
|
+
value: string;
|
|
500
|
+
status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
|
|
501
|
+
}[];
|
|
502
|
+
local_tax_number: string | null;
|
|
503
|
+
tax_rate_custom: number | null;
|
|
504
|
+
taxability: "taxable" | "exempt";
|
|
421
505
|
registration_number: string | null;
|
|
422
|
-
|
|
423
|
-
|
|
506
|
+
is_government_affiliated: boolean;
|
|
507
|
+
language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
|
|
508
|
+
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
509
|
external_id: string | null;
|
|
425
510
|
properties: {
|
|
426
511
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
427
512
|
} | null;
|
|
428
513
|
custom_properties: {
|
|
429
|
-
[key: string]: string | number | boolean | null;
|
|
514
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
430
515
|
} | null;
|
|
431
516
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
517
|
+
shipping_address: {
|
|
518
|
+
name?: string | null;
|
|
519
|
+
line1?: string | null;
|
|
520
|
+
line2?: string | null;
|
|
521
|
+
city?: string | null;
|
|
522
|
+
zip?: string | null;
|
|
523
|
+
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;
|
|
524
|
+
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;
|
|
525
|
+
} | null;
|
|
432
526
|
billing_email: string | null;
|
|
433
527
|
invoice_emails: string[];
|
|
434
528
|
invoicing_entity_id: string;
|
|
435
529
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
530
|
+
force_invoice_draft: boolean | ("true" | "false");
|
|
436
531
|
price_book_id: string | null;
|
|
437
532
|
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
438
533
|
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
534
|
current_payment_method_id: string | null;
|
|
440
535
|
custom_payment_delay: number | null;
|
|
536
|
+
custom_payment_initiation_delay: number | null;
|
|
441
537
|
subscriptions: {
|
|
442
538
|
id: string;
|
|
443
539
|
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
@@ -446,6 +542,12 @@ export declare class HyperlineAPI {
|
|
|
446
542
|
plan_id: string | null;
|
|
447
543
|
checkout_session_id: string | null;
|
|
448
544
|
}[];
|
|
545
|
+
segment_ids: string[];
|
|
546
|
+
integrations: {
|
|
547
|
+
entity_id: string;
|
|
548
|
+
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";
|
|
549
|
+
provider_account_id: string;
|
|
550
|
+
}[];
|
|
449
551
|
created_at: string;
|
|
450
552
|
updated_at: string;
|
|
451
553
|
deleted_at: string | null;
|
|
@@ -455,31 +557,51 @@ export declare class HyperlineAPI {
|
|
|
455
557
|
name: string;
|
|
456
558
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
457
559
|
status: "active" | "archived";
|
|
458
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
459
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "
|
|
560
|
+
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;
|
|
561
|
+
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;
|
|
562
|
+
domain: string | null;
|
|
460
563
|
vat_number: string | null;
|
|
461
564
|
vat_number_valid: boolean;
|
|
462
565
|
vat_rate_custom: number | null;
|
|
566
|
+
tax_ids: {
|
|
567
|
+
value: string;
|
|
568
|
+
status: "valid" | "invalid" | "mismatch" | "unverified" | "unsupported";
|
|
569
|
+
}[];
|
|
570
|
+
local_tax_number: string | null;
|
|
571
|
+
tax_rate_custom: number | null;
|
|
572
|
+
taxability: "taxable" | "exempt";
|
|
463
573
|
registration_number: string | null;
|
|
464
|
-
|
|
465
|
-
|
|
574
|
+
is_government_affiliated: boolean;
|
|
575
|
+
language: "fr" | "en" | "de" | "it" | "lt" | "nl" | "es" | "pt" | "pl" | null;
|
|
576
|
+
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
577
|
external_id: string | null;
|
|
467
578
|
properties: {
|
|
468
579
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
469
580
|
} | null;
|
|
470
581
|
custom_properties: {
|
|
471
|
-
[key: string]: string | number | boolean | null;
|
|
582
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
472
583
|
} | null;
|
|
473
584
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
585
|
+
shipping_address: {
|
|
586
|
+
name?: string | null;
|
|
587
|
+
line1?: string | null;
|
|
588
|
+
line2?: string | null;
|
|
589
|
+
city?: string | null;
|
|
590
|
+
zip?: string | null;
|
|
591
|
+
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;
|
|
592
|
+
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;
|
|
593
|
+
} | null;
|
|
474
594
|
billing_email: string | null;
|
|
475
595
|
invoice_emails: string[];
|
|
476
596
|
invoicing_entity_id: string;
|
|
477
597
|
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
598
|
+
force_invoice_draft: boolean | ("true" | "false");
|
|
478
599
|
price_book_id: string | null;
|
|
479
600
|
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
480
601
|
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
602
|
current_payment_method_id: string | null;
|
|
482
603
|
custom_payment_delay: number | null;
|
|
604
|
+
custom_payment_initiation_delay: number | null;
|
|
483
605
|
subscriptions: {
|
|
484
606
|
id: string;
|
|
485
607
|
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
@@ -488,6 +610,12 @@ export declare class HyperlineAPI {
|
|
|
488
610
|
plan_id: string | null;
|
|
489
611
|
checkout_session_id: string | null;
|
|
490
612
|
}[];
|
|
613
|
+
segment_ids: string[];
|
|
614
|
+
integrations: {
|
|
615
|
+
entity_id: string;
|
|
616
|
+
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";
|
|
617
|
+
provider_account_id: string;
|
|
618
|
+
}[];
|
|
491
619
|
created_at: string;
|
|
492
620
|
updated_at: string;
|
|
493
621
|
deleted_at: string | null;
|
|
@@ -498,15 +626,15 @@ export declare class HyperlineAPI {
|
|
|
498
626
|
getSubscription(id: string, liveBilling?: boolean): Promise<({
|
|
499
627
|
id: string;
|
|
500
628
|
name: string | null;
|
|
501
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
502
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
629
|
+
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";
|
|
630
|
+
status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
|
|
503
631
|
purchase_order: string | null;
|
|
504
632
|
customer_id: string;
|
|
633
|
+
invoicing_entity_id: string | null;
|
|
505
634
|
plan_id: string | null;
|
|
506
|
-
|
|
635
|
+
template_id: string | null;
|
|
507
636
|
checkout_session_id: string | null;
|
|
508
637
|
crm_opportunity_id: string | null;
|
|
509
|
-
transition_from_subscription_id: string | null;
|
|
510
638
|
minimum_invoice_fee: number | null;
|
|
511
639
|
commitment_interval: {
|
|
512
640
|
period: "days" | "weeks" | "months" | "years";
|
|
@@ -518,8 +646,8 @@ export declare class HyperlineAPI {
|
|
|
518
646
|
count: number;
|
|
519
647
|
} | null;
|
|
520
648
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
521
|
-
starts_at: string;
|
|
522
|
-
contract_start: string;
|
|
649
|
+
starts_at: string | null;
|
|
650
|
+
contract_start: string | null;
|
|
523
651
|
contract_end: string | null;
|
|
524
652
|
initial_billing_at: string | null;
|
|
525
653
|
paused_at: string | null;
|
|
@@ -528,38 +656,54 @@ export declare class HyperlineAPI {
|
|
|
528
656
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
529
657
|
cancellation_amount: number | null;
|
|
530
658
|
cancellation_reason: string | null;
|
|
659
|
+
cancellation_source: "portal" | "app" | "api" | "system" | null;
|
|
531
660
|
estimated_arr: number | null;
|
|
661
|
+
contract_value: number | null;
|
|
532
662
|
current_period_started_at: string | null;
|
|
533
663
|
current_period_ends_at: string | null;
|
|
534
664
|
next_payment_at: string | null;
|
|
535
665
|
next_payment_amount: number | null;
|
|
536
666
|
renews_at: string | null;
|
|
537
667
|
current_phase_id: string | null;
|
|
668
|
+
display_shipping_details: boolean | null;
|
|
538
669
|
properties: {
|
|
539
670
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
540
671
|
} | null;
|
|
541
672
|
custom_properties: {
|
|
542
|
-
[key: string]: string | number | boolean | null;
|
|
673
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
543
674
|
} | null;
|
|
675
|
+
invoice_schedule: "period_start" | "period_end" | null;
|
|
544
676
|
generate_document: boolean;
|
|
545
677
|
document_name: string | null;
|
|
546
678
|
add_tax_to_document: boolean;
|
|
679
|
+
generate_draft_invoices: boolean;
|
|
680
|
+
do_not_charge_subscription: boolean;
|
|
681
|
+
invoice_custom_note: string | null;
|
|
547
682
|
created_at: string;
|
|
548
683
|
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"])[];
|
|
684
|
+
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
685
|
coupons: (({
|
|
552
686
|
description: string | null;
|
|
553
687
|
expiration_date: string | null;
|
|
554
688
|
redemption_limit: number | null;
|
|
689
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
690
|
+
duration: {
|
|
691
|
+
count: number;
|
|
692
|
+
period: "days" | "weeks" | "months" | "years";
|
|
693
|
+
} | null;
|
|
555
694
|
created_at: string;
|
|
556
695
|
type: "amount";
|
|
557
696
|
discount_amount: number;
|
|
558
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
697
|
+
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
698
|
} | {
|
|
560
699
|
description: string | null;
|
|
561
700
|
expiration_date: string | null;
|
|
562
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;
|
|
563
707
|
created_at: string;
|
|
564
708
|
type: "percent";
|
|
565
709
|
discount_percent: number;
|
|
@@ -568,13 +712,22 @@ export declare class HyperlineAPI {
|
|
|
568
712
|
promotion_code_id: string | null;
|
|
569
713
|
name: string | null;
|
|
570
714
|
subscription_coupon_id: string;
|
|
571
|
-
repeat: "once" | "forever" | "custom";
|
|
572
|
-
|
|
715
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
716
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
717
|
+
duration_count: number | null;
|
|
718
|
+
product_ids: string[] | null;
|
|
573
719
|
apply_at: string | null;
|
|
574
720
|
expires_at: string | null;
|
|
575
721
|
})[];
|
|
722
|
+
integrations: {
|
|
723
|
+
entity_id: string;
|
|
724
|
+
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";
|
|
725
|
+
provider_account_id: string;
|
|
726
|
+
}[];
|
|
727
|
+
} & {
|
|
576
728
|
phases: {
|
|
577
729
|
id: string;
|
|
730
|
+
name: string | null;
|
|
578
731
|
type: "setup" | "trial" | "standard";
|
|
579
732
|
status: "pending" | "active" | "finished";
|
|
580
733
|
order: number;
|
|
@@ -592,19 +745,29 @@ export declare class HyperlineAPI {
|
|
|
592
745
|
do_not_invoice_phase: boolean;
|
|
593
746
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
594
747
|
transition_invoicing_schedule: "immediately";
|
|
595
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["
|
|
748
|
+
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
749
|
coupons: (({
|
|
597
750
|
description: string | null;
|
|
598
751
|
expiration_date: string | null;
|
|
599
752
|
redemption_limit: number | null;
|
|
753
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
754
|
+
duration: {
|
|
755
|
+
count: number;
|
|
756
|
+
period: "days" | "weeks" | "months" | "years";
|
|
757
|
+
} | null;
|
|
600
758
|
created_at: string;
|
|
601
759
|
type: "amount";
|
|
602
760
|
discount_amount: number;
|
|
603
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
761
|
+
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
762
|
} | {
|
|
605
763
|
description: string | null;
|
|
606
764
|
expiration_date: string | null;
|
|
607
765
|
redemption_limit: number | null;
|
|
766
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
767
|
+
duration: {
|
|
768
|
+
count: number;
|
|
769
|
+
period: "days" | "weeks" | "months" | "years";
|
|
770
|
+
} | null;
|
|
608
771
|
created_at: string;
|
|
609
772
|
type: "percent";
|
|
610
773
|
discount_percent: number;
|
|
@@ -613,8 +776,10 @@ export declare class HyperlineAPI {
|
|
|
613
776
|
promotion_code_id: string | null;
|
|
614
777
|
name: string | null;
|
|
615
778
|
subscription_coupon_id: string;
|
|
616
|
-
repeat: "once" | "forever" | "custom";
|
|
617
|
-
|
|
779
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
780
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
781
|
+
duration_count: number | null;
|
|
782
|
+
product_ids: string[] | null;
|
|
618
783
|
apply_at: string | null;
|
|
619
784
|
expires_at: string | null;
|
|
620
785
|
})[];
|
|
@@ -629,13 +794,14 @@ export declare class HyperlineAPI {
|
|
|
629
794
|
id: string;
|
|
630
795
|
name: string;
|
|
631
796
|
} | null;
|
|
797
|
+
template: {
|
|
798
|
+
id: string;
|
|
799
|
+
name: string;
|
|
800
|
+
configurationId: string;
|
|
801
|
+
} | null;
|
|
632
802
|
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
633
803
|
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
634
804
|
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
805
|
contract_terms: {
|
|
640
806
|
status: "active" | "pending" | "finished";
|
|
641
807
|
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
@@ -657,7 +823,7 @@ export declare class HyperlineAPI {
|
|
|
657
823
|
} & {
|
|
658
824
|
live_billing?: import("./_types.generated").components["schemas"]["LiveBilling"];
|
|
659
825
|
}) | null>;
|
|
660
|
-
getSubscriptions(skip?: number, take?: number, query?:
|
|
826
|
+
getSubscriptions(skip?: number, take?: number, query?: paths['/v2/subscriptions']['get']['parameters']['query']): Promise<{
|
|
661
827
|
meta: {
|
|
662
828
|
total: number;
|
|
663
829
|
taken: number;
|
|
@@ -665,19 +831,19 @@ export declare class HyperlineAPI {
|
|
|
665
831
|
};
|
|
666
832
|
data: import("./_types.generated").components["schemas"]["Subscription"][];
|
|
667
833
|
} | null>;
|
|
668
|
-
getAllSubscriptions(items?: paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data'], query?:
|
|
834
|
+
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
835
|
createSubscription(data: NonNullable<paths['/v2/subscriptions']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
670
836
|
id: string;
|
|
671
837
|
name: string | null;
|
|
672
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
673
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
838
|
+
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";
|
|
839
|
+
status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
|
|
674
840
|
purchase_order: string | null;
|
|
675
841
|
customer_id: string;
|
|
842
|
+
invoicing_entity_id: string | null;
|
|
676
843
|
plan_id: string | null;
|
|
677
|
-
|
|
844
|
+
template_id: string | null;
|
|
678
845
|
checkout_session_id: string | null;
|
|
679
846
|
crm_opportunity_id: string | null;
|
|
680
|
-
transition_from_subscription_id: string | null;
|
|
681
847
|
minimum_invoice_fee: number | null;
|
|
682
848
|
commitment_interval: {
|
|
683
849
|
period: "days" | "weeks" | "months" | "years";
|
|
@@ -689,8 +855,8 @@ export declare class HyperlineAPI {
|
|
|
689
855
|
count: number;
|
|
690
856
|
} | null;
|
|
691
857
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
692
|
-
starts_at: string;
|
|
693
|
-
contract_start: string;
|
|
858
|
+
starts_at: string | null;
|
|
859
|
+
contract_start: string | null;
|
|
694
860
|
contract_end: string | null;
|
|
695
861
|
initial_billing_at: string | null;
|
|
696
862
|
paused_at: string | null;
|
|
@@ -699,38 +865,54 @@ export declare class HyperlineAPI {
|
|
|
699
865
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
700
866
|
cancellation_amount: number | null;
|
|
701
867
|
cancellation_reason: string | null;
|
|
868
|
+
cancellation_source: "portal" | "app" | "api" | "system" | null;
|
|
702
869
|
estimated_arr: number | null;
|
|
870
|
+
contract_value: number | null;
|
|
703
871
|
current_period_started_at: string | null;
|
|
704
872
|
current_period_ends_at: string | null;
|
|
705
873
|
next_payment_at: string | null;
|
|
706
874
|
next_payment_amount: number | null;
|
|
707
875
|
renews_at: string | null;
|
|
708
876
|
current_phase_id: string | null;
|
|
877
|
+
display_shipping_details: boolean | null;
|
|
709
878
|
properties: {
|
|
710
879
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
711
880
|
} | null;
|
|
712
881
|
custom_properties: {
|
|
713
|
-
[key: string]: string | number | boolean | null;
|
|
882
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
714
883
|
} | null;
|
|
884
|
+
invoice_schedule: "period_start" | "period_end" | null;
|
|
715
885
|
generate_document: boolean;
|
|
716
886
|
document_name: string | null;
|
|
717
887
|
add_tax_to_document: boolean;
|
|
888
|
+
generate_draft_invoices: boolean;
|
|
889
|
+
do_not_charge_subscription: boolean;
|
|
890
|
+
invoice_custom_note: string | null;
|
|
718
891
|
created_at: string;
|
|
719
892
|
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"])[];
|
|
893
|
+
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
894
|
coupons: (({
|
|
723
895
|
description: string | null;
|
|
724
896
|
expiration_date: string | null;
|
|
725
897
|
redemption_limit: number | null;
|
|
898
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
899
|
+
duration: {
|
|
900
|
+
count: number;
|
|
901
|
+
period: "days" | "weeks" | "months" | "years";
|
|
902
|
+
} | null;
|
|
726
903
|
created_at: string;
|
|
727
904
|
type: "amount";
|
|
728
905
|
discount_amount: number;
|
|
729
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
906
|
+
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
907
|
} | {
|
|
731
908
|
description: string | null;
|
|
732
909
|
expiration_date: string | null;
|
|
733
910
|
redemption_limit: number | null;
|
|
911
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
912
|
+
duration: {
|
|
913
|
+
count: number;
|
|
914
|
+
period: "days" | "weeks" | "months" | "years";
|
|
915
|
+
} | null;
|
|
734
916
|
created_at: string;
|
|
735
917
|
type: "percent";
|
|
736
918
|
discount_percent: number;
|
|
@@ -739,13 +921,22 @@ export declare class HyperlineAPI {
|
|
|
739
921
|
promotion_code_id: string | null;
|
|
740
922
|
name: string | null;
|
|
741
923
|
subscription_coupon_id: string;
|
|
742
|
-
repeat: "once" | "forever" | "custom";
|
|
743
|
-
|
|
924
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
925
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
926
|
+
duration_count: number | null;
|
|
927
|
+
product_ids: string[] | null;
|
|
744
928
|
apply_at: string | null;
|
|
745
929
|
expires_at: string | null;
|
|
746
930
|
})[];
|
|
931
|
+
integrations: {
|
|
932
|
+
entity_id: string;
|
|
933
|
+
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";
|
|
934
|
+
provider_account_id: string;
|
|
935
|
+
}[];
|
|
936
|
+
} & {
|
|
747
937
|
phases: {
|
|
748
938
|
id: string;
|
|
939
|
+
name: string | null;
|
|
749
940
|
type: "setup" | "trial" | "standard";
|
|
750
941
|
status: "pending" | "active" | "finished";
|
|
751
942
|
order: number;
|
|
@@ -763,19 +954,29 @@ export declare class HyperlineAPI {
|
|
|
763
954
|
do_not_invoice_phase: boolean;
|
|
764
955
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
765
956
|
transition_invoicing_schedule: "immediately";
|
|
766
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["
|
|
957
|
+
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
958
|
coupons: (({
|
|
768
959
|
description: string | null;
|
|
769
960
|
expiration_date: string | null;
|
|
770
961
|
redemption_limit: number | null;
|
|
962
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
963
|
+
duration: {
|
|
964
|
+
count: number;
|
|
965
|
+
period: "days" | "weeks" | "months" | "years";
|
|
966
|
+
} | null;
|
|
771
967
|
created_at: string;
|
|
772
968
|
type: "amount";
|
|
773
969
|
discount_amount: number;
|
|
774
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
970
|
+
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
971
|
} | {
|
|
776
972
|
description: string | null;
|
|
777
973
|
expiration_date: string | null;
|
|
778
974
|
redemption_limit: number | null;
|
|
975
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
976
|
+
duration: {
|
|
977
|
+
count: number;
|
|
978
|
+
period: "days" | "weeks" | "months" | "years";
|
|
979
|
+
} | null;
|
|
779
980
|
created_at: string;
|
|
780
981
|
type: "percent";
|
|
781
982
|
discount_percent: number;
|
|
@@ -784,8 +985,10 @@ export declare class HyperlineAPI {
|
|
|
784
985
|
promotion_code_id: string | null;
|
|
785
986
|
name: string | null;
|
|
786
987
|
subscription_coupon_id: string;
|
|
787
|
-
repeat: "once" | "forever" | "custom";
|
|
788
|
-
|
|
988
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
989
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
990
|
+
duration_count: number | null;
|
|
991
|
+
product_ids: string[] | null;
|
|
789
992
|
apply_at: string | null;
|
|
790
993
|
expires_at: string | null;
|
|
791
994
|
})[];
|
|
@@ -800,13 +1003,14 @@ export declare class HyperlineAPI {
|
|
|
800
1003
|
id: string;
|
|
801
1004
|
name: string;
|
|
802
1005
|
} | null;
|
|
1006
|
+
template: {
|
|
1007
|
+
id: string;
|
|
1008
|
+
name: string;
|
|
1009
|
+
configurationId: string;
|
|
1010
|
+
} | null;
|
|
803
1011
|
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
804
1012
|
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
805
1013
|
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
1014
|
contract_terms: {
|
|
811
1015
|
status: "active" | "pending" | "finished";
|
|
812
1016
|
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
@@ -829,15 +1033,15 @@ export declare class HyperlineAPI {
|
|
|
829
1033
|
updateSubscription(id: string, data: NonNullable<paths['/v2/subscriptions/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
|
|
830
1034
|
id: string;
|
|
831
1035
|
name: string | null;
|
|
832
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
833
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
1036
|
+
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";
|
|
1037
|
+
status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
|
|
834
1038
|
purchase_order: string | null;
|
|
835
1039
|
customer_id: string;
|
|
1040
|
+
invoicing_entity_id: string | null;
|
|
836
1041
|
plan_id: string | null;
|
|
837
|
-
|
|
1042
|
+
template_id: string | null;
|
|
838
1043
|
checkout_session_id: string | null;
|
|
839
1044
|
crm_opportunity_id: string | null;
|
|
840
|
-
transition_from_subscription_id: string | null;
|
|
841
1045
|
minimum_invoice_fee: number | null;
|
|
842
1046
|
commitment_interval: {
|
|
843
1047
|
period: "days" | "weeks" | "months" | "years";
|
|
@@ -849,8 +1053,8 @@ export declare class HyperlineAPI {
|
|
|
849
1053
|
count: number;
|
|
850
1054
|
} | null;
|
|
851
1055
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
852
|
-
starts_at: string;
|
|
853
|
-
contract_start: string;
|
|
1056
|
+
starts_at: string | null;
|
|
1057
|
+
contract_start: string | null;
|
|
854
1058
|
contract_end: string | null;
|
|
855
1059
|
initial_billing_at: string | null;
|
|
856
1060
|
paused_at: string | null;
|
|
@@ -859,38 +1063,54 @@ export declare class HyperlineAPI {
|
|
|
859
1063
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
860
1064
|
cancellation_amount: number | null;
|
|
861
1065
|
cancellation_reason: string | null;
|
|
1066
|
+
cancellation_source: "portal" | "app" | "api" | "system" | null;
|
|
862
1067
|
estimated_arr: number | null;
|
|
1068
|
+
contract_value: number | null;
|
|
863
1069
|
current_period_started_at: string | null;
|
|
864
1070
|
current_period_ends_at: string | null;
|
|
865
1071
|
next_payment_at: string | null;
|
|
866
1072
|
next_payment_amount: number | null;
|
|
867
1073
|
renews_at: string | null;
|
|
868
1074
|
current_phase_id: string | null;
|
|
1075
|
+
display_shipping_details: boolean | null;
|
|
869
1076
|
properties: {
|
|
870
1077
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
871
1078
|
} | null;
|
|
872
1079
|
custom_properties: {
|
|
873
|
-
[key: string]: string | number | boolean | null;
|
|
1080
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
874
1081
|
} | null;
|
|
1082
|
+
invoice_schedule: "period_start" | "period_end" | null;
|
|
875
1083
|
generate_document: boolean;
|
|
876
1084
|
document_name: string | null;
|
|
877
1085
|
add_tax_to_document: boolean;
|
|
1086
|
+
generate_draft_invoices: boolean;
|
|
1087
|
+
do_not_charge_subscription: boolean;
|
|
1088
|
+
invoice_custom_note: string | null;
|
|
878
1089
|
created_at: string;
|
|
879
1090
|
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"])[];
|
|
1091
|
+
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
1092
|
coupons: (({
|
|
883
1093
|
description: string | null;
|
|
884
1094
|
expiration_date: string | null;
|
|
885
1095
|
redemption_limit: number | null;
|
|
1096
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1097
|
+
duration: {
|
|
1098
|
+
count: number;
|
|
1099
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1100
|
+
} | null;
|
|
886
1101
|
created_at: string;
|
|
887
1102
|
type: "amount";
|
|
888
1103
|
discount_amount: number;
|
|
889
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1104
|
+
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
1105
|
} | {
|
|
891
1106
|
description: string | null;
|
|
892
1107
|
expiration_date: string | null;
|
|
893
1108
|
redemption_limit: number | null;
|
|
1109
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1110
|
+
duration: {
|
|
1111
|
+
count: number;
|
|
1112
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1113
|
+
} | null;
|
|
894
1114
|
created_at: string;
|
|
895
1115
|
type: "percent";
|
|
896
1116
|
discount_percent: number;
|
|
@@ -899,13 +1119,22 @@ export declare class HyperlineAPI {
|
|
|
899
1119
|
promotion_code_id: string | null;
|
|
900
1120
|
name: string | null;
|
|
901
1121
|
subscription_coupon_id: string;
|
|
902
|
-
repeat: "once" | "forever" | "custom";
|
|
903
|
-
|
|
1122
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
1123
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
1124
|
+
duration_count: number | null;
|
|
1125
|
+
product_ids: string[] | null;
|
|
904
1126
|
apply_at: string | null;
|
|
905
1127
|
expires_at: string | null;
|
|
906
1128
|
})[];
|
|
1129
|
+
integrations: {
|
|
1130
|
+
entity_id: string;
|
|
1131
|
+
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";
|
|
1132
|
+
provider_account_id: string;
|
|
1133
|
+
}[];
|
|
1134
|
+
} & {
|
|
907
1135
|
phases: {
|
|
908
1136
|
id: string;
|
|
1137
|
+
name: string | null;
|
|
909
1138
|
type: "setup" | "trial" | "standard";
|
|
910
1139
|
status: "pending" | "active" | "finished";
|
|
911
1140
|
order: number;
|
|
@@ -923,19 +1152,29 @@ export declare class HyperlineAPI {
|
|
|
923
1152
|
do_not_invoice_phase: boolean;
|
|
924
1153
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
925
1154
|
transition_invoicing_schedule: "immediately";
|
|
926
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["
|
|
1155
|
+
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
1156
|
coupons: (({
|
|
928
1157
|
description: string | null;
|
|
929
1158
|
expiration_date: string | null;
|
|
930
1159
|
redemption_limit: number | null;
|
|
1160
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1161
|
+
duration: {
|
|
1162
|
+
count: number;
|
|
1163
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1164
|
+
} | null;
|
|
931
1165
|
created_at: string;
|
|
932
1166
|
type: "amount";
|
|
933
1167
|
discount_amount: number;
|
|
934
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1168
|
+
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
1169
|
} | {
|
|
936
1170
|
description: string | null;
|
|
937
1171
|
expiration_date: string | null;
|
|
938
1172
|
redemption_limit: number | null;
|
|
1173
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1174
|
+
duration: {
|
|
1175
|
+
count: number;
|
|
1176
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1177
|
+
} | null;
|
|
939
1178
|
created_at: string;
|
|
940
1179
|
type: "percent";
|
|
941
1180
|
discount_percent: number;
|
|
@@ -944,8 +1183,10 @@ export declare class HyperlineAPI {
|
|
|
944
1183
|
promotion_code_id: string | null;
|
|
945
1184
|
name: string | null;
|
|
946
1185
|
subscription_coupon_id: string;
|
|
947
|
-
repeat: "once" | "forever" | "custom";
|
|
948
|
-
|
|
1186
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
1187
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
1188
|
+
duration_count: number | null;
|
|
1189
|
+
product_ids: string[] | null;
|
|
949
1190
|
apply_at: string | null;
|
|
950
1191
|
expires_at: string | null;
|
|
951
1192
|
})[];
|
|
@@ -960,13 +1201,14 @@ export declare class HyperlineAPI {
|
|
|
960
1201
|
id: string;
|
|
961
1202
|
name: string;
|
|
962
1203
|
} | null;
|
|
1204
|
+
template: {
|
|
1205
|
+
id: string;
|
|
1206
|
+
name: string;
|
|
1207
|
+
configurationId: string;
|
|
1208
|
+
} | null;
|
|
963
1209
|
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
964
1210
|
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
965
1211
|
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
1212
|
contract_terms: {
|
|
971
1213
|
status: "active" | "pending" | "finished";
|
|
972
1214
|
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
@@ -992,15 +1234,15 @@ export declare class HyperlineAPI {
|
|
|
992
1234
|
cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
993
1235
|
id: string;
|
|
994
1236
|
name: string | null;
|
|
995
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
996
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
1237
|
+
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";
|
|
1238
|
+
status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
|
|
997
1239
|
purchase_order: string | null;
|
|
998
1240
|
customer_id: string;
|
|
1241
|
+
invoicing_entity_id: string | null;
|
|
999
1242
|
plan_id: string | null;
|
|
1000
|
-
|
|
1243
|
+
template_id: string | null;
|
|
1001
1244
|
checkout_session_id: string | null;
|
|
1002
1245
|
crm_opportunity_id: string | null;
|
|
1003
|
-
transition_from_subscription_id: string | null;
|
|
1004
1246
|
minimum_invoice_fee: number | null;
|
|
1005
1247
|
commitment_interval: {
|
|
1006
1248
|
period: "days" | "weeks" | "months" | "years";
|
|
@@ -1012,8 +1254,8 @@ export declare class HyperlineAPI {
|
|
|
1012
1254
|
count: number;
|
|
1013
1255
|
} | null;
|
|
1014
1256
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
1015
|
-
starts_at: string;
|
|
1016
|
-
contract_start: string;
|
|
1257
|
+
starts_at: string | null;
|
|
1258
|
+
contract_start: string | null;
|
|
1017
1259
|
contract_end: string | null;
|
|
1018
1260
|
initial_billing_at: string | null;
|
|
1019
1261
|
paused_at: string | null;
|
|
@@ -1022,38 +1264,54 @@ export declare class HyperlineAPI {
|
|
|
1022
1264
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
1023
1265
|
cancellation_amount: number | null;
|
|
1024
1266
|
cancellation_reason: string | null;
|
|
1267
|
+
cancellation_source: "portal" | "app" | "api" | "system" | null;
|
|
1025
1268
|
estimated_arr: number | null;
|
|
1269
|
+
contract_value: number | null;
|
|
1026
1270
|
current_period_started_at: string | null;
|
|
1027
1271
|
current_period_ends_at: string | null;
|
|
1028
1272
|
next_payment_at: string | null;
|
|
1029
1273
|
next_payment_amount: number | null;
|
|
1030
1274
|
renews_at: string | null;
|
|
1031
1275
|
current_phase_id: string | null;
|
|
1276
|
+
display_shipping_details: boolean | null;
|
|
1032
1277
|
properties: {
|
|
1033
1278
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
1034
1279
|
} | null;
|
|
1035
1280
|
custom_properties: {
|
|
1036
|
-
[key: string]: string | number | boolean | null;
|
|
1281
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
1037
1282
|
} | null;
|
|
1283
|
+
invoice_schedule: "period_start" | "period_end" | null;
|
|
1038
1284
|
generate_document: boolean;
|
|
1039
1285
|
document_name: string | null;
|
|
1040
1286
|
add_tax_to_document: boolean;
|
|
1287
|
+
generate_draft_invoices: boolean;
|
|
1288
|
+
do_not_charge_subscription: boolean;
|
|
1289
|
+
invoice_custom_note: string | null;
|
|
1041
1290
|
created_at: string;
|
|
1042
1291
|
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"])[];
|
|
1292
|
+
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
1293
|
coupons: (({
|
|
1046
1294
|
description: string | null;
|
|
1047
1295
|
expiration_date: string | null;
|
|
1048
1296
|
redemption_limit: number | null;
|
|
1297
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1298
|
+
duration: {
|
|
1299
|
+
count: number;
|
|
1300
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1301
|
+
} | null;
|
|
1049
1302
|
created_at: string;
|
|
1050
1303
|
type: "amount";
|
|
1051
1304
|
discount_amount: number;
|
|
1052
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1305
|
+
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
1306
|
} | {
|
|
1054
1307
|
description: string | null;
|
|
1055
1308
|
expiration_date: string | null;
|
|
1056
1309
|
redemption_limit: number | null;
|
|
1310
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1311
|
+
duration: {
|
|
1312
|
+
count: number;
|
|
1313
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1314
|
+
} | null;
|
|
1057
1315
|
created_at: string;
|
|
1058
1316
|
type: "percent";
|
|
1059
1317
|
discount_percent: number;
|
|
@@ -1062,13 +1320,22 @@ export declare class HyperlineAPI {
|
|
|
1062
1320
|
promotion_code_id: string | null;
|
|
1063
1321
|
name: string | null;
|
|
1064
1322
|
subscription_coupon_id: string;
|
|
1065
|
-
repeat: "once" | "forever" | "custom";
|
|
1066
|
-
|
|
1323
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
1324
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
1325
|
+
duration_count: number | null;
|
|
1326
|
+
product_ids: string[] | null;
|
|
1067
1327
|
apply_at: string | null;
|
|
1068
1328
|
expires_at: string | null;
|
|
1069
1329
|
})[];
|
|
1330
|
+
integrations: {
|
|
1331
|
+
entity_id: string;
|
|
1332
|
+
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";
|
|
1333
|
+
provider_account_id: string;
|
|
1334
|
+
}[];
|
|
1335
|
+
} & {
|
|
1070
1336
|
phases: {
|
|
1071
1337
|
id: string;
|
|
1338
|
+
name: string | null;
|
|
1072
1339
|
type: "setup" | "trial" | "standard";
|
|
1073
1340
|
status: "pending" | "active" | "finished";
|
|
1074
1341
|
order: number;
|
|
@@ -1086,19 +1353,29 @@ export declare class HyperlineAPI {
|
|
|
1086
1353
|
do_not_invoice_phase: boolean;
|
|
1087
1354
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
1088
1355
|
transition_invoicing_schedule: "immediately";
|
|
1089
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["
|
|
1356
|
+
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
1357
|
coupons: (({
|
|
1091
1358
|
description: string | null;
|
|
1092
1359
|
expiration_date: string | null;
|
|
1093
1360
|
redemption_limit: number | null;
|
|
1361
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1362
|
+
duration: {
|
|
1363
|
+
count: number;
|
|
1364
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1365
|
+
} | null;
|
|
1094
1366
|
created_at: string;
|
|
1095
1367
|
type: "amount";
|
|
1096
1368
|
discount_amount: number;
|
|
1097
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1369
|
+
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
1370
|
} | {
|
|
1099
1371
|
description: string | null;
|
|
1100
1372
|
expiration_date: string | null;
|
|
1101
1373
|
redemption_limit: number | null;
|
|
1374
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1375
|
+
duration: {
|
|
1376
|
+
count: number;
|
|
1377
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1378
|
+
} | null;
|
|
1102
1379
|
created_at: string;
|
|
1103
1380
|
type: "percent";
|
|
1104
1381
|
discount_percent: number;
|
|
@@ -1107,8 +1384,10 @@ export declare class HyperlineAPI {
|
|
|
1107
1384
|
promotion_code_id: string | null;
|
|
1108
1385
|
name: string | null;
|
|
1109
1386
|
subscription_coupon_id: string;
|
|
1110
|
-
repeat: "once" | "forever" | "custom";
|
|
1111
|
-
|
|
1387
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
1388
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
1389
|
+
duration_count: number | null;
|
|
1390
|
+
product_ids: string[] | null;
|
|
1112
1391
|
apply_at: string | null;
|
|
1113
1392
|
expires_at: string | null;
|
|
1114
1393
|
})[];
|
|
@@ -1123,13 +1402,14 @@ export declare class HyperlineAPI {
|
|
|
1123
1402
|
id: string;
|
|
1124
1403
|
name: string;
|
|
1125
1404
|
} | null;
|
|
1405
|
+
template: {
|
|
1406
|
+
id: string;
|
|
1407
|
+
name: string;
|
|
1408
|
+
configurationId: string;
|
|
1409
|
+
} | null;
|
|
1126
1410
|
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
1127
1411
|
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
1128
1412
|
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
1413
|
contract_terms: {
|
|
1134
1414
|
status: "active" | "pending" | "finished";
|
|
1135
1415
|
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
@@ -1152,15 +1432,15 @@ export declare class HyperlineAPI {
|
|
|
1152
1432
|
reinstateSubscription(id: string): Promise<({
|
|
1153
1433
|
id: string;
|
|
1154
1434
|
name: string | null;
|
|
1155
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1156
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
1435
|
+
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";
|
|
1436
|
+
status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
|
|
1157
1437
|
purchase_order: string | null;
|
|
1158
1438
|
customer_id: string;
|
|
1439
|
+
invoicing_entity_id: string | null;
|
|
1159
1440
|
plan_id: string | null;
|
|
1160
|
-
|
|
1441
|
+
template_id: string | null;
|
|
1161
1442
|
checkout_session_id: string | null;
|
|
1162
1443
|
crm_opportunity_id: string | null;
|
|
1163
|
-
transition_from_subscription_id: string | null;
|
|
1164
1444
|
minimum_invoice_fee: number | null;
|
|
1165
1445
|
commitment_interval: {
|
|
1166
1446
|
period: "days" | "weeks" | "months" | "years";
|
|
@@ -1172,8 +1452,8 @@ export declare class HyperlineAPI {
|
|
|
1172
1452
|
count: number;
|
|
1173
1453
|
} | null;
|
|
1174
1454
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
1175
|
-
starts_at: string;
|
|
1176
|
-
contract_start: string;
|
|
1455
|
+
starts_at: string | null;
|
|
1456
|
+
contract_start: string | null;
|
|
1177
1457
|
contract_end: string | null;
|
|
1178
1458
|
initial_billing_at: string | null;
|
|
1179
1459
|
paused_at: string | null;
|
|
@@ -1182,38 +1462,54 @@ export declare class HyperlineAPI {
|
|
|
1182
1462
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
1183
1463
|
cancellation_amount: number | null;
|
|
1184
1464
|
cancellation_reason: string | null;
|
|
1465
|
+
cancellation_source: "portal" | "app" | "api" | "system" | null;
|
|
1185
1466
|
estimated_arr: number | null;
|
|
1467
|
+
contract_value: number | null;
|
|
1186
1468
|
current_period_started_at: string | null;
|
|
1187
1469
|
current_period_ends_at: string | null;
|
|
1188
1470
|
next_payment_at: string | null;
|
|
1189
1471
|
next_payment_amount: number | null;
|
|
1190
1472
|
renews_at: string | null;
|
|
1191
1473
|
current_phase_id: string | null;
|
|
1474
|
+
display_shipping_details: boolean | null;
|
|
1192
1475
|
properties: {
|
|
1193
1476
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
1194
1477
|
} | null;
|
|
1195
1478
|
custom_properties: {
|
|
1196
|
-
[key: string]: string | number | boolean | null;
|
|
1479
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
1197
1480
|
} | null;
|
|
1481
|
+
invoice_schedule: "period_start" | "period_end" | null;
|
|
1198
1482
|
generate_document: boolean;
|
|
1199
1483
|
document_name: string | null;
|
|
1200
1484
|
add_tax_to_document: boolean;
|
|
1485
|
+
generate_draft_invoices: boolean;
|
|
1486
|
+
do_not_charge_subscription: boolean;
|
|
1487
|
+
invoice_custom_note: string | null;
|
|
1201
1488
|
created_at: string;
|
|
1202
1489
|
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"])[];
|
|
1490
|
+
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
1491
|
coupons: (({
|
|
1206
1492
|
description: string | null;
|
|
1207
1493
|
expiration_date: string | null;
|
|
1208
1494
|
redemption_limit: number | null;
|
|
1495
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1496
|
+
duration: {
|
|
1497
|
+
count: number;
|
|
1498
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1499
|
+
} | null;
|
|
1209
1500
|
created_at: string;
|
|
1210
1501
|
type: "amount";
|
|
1211
1502
|
discount_amount: number;
|
|
1212
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1503
|
+
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
1504
|
} | {
|
|
1214
1505
|
description: string | null;
|
|
1215
1506
|
expiration_date: string | null;
|
|
1216
1507
|
redemption_limit: number | null;
|
|
1508
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1509
|
+
duration: {
|
|
1510
|
+
count: number;
|
|
1511
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1512
|
+
} | null;
|
|
1217
1513
|
created_at: string;
|
|
1218
1514
|
type: "percent";
|
|
1219
1515
|
discount_percent: number;
|
|
@@ -1222,13 +1518,22 @@ export declare class HyperlineAPI {
|
|
|
1222
1518
|
promotion_code_id: string | null;
|
|
1223
1519
|
name: string | null;
|
|
1224
1520
|
subscription_coupon_id: string;
|
|
1225
|
-
repeat: "once" | "forever" | "custom";
|
|
1226
|
-
|
|
1521
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
1522
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
1523
|
+
duration_count: number | null;
|
|
1524
|
+
product_ids: string[] | null;
|
|
1227
1525
|
apply_at: string | null;
|
|
1228
1526
|
expires_at: string | null;
|
|
1229
1527
|
})[];
|
|
1528
|
+
integrations: {
|
|
1529
|
+
entity_id: string;
|
|
1530
|
+
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";
|
|
1531
|
+
provider_account_id: string;
|
|
1532
|
+
}[];
|
|
1533
|
+
} & {
|
|
1230
1534
|
phases: {
|
|
1231
1535
|
id: string;
|
|
1536
|
+
name: string | null;
|
|
1232
1537
|
type: "setup" | "trial" | "standard";
|
|
1233
1538
|
status: "pending" | "active" | "finished";
|
|
1234
1539
|
order: number;
|
|
@@ -1246,19 +1551,29 @@ export declare class HyperlineAPI {
|
|
|
1246
1551
|
do_not_invoice_phase: boolean;
|
|
1247
1552
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
1248
1553
|
transition_invoicing_schedule: "immediately";
|
|
1249
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["
|
|
1554
|
+
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
1555
|
coupons: (({
|
|
1251
1556
|
description: string | null;
|
|
1252
1557
|
expiration_date: string | null;
|
|
1253
1558
|
redemption_limit: number | null;
|
|
1559
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1560
|
+
duration: {
|
|
1561
|
+
count: number;
|
|
1562
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1563
|
+
} | null;
|
|
1254
1564
|
created_at: string;
|
|
1255
1565
|
type: "amount";
|
|
1256
1566
|
discount_amount: number;
|
|
1257
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1567
|
+
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
1568
|
} | {
|
|
1259
1569
|
description: string | null;
|
|
1260
1570
|
expiration_date: string | null;
|
|
1261
1571
|
redemption_limit: number | null;
|
|
1572
|
+
repeat: "once" | "forever" | "custom" | "duration" | null;
|
|
1573
|
+
duration: {
|
|
1574
|
+
count: number;
|
|
1575
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1576
|
+
} | null;
|
|
1262
1577
|
created_at: string;
|
|
1263
1578
|
type: "percent";
|
|
1264
1579
|
discount_percent: number;
|
|
@@ -1267,8 +1582,10 @@ export declare class HyperlineAPI {
|
|
|
1267
1582
|
promotion_code_id: string | null;
|
|
1268
1583
|
name: string | null;
|
|
1269
1584
|
subscription_coupon_id: string;
|
|
1270
|
-
repeat: "once" | "forever" | "custom";
|
|
1271
|
-
|
|
1585
|
+
repeat: "once" | "forever" | "custom" | "duration";
|
|
1586
|
+
duration_period: "days" | "weeks" | "months" | "years" | null;
|
|
1587
|
+
duration_count: number | null;
|
|
1588
|
+
product_ids: string[] | null;
|
|
1272
1589
|
apply_at: string | null;
|
|
1273
1590
|
expires_at: string | null;
|
|
1274
1591
|
})[];
|
|
@@ -1283,13 +1600,14 @@ export declare class HyperlineAPI {
|
|
|
1283
1600
|
id: string;
|
|
1284
1601
|
name: string;
|
|
1285
1602
|
} | null;
|
|
1603
|
+
template: {
|
|
1604
|
+
id: string;
|
|
1605
|
+
name: string;
|
|
1606
|
+
configurationId: string;
|
|
1607
|
+
} | null;
|
|
1286
1608
|
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
1287
1609
|
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
1288
1610
|
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
1611
|
contract_terms: {
|
|
1294
1612
|
status: "active" | "pending" | "finished";
|
|
1295
1613
|
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
@@ -1309,58 +1627,21 @@ export declare class HyperlineAPI {
|
|
|
1309
1627
|
current_period_ends_at: string | null;
|
|
1310
1628
|
} | null;
|
|
1311
1629
|
}) | null>;
|
|
1312
|
-
getPlan(id: string): Promise<{
|
|
1313
|
-
id: string;
|
|
1314
|
-
name: string;
|
|
1315
|
-
description: string | null;
|
|
1316
|
-
commitment_interval: {
|
|
1317
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1318
|
-
count: number;
|
|
1319
|
-
} | 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
|
-
renew_automatically: boolean;
|
|
1329
|
-
renew_for: {
|
|
1330
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1331
|
-
count: number | null;
|
|
1332
|
-
} | 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
|
-
custom_properties: {
|
|
1335
|
-
[key: string]: string | number | boolean | null;
|
|
1336
|
-
} | 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
1630
|
getInvoice(id: string): Promise<({
|
|
1347
1631
|
id: string;
|
|
1348
1632
|
number: string;
|
|
1349
1633
|
type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
|
|
1350
1634
|
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";
|
|
1635
|
+
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
1636
|
reference: string | null;
|
|
1353
1637
|
purchase_order: string | null;
|
|
1354
|
-
|
|
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";
|
|
1638
|
+
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
1639
|
source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
|
|
1358
1640
|
total_amount: number;
|
|
1359
1641
|
amount_due: number;
|
|
1360
1642
|
amount_paid: number;
|
|
1361
1643
|
amount_fixed: number;
|
|
1362
1644
|
amount_excluding_tax: number;
|
|
1363
|
-
tax_rate: number;
|
|
1364
1645
|
tax_amount: number;
|
|
1365
1646
|
tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
|
|
1366
1647
|
discount_amount: number;
|
|
@@ -1377,19 +1658,21 @@ export declare class HyperlineAPI {
|
|
|
1377
1658
|
name: string;
|
|
1378
1659
|
email: string | null;
|
|
1379
1660
|
external_id: string | null;
|
|
1380
|
-
|
|
1661
|
+
tax_id: string | null;
|
|
1662
|
+
local_tax_number: string | null;
|
|
1663
|
+
registration_number: string | null;
|
|
1381
1664
|
address: import("./_types.generated").components["schemas"]["Address"];
|
|
1382
1665
|
};
|
|
1383
1666
|
seller: {
|
|
1384
1667
|
id: string;
|
|
1385
1668
|
name: string;
|
|
1386
1669
|
tax_id: string | null;
|
|
1387
|
-
|
|
1670
|
+
registration_number: string | null;
|
|
1671
|
+
address: import("./_types.generated").components["schemas"]["Address"] & unknown;
|
|
1388
1672
|
};
|
|
1389
1673
|
subscription_id: string | null;
|
|
1390
1674
|
period_starts_at: string | null;
|
|
1391
1675
|
period_ends_at: string | null;
|
|
1392
|
-
emitted_at: string;
|
|
1393
1676
|
due_at: string;
|
|
1394
1677
|
refunded_at: string | null;
|
|
1395
1678
|
grace_period_ended_at: string | null;
|
|
@@ -1398,53 +1681,61 @@ export declare class HyperlineAPI {
|
|
|
1398
1681
|
properties: {
|
|
1399
1682
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
1400
1683
|
} | null;
|
|
1684
|
+
custom_properties: {
|
|
1685
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
1686
|
+
} | null;
|
|
1687
|
+
additional_display_fields: ({
|
|
1688
|
+
type: "standard";
|
|
1689
|
+
field: "customer_id" | "subscription_id" | "quote_id";
|
|
1690
|
+
} | {
|
|
1691
|
+
type: "custom_property";
|
|
1692
|
+
slug: string;
|
|
1693
|
+
} | {
|
|
1694
|
+
type: "custom";
|
|
1695
|
+
label: string;
|
|
1696
|
+
value: string;
|
|
1697
|
+
})[] | null;
|
|
1698
|
+
original_invoice_id: string | null;
|
|
1699
|
+
original_invoice_number: string | null;
|
|
1401
1700
|
line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
|
|
1701
|
+
allocations?: {
|
|
1702
|
+
invoice_id: string;
|
|
1703
|
+
amount: number;
|
|
1704
|
+
}[];
|
|
1402
1705
|
coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
|
|
1403
1706
|
transactions: ({
|
|
1404
1707
|
id: string;
|
|
1405
|
-
type: "subscription" | "one_time" | "refund";
|
|
1708
|
+
type: "subscription" | "one_time" | "refund" | "chargeback";
|
|
1406
1709
|
amount: number;
|
|
1407
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1710
|
+
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
1711
|
customer_id: string;
|
|
1409
1712
|
provider_id: string | null;
|
|
1410
1713
|
process_at: string;
|
|
1714
|
+
settled_at: string | null;
|
|
1411
1715
|
refunded_at: string | null;
|
|
1716
|
+
original_transaction_id: string | null;
|
|
1717
|
+
reversed_at: string | null;
|
|
1412
1718
|
last_refreshed_at: string | null;
|
|
1413
1719
|
provider_fee: {
|
|
1414
1720
|
amount: number;
|
|
1415
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1721
|
+
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
1722
|
exchange_rate: number | null;
|
|
1417
1723
|
} | null;
|
|
1418
1724
|
chargeback: {
|
|
1419
1725
|
amount: number;
|
|
1420
1726
|
last_chargeback_at: string;
|
|
1421
1727
|
} | null;
|
|
1728
|
+
integrations: {
|
|
1729
|
+
entity_id: string;
|
|
1730
|
+
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";
|
|
1731
|
+
provider_account_id: string;
|
|
1732
|
+
}[];
|
|
1422
1733
|
} & ({
|
|
1423
1734
|
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1424
1735
|
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
|
|
1425
1736
|
} | {
|
|
1426
1737
|
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);
|
|
1738
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
|
|
1448
1739
|
} | {
|
|
1449
1740
|
payment_method_type: "wallet";
|
|
1450
1741
|
wallet_id: string;
|
|
@@ -1454,45 +1745,41 @@ export declare class HyperlineAPI {
|
|
|
1454
1745
|
status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
|
|
1455
1746
|
} | {
|
|
1456
1747
|
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;
|
|
1748
|
+
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
1749
|
error_message: string | null;
|
|
1459
1750
|
}))[];
|
|
1751
|
+
public_url: string;
|
|
1752
|
+
issued_at: string;
|
|
1460
1753
|
} & {
|
|
1461
1754
|
integrations: {
|
|
1462
1755
|
entity_id: string;
|
|
1463
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1756
|
+
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
1757
|
provider_account_id: string;
|
|
1465
1758
|
}[];
|
|
1466
1759
|
}) | null>;
|
|
1467
|
-
getInvoices(
|
|
1468
|
-
meta: {
|
|
1469
|
-
total: number;
|
|
1470
|
-
taken: number;
|
|
1471
|
-
skipped: number;
|
|
1472
|
-
};
|
|
1760
|
+
getInvoices(query?: paths['/v2/invoices']['get']['parameters']['query']): Promise<{
|
|
1473
1761
|
data: import("./_types.generated").components["schemas"]["Invoice"][];
|
|
1762
|
+
next_cursor: string | null;
|
|
1763
|
+
has_more: boolean;
|
|
1764
|
+
total?: number;
|
|
1474
1765
|
} | null>;
|
|
1475
|
-
getInvoicesByCustomerId(id: string, filters?:
|
|
1476
|
-
meta: {
|
|
1477
|
-
total: number;
|
|
1478
|
-
taken: number;
|
|
1479
|
-
skipped: number;
|
|
1480
|
-
};
|
|
1766
|
+
getInvoicesByCustomerId(id: string, filters?: paths['/v2/invoices']['get']['parameters']['query']): Promise<{
|
|
1481
1767
|
data: import("./_types.generated").components["schemas"]["Invoice"][];
|
|
1768
|
+
next_cursor: string | null;
|
|
1769
|
+
has_more: boolean;
|
|
1770
|
+
total?: number;
|
|
1482
1771
|
} | null>;
|
|
1483
1772
|
getInvoiceDownload(id: string): Promise<string | null>;
|
|
1484
|
-
getAllInvoices(items?: paths['/
|
|
1773
|
+
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']>;
|
|
1485
1774
|
voidInvoice(id: string, data?: NonNullable<paths['/v1/invoices/{id}/void']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
1486
1775
|
id: string;
|
|
1487
1776
|
number: string;
|
|
1488
1777
|
type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
|
|
1489
1778
|
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";
|
|
1779
|
+
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
1780
|
reference: string | null;
|
|
1492
1781
|
purchase_order: string | null;
|
|
1493
|
-
|
|
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";
|
|
1782
|
+
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
1783
|
source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
|
|
1497
1784
|
total_amount: number;
|
|
1498
1785
|
amount_due: number;
|
|
@@ -1517,13 +1804,17 @@ export declare class HyperlineAPI {
|
|
|
1517
1804
|
email: string | null;
|
|
1518
1805
|
external_id: string | null;
|
|
1519
1806
|
vat_number: string | null;
|
|
1807
|
+
tax_id: string | null;
|
|
1808
|
+
local_tax_number: string | null;
|
|
1809
|
+
registration_number: string | null;
|
|
1520
1810
|
address: import("./_types.generated").components["schemas"]["Address"];
|
|
1521
1811
|
};
|
|
1522
1812
|
seller: {
|
|
1523
1813
|
id: string;
|
|
1524
1814
|
name: string;
|
|
1525
1815
|
tax_id: string | null;
|
|
1526
|
-
|
|
1816
|
+
registration_number: string | null;
|
|
1817
|
+
address: import("./_types.generated").components["schemas"]["Address"] & unknown;
|
|
1527
1818
|
};
|
|
1528
1819
|
subscription_id: string | null;
|
|
1529
1820
|
period_starts_at: string | null;
|
|
@@ -1537,53 +1828,61 @@ export declare class HyperlineAPI {
|
|
|
1537
1828
|
properties: {
|
|
1538
1829
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
1539
1830
|
} | null;
|
|
1831
|
+
custom_properties: {
|
|
1832
|
+
[key: string]: string | number | boolean | string[] | null;
|
|
1833
|
+
} | null;
|
|
1834
|
+
additional_display_fields: ({
|
|
1835
|
+
type: "standard";
|
|
1836
|
+
field: "customer_id" | "subscription_id" | "quote_id";
|
|
1837
|
+
} | {
|
|
1838
|
+
type: "custom_property";
|
|
1839
|
+
slug: string;
|
|
1840
|
+
} | {
|
|
1841
|
+
type: "custom";
|
|
1842
|
+
label: string;
|
|
1843
|
+
value: string;
|
|
1844
|
+
})[] | null;
|
|
1845
|
+
original_invoice_id: string | null;
|
|
1846
|
+
original_invoice_number: string | null;
|
|
1540
1847
|
line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
|
|
1848
|
+
allocations?: {
|
|
1849
|
+
invoice_id: string;
|
|
1850
|
+
amount: number;
|
|
1851
|
+
}[];
|
|
1541
1852
|
coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
|
|
1542
1853
|
transactions: ({
|
|
1543
1854
|
id: string;
|
|
1544
|
-
type: "subscription" | "one_time" | "refund";
|
|
1855
|
+
type: "subscription" | "one_time" | "refund" | "chargeback";
|
|
1545
1856
|
amount: number;
|
|
1546
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1857
|
+
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
1858
|
customer_id: string;
|
|
1548
1859
|
provider_id: string | null;
|
|
1549
1860
|
process_at: string;
|
|
1861
|
+
settled_at: string | null;
|
|
1550
1862
|
refunded_at: string | null;
|
|
1863
|
+
original_transaction_id: string | null;
|
|
1864
|
+
reversed_at: string | null;
|
|
1551
1865
|
last_refreshed_at: string | null;
|
|
1552
1866
|
provider_fee: {
|
|
1553
1867
|
amount: number;
|
|
1554
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "
|
|
1868
|
+
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
1869
|
exchange_rate: number | null;
|
|
1556
1870
|
} | null;
|
|
1557
1871
|
chargeback: {
|
|
1558
1872
|
amount: number;
|
|
1559
1873
|
last_chargeback_at: string;
|
|
1560
1874
|
} | null;
|
|
1875
|
+
integrations: {
|
|
1876
|
+
entity_id: string;
|
|
1877
|
+
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";
|
|
1878
|
+
provider_account_id: string;
|
|
1879
|
+
}[];
|
|
1561
1880
|
} & ({
|
|
1562
1881
|
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1563
1882
|
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
|
|
1564
1883
|
} | {
|
|
1565
1884
|
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);
|
|
1885
|
+
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
|
|
1587
1886
|
} | {
|
|
1588
1887
|
payment_method_type: "wallet";
|
|
1589
1888
|
wallet_id: string;
|
|
@@ -1593,13 +1892,14 @@ export declare class HyperlineAPI {
|
|
|
1593
1892
|
status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
|
|
1594
1893
|
} | {
|
|
1595
1894
|
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;
|
|
1895
|
+
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
1896
|
error_message: string | null;
|
|
1598
1897
|
}))[];
|
|
1898
|
+
public_url: string;
|
|
1599
1899
|
} & {
|
|
1600
1900
|
integrations: {
|
|
1601
1901
|
entity_id: string;
|
|
1602
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1902
|
+
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
1903
|
provider_account_id: string;
|
|
1604
1904
|
}[];
|
|
1605
1905
|
}) | null>;
|
|
@@ -1610,92 +1910,109 @@ export declare class HyperlineAPI {
|
|
|
1610
1910
|
taken: number;
|
|
1611
1911
|
skipped: number;
|
|
1612
1912
|
};
|
|
1613
|
-
data: (import("./_types.generated").components["schemas"]["PaymentMethod"] & (
|
|
1913
|
+
data: (import("./_types.generated").components["schemas"]["PaymentMethod"] & ({
|
|
1914
|
+
id: string;
|
|
1915
|
+
status: "active" | "pending" | "expired" | "errored";
|
|
1916
|
+
type: "card" | "apple_pay" | "google_pay";
|
|
1917
|
+
last_4_digits: number | null;
|
|
1918
|
+
expiration_date: string | null;
|
|
1919
|
+
brand: string | null;
|
|
1920
|
+
} | {
|
|
1921
|
+
id: string;
|
|
1922
|
+
status: "errored";
|
|
1923
|
+
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
|
|
1924
|
+
type: "card" | "apple_pay" | "google_pay";
|
|
1925
|
+
last_4_digits: number | null;
|
|
1926
|
+
expiration_date: string | null;
|
|
1927
|
+
brand: string | null;
|
|
1928
|
+
} | {
|
|
1929
|
+
id: string;
|
|
1930
|
+
status: "active" | "pending" | "expired" | "errored";
|
|
1931
|
+
type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1932
|
+
account_number_ending: string | null;
|
|
1933
|
+
} | {
|
|
1934
|
+
id: string;
|
|
1935
|
+
status: "errored";
|
|
1936
|
+
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
|
|
1937
|
+
type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1938
|
+
account_number_ending: string | null;
|
|
1939
|
+
} | {
|
|
1940
|
+
id: string;
|
|
1941
|
+
status: "active" | "pending" | "expired" | "errored";
|
|
1942
|
+
type: "stripe_link";
|
|
1943
|
+
} | {
|
|
1944
|
+
id: string;
|
|
1945
|
+
status: "errored";
|
|
1946
|
+
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
|
|
1947
|
+
type: "stripe_link";
|
|
1948
|
+
}))[];
|
|
1614
1949
|
} | null>;
|
|
1615
|
-
getPaymentMethod(customerId: string, paymentMethodId: string): Promise<
|
|
1950
|
+
getPaymentMethod(customerId: string, paymentMethodId: string): Promise<{
|
|
1616
1951
|
id: string;
|
|
1617
|
-
|
|
1618
|
-
status: "active" | "pending";
|
|
1619
|
-
} & {
|
|
1952
|
+
status: "active" | "pending" | "expired" | "errored";
|
|
1620
1953
|
type: "card" | "apple_pay" | "google_pay";
|
|
1621
1954
|
last_4_digits: number | null;
|
|
1622
1955
|
expiration_date: string | null;
|
|
1623
1956
|
brand: string | null;
|
|
1624
|
-
} & {
|
|
1625
1957
|
integration: {
|
|
1626
1958
|
entity_id: string;
|
|
1627
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1959
|
+
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";
|
|
1628
1960
|
provider_account_id: string;
|
|
1629
1961
|
} | null;
|
|
1630
|
-
}
|
|
1962
|
+
} | {
|
|
1631
1963
|
id: string;
|
|
1632
|
-
} & {
|
|
1633
1964
|
status: "errored";
|
|
1634
|
-
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
|
|
1635
|
-
} & {
|
|
1965
|
+
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
|
|
1636
1966
|
type: "card" | "apple_pay" | "google_pay";
|
|
1637
1967
|
last_4_digits: number | null;
|
|
1638
1968
|
expiration_date: string | null;
|
|
1639
1969
|
brand: string | null;
|
|
1640
|
-
} & {
|
|
1641
1970
|
integration: {
|
|
1642
1971
|
entity_id: string;
|
|
1643
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1972
|
+
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
1973
|
provider_account_id: string;
|
|
1645
1974
|
} | null;
|
|
1646
|
-
}
|
|
1975
|
+
} | {
|
|
1647
1976
|
id: string;
|
|
1648
|
-
|
|
1649
|
-
status: "active" | "pending";
|
|
1650
|
-
} & {
|
|
1977
|
+
status: "active" | "pending" | "expired" | "errored";
|
|
1651
1978
|
type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1652
1979
|
account_number_ending: string | null;
|
|
1653
|
-
} & {
|
|
1654
1980
|
integration: {
|
|
1655
1981
|
entity_id: string;
|
|
1656
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1982
|
+
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
1983
|
provider_account_id: string;
|
|
1658
1984
|
} | null;
|
|
1659
|
-
}
|
|
1985
|
+
} | {
|
|
1660
1986
|
id: string;
|
|
1661
|
-
} & {
|
|
1662
1987
|
status: "errored";
|
|
1663
|
-
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
|
|
1664
|
-
} & {
|
|
1988
|
+
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
|
|
1665
1989
|
type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1666
1990
|
account_number_ending: string | null;
|
|
1667
|
-
} & {
|
|
1668
1991
|
integration: {
|
|
1669
1992
|
entity_id: string;
|
|
1670
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1993
|
+
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
1994
|
provider_account_id: string;
|
|
1672
1995
|
} | null;
|
|
1673
|
-
}
|
|
1996
|
+
} | {
|
|
1674
1997
|
id: string;
|
|
1675
|
-
|
|
1676
|
-
status: "active" | "pending";
|
|
1677
|
-
} & {
|
|
1998
|
+
status: "active" | "pending" | "expired" | "errored";
|
|
1678
1999
|
type: "stripe_link";
|
|
1679
|
-
} & {
|
|
1680
2000
|
integration: {
|
|
1681
2001
|
entity_id: string;
|
|
1682
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
2002
|
+
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
2003
|
provider_account_id: string;
|
|
1684
2004
|
} | null;
|
|
1685
|
-
}
|
|
2005
|
+
} | {
|
|
1686
2006
|
id: string;
|
|
1687
|
-
} & {
|
|
1688
2007
|
status: "errored";
|
|
1689
|
-
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
|
|
1690
|
-
} & {
|
|
2008
|
+
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "mandate_invalid" | "not_supported" | "unknown";
|
|
1691
2009
|
type: "stripe_link";
|
|
1692
|
-
} & {
|
|
1693
2010
|
integration: {
|
|
1694
2011
|
entity_id: string;
|
|
1695
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
2012
|
+
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
2013
|
provider_account_id: string;
|
|
1697
2014
|
} | null;
|
|
1698
|
-
}
|
|
2015
|
+
} | null>;
|
|
1699
2016
|
createBillableEvent(data: CreateBillableEvent[]): Promise<BillableEvents | null>;
|
|
1700
2017
|
getComponentToken(data: {
|
|
1701
2018
|
customer_id: string;
|