@vrplatform/hyperline-client 1.0.13 → 1.0.15
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 +5230 -1716
- package/build/main/_types.generated.js.map +1 -1
- package/build/main/client.d.ts +564 -313
- package/build/main/client.js +38 -10
- package/build/main/client.js.map +1 -1
- package/build/main/const.d.ts +3 -1
- package/build/main/const.js +2 -0
- package/build/main/const.js.map +1 -1
- package/build/module/_types.generated.d.ts +5230 -1716
- package/build/module/_types.generated.js.map +1 -1
- package/build/module/client.d.ts +564 -313
- package/build/module/client.js +38 -10
- package/build/module/client.js.map +1 -1
- package/build/module/const.d.ts +3 -1
- package/build/module/const.js +2 -0
- package/build/module/const.js.map +1 -1
- package/package.json +1 -1
- package/src/_types.generated.ts +5230 -1716
- package/src/client.ts +62 -10
- package/src/const.ts +3 -1
package/build/module/client.d.ts
CHANGED
|
@@ -15,19 +15,19 @@ export declare class HyperlineAPI {
|
|
|
15
15
|
name: string;
|
|
16
16
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
17
17
|
status: "active" | "archived";
|
|
18
|
-
currency:
|
|
19
|
-
country:
|
|
18
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
19
|
+
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
20
20
|
vat_number: string | null;
|
|
21
21
|
vat_number_valid: boolean;
|
|
22
22
|
vat_rate_custom: number | null;
|
|
23
23
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
24
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/
|
|
24
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
25
25
|
external_id: string | null;
|
|
26
26
|
properties: {
|
|
27
27
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
28
28
|
} | null;
|
|
29
29
|
custom_properties: {
|
|
30
|
-
[key: string]: string | number | boolean |
|
|
30
|
+
[key: string]: string | number | boolean | null;
|
|
31
31
|
} | null;
|
|
32
32
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
33
33
|
billing_email: string | null;
|
|
@@ -47,22 +47,29 @@ export declare class HyperlineAPI {
|
|
|
47
47
|
plan_id: string | null;
|
|
48
48
|
checkout_session_id: string | null;
|
|
49
49
|
}[];
|
|
50
|
-
created_at:
|
|
51
|
-
updated_at:
|
|
52
|
-
deleted_at:
|
|
50
|
+
created_at: string;
|
|
51
|
+
updated_at: string;
|
|
52
|
+
deleted_at: string | null;
|
|
53
53
|
} & {
|
|
54
54
|
providers: {
|
|
55
|
-
gocardless?: string;
|
|
56
|
-
mollie?: string;
|
|
57
55
|
stripe?: string;
|
|
56
|
+
mollie?: string;
|
|
57
|
+
gocardless?: string;
|
|
58
58
|
airwallex?: string;
|
|
59
|
-
hubspot?: string;
|
|
60
59
|
salesforce?: string;
|
|
60
|
+
hubspot?: string;
|
|
61
61
|
xero?: string;
|
|
62
|
-
"exact-online"?: string;
|
|
63
62
|
pennylane?: string;
|
|
63
|
+
"exact-online"?: string;
|
|
64
|
+
quickbooks?: string;
|
|
64
65
|
netsuite?: string;
|
|
66
|
+
anrok?: string;
|
|
65
67
|
};
|
|
68
|
+
integrations: {
|
|
69
|
+
entity_id: string;
|
|
70
|
+
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
71
|
+
provider_account_id: string;
|
|
72
|
+
}[];
|
|
66
73
|
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
67
74
|
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & unknown;
|
|
68
75
|
organisation_id: string | null;
|
|
@@ -73,19 +80,19 @@ export declare class HyperlineAPI {
|
|
|
73
80
|
name: string;
|
|
74
81
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
75
82
|
status: "active" | "archived";
|
|
76
|
-
currency:
|
|
77
|
-
country:
|
|
83
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
84
|
+
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
78
85
|
vat_number: string | null;
|
|
79
86
|
vat_number_valid: boolean;
|
|
80
87
|
vat_rate_custom: number | null;
|
|
81
88
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
82
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/
|
|
89
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
83
90
|
external_id: string | null;
|
|
84
91
|
properties: {
|
|
85
92
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
86
93
|
} | null;
|
|
87
94
|
custom_properties: {
|
|
88
|
-
[key: string]: string | number | boolean |
|
|
95
|
+
[key: string]: string | number | boolean | null;
|
|
89
96
|
} | null;
|
|
90
97
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
91
98
|
billing_email: string | null;
|
|
@@ -105,11 +112,11 @@ export declare class HyperlineAPI {
|
|
|
105
112
|
plan_id: string | null;
|
|
106
113
|
checkout_session_id: string | null;
|
|
107
114
|
}[];
|
|
108
|
-
created_at:
|
|
109
|
-
updated_at:
|
|
110
|
-
deleted_at:
|
|
115
|
+
created_at: string;
|
|
116
|
+
updated_at: string;
|
|
117
|
+
deleted_at: string | null;
|
|
111
118
|
} | undefined>;
|
|
112
|
-
getCustomers(skip?: number, take?: number): Promise<{
|
|
119
|
+
getCustomers(skip?: number, take?: number, query?: operations['getCustomers']['parameters']['query']): Promise<{
|
|
113
120
|
meta: {
|
|
114
121
|
total: number;
|
|
115
122
|
taken: number;
|
|
@@ -117,25 +124,25 @@ export declare class HyperlineAPI {
|
|
|
117
124
|
};
|
|
118
125
|
data: import("./_types.generated").components["schemas"]["Customer"][];
|
|
119
126
|
} | null>;
|
|
120
|
-
getAllCustomers(items?: paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']): Promise<paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']>;
|
|
127
|
+
getAllCustomers(items?: paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getCustomers']['parameters']['query']): Promise<paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']>;
|
|
121
128
|
createCustomer(data: NonNullable<paths['/v1/customers']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
122
129
|
id: string;
|
|
123
130
|
name: string;
|
|
124
131
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
125
132
|
status: "active" | "archived";
|
|
126
|
-
currency:
|
|
127
|
-
country:
|
|
133
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
134
|
+
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
128
135
|
vat_number: string | null;
|
|
129
136
|
vat_number_valid: boolean;
|
|
130
137
|
vat_rate_custom: number | null;
|
|
131
138
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
132
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/
|
|
139
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
133
140
|
external_id: string | null;
|
|
134
141
|
properties: {
|
|
135
142
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
136
143
|
} | null;
|
|
137
144
|
custom_properties: {
|
|
138
|
-
[key: string]: string | number | boolean |
|
|
145
|
+
[key: string]: string | number | boolean | null;
|
|
139
146
|
} | null;
|
|
140
147
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
141
148
|
billing_email: string | null;
|
|
@@ -155,22 +162,29 @@ export declare class HyperlineAPI {
|
|
|
155
162
|
plan_id: string | null;
|
|
156
163
|
checkout_session_id: string | null;
|
|
157
164
|
}[];
|
|
158
|
-
created_at:
|
|
159
|
-
updated_at:
|
|
160
|
-
deleted_at:
|
|
165
|
+
created_at: string;
|
|
166
|
+
updated_at: string;
|
|
167
|
+
deleted_at: string | null;
|
|
161
168
|
} & {
|
|
162
169
|
providers: {
|
|
163
|
-
gocardless?: string;
|
|
164
|
-
mollie?: string;
|
|
165
170
|
stripe?: string;
|
|
171
|
+
mollie?: string;
|
|
172
|
+
gocardless?: string;
|
|
166
173
|
airwallex?: string;
|
|
167
|
-
hubspot?: string;
|
|
168
174
|
salesforce?: string;
|
|
175
|
+
hubspot?: string;
|
|
169
176
|
xero?: string;
|
|
170
|
-
"exact-online"?: string;
|
|
171
177
|
pennylane?: string;
|
|
178
|
+
"exact-online"?: string;
|
|
179
|
+
quickbooks?: string;
|
|
172
180
|
netsuite?: string;
|
|
181
|
+
anrok?: string;
|
|
173
182
|
};
|
|
183
|
+
integrations: {
|
|
184
|
+
entity_id: string;
|
|
185
|
+
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
186
|
+
provider_account_id: string;
|
|
187
|
+
}[];
|
|
174
188
|
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
175
189
|
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & unknown;
|
|
176
190
|
organisation_id: string | null;
|
|
@@ -181,19 +195,19 @@ export declare class HyperlineAPI {
|
|
|
181
195
|
name: string;
|
|
182
196
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
183
197
|
status: "active" | "archived";
|
|
184
|
-
currency:
|
|
185
|
-
country:
|
|
198
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
199
|
+
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
186
200
|
vat_number: string | null;
|
|
187
201
|
vat_number_valid: boolean;
|
|
188
202
|
vat_rate_custom: number | null;
|
|
189
203
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
190
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/
|
|
204
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
191
205
|
external_id: string | null;
|
|
192
206
|
properties: {
|
|
193
207
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
194
208
|
} | null;
|
|
195
209
|
custom_properties: {
|
|
196
|
-
[key: string]: string | number | boolean |
|
|
210
|
+
[key: string]: string | number | boolean | null;
|
|
197
211
|
} | null;
|
|
198
212
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
199
213
|
billing_email: string | null;
|
|
@@ -213,22 +227,29 @@ export declare class HyperlineAPI {
|
|
|
213
227
|
plan_id: string | null;
|
|
214
228
|
checkout_session_id: string | null;
|
|
215
229
|
}[];
|
|
216
|
-
created_at:
|
|
217
|
-
updated_at:
|
|
218
|
-
deleted_at:
|
|
230
|
+
created_at: string;
|
|
231
|
+
updated_at: string;
|
|
232
|
+
deleted_at: string | null;
|
|
219
233
|
} & {
|
|
220
234
|
providers: {
|
|
221
|
-
gocardless?: string;
|
|
222
|
-
mollie?: string;
|
|
223
235
|
stripe?: string;
|
|
236
|
+
mollie?: string;
|
|
237
|
+
gocardless?: string;
|
|
224
238
|
airwallex?: string;
|
|
225
|
-
hubspot?: string;
|
|
226
239
|
salesforce?: string;
|
|
240
|
+
hubspot?: string;
|
|
227
241
|
xero?: string;
|
|
228
|
-
"exact-online"?: string;
|
|
229
242
|
pennylane?: string;
|
|
243
|
+
"exact-online"?: string;
|
|
244
|
+
quickbooks?: string;
|
|
230
245
|
netsuite?: string;
|
|
246
|
+
anrok?: string;
|
|
231
247
|
};
|
|
248
|
+
integrations: {
|
|
249
|
+
entity_id: string;
|
|
250
|
+
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
251
|
+
provider_account_id: string;
|
|
252
|
+
}[];
|
|
232
253
|
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
233
254
|
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & unknown;
|
|
234
255
|
organisation_id: string | null;
|
|
@@ -240,19 +261,19 @@ export declare class HyperlineAPI {
|
|
|
240
261
|
name: string;
|
|
241
262
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
242
263
|
status: "active" | "archived";
|
|
243
|
-
currency:
|
|
244
|
-
country:
|
|
264
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
265
|
+
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
245
266
|
vat_number: string | null;
|
|
246
267
|
vat_number_valid: boolean;
|
|
247
268
|
vat_rate_custom: number | null;
|
|
248
269
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
249
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/
|
|
270
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
250
271
|
external_id: string | null;
|
|
251
272
|
properties: {
|
|
252
273
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
253
274
|
} | null;
|
|
254
275
|
custom_properties: {
|
|
255
|
-
[key: string]: string | number | boolean |
|
|
276
|
+
[key: string]: string | number | boolean | null;
|
|
256
277
|
} | null;
|
|
257
278
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
258
279
|
billing_email: string | null;
|
|
@@ -272,28 +293,28 @@ export declare class HyperlineAPI {
|
|
|
272
293
|
plan_id: string | null;
|
|
273
294
|
checkout_session_id: string | null;
|
|
274
295
|
}[];
|
|
275
|
-
created_at:
|
|
276
|
-
updated_at:
|
|
277
|
-
deleted_at:
|
|
296
|
+
created_at: string;
|
|
297
|
+
updated_at: string;
|
|
298
|
+
deleted_at: string | null;
|
|
278
299
|
} | null>;
|
|
279
300
|
unarchiveCustomer(id: string): Promise<{
|
|
280
301
|
id: string;
|
|
281
302
|
name: string;
|
|
282
303
|
type: "corporate" | "person" | "automatically_created" | null;
|
|
283
304
|
status: "active" | "archived";
|
|
284
|
-
currency:
|
|
285
|
-
country:
|
|
305
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
306
|
+
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
286
307
|
vat_number: string | null;
|
|
287
308
|
vat_number_valid: boolean;
|
|
288
309
|
vat_rate_custom: number | null;
|
|
289
310
|
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
290
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/
|
|
311
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
291
312
|
external_id: string | null;
|
|
292
313
|
properties: {
|
|
293
314
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
294
315
|
} | null;
|
|
295
316
|
custom_properties: {
|
|
296
|
-
[key: string]: string | number | boolean |
|
|
317
|
+
[key: string]: string | number | boolean | null;
|
|
297
318
|
} | null;
|
|
298
319
|
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
299
320
|
billing_email: string | null;
|
|
@@ -313,16 +334,16 @@ export declare class HyperlineAPI {
|
|
|
313
334
|
plan_id: string | null;
|
|
314
335
|
checkout_session_id: string | null;
|
|
315
336
|
}[];
|
|
316
|
-
created_at:
|
|
317
|
-
updated_at:
|
|
318
|
-
deleted_at:
|
|
337
|
+
created_at: string;
|
|
338
|
+
updated_at: string;
|
|
339
|
+
deleted_at: string | null;
|
|
319
340
|
} | null>;
|
|
320
341
|
getCustomerPortal(id: string): Promise<{
|
|
321
342
|
url: string;
|
|
322
343
|
} | null>;
|
|
323
344
|
getSubscription(id: string, liveBilling?: boolean): Promise<({
|
|
324
345
|
id: string;
|
|
325
|
-
currency:
|
|
346
|
+
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";
|
|
326
347
|
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
327
348
|
purchase_order: string | null;
|
|
328
349
|
customer_id: string;
|
|
@@ -341,55 +362,56 @@ export declare class HyperlineAPI {
|
|
|
341
362
|
count: number;
|
|
342
363
|
} | null;
|
|
343
364
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
344
|
-
starts_at:
|
|
345
|
-
contract_start:
|
|
346
|
-
contract_end:
|
|
347
|
-
initial_billing_at:
|
|
348
|
-
paused_at:
|
|
349
|
-
reactivate_at:
|
|
350
|
-
cancel_at:
|
|
365
|
+
starts_at: string;
|
|
366
|
+
contract_start: string;
|
|
367
|
+
contract_end: string | null;
|
|
368
|
+
initial_billing_at: string | null;
|
|
369
|
+
paused_at: string | null;
|
|
370
|
+
reactivate_at: string | null;
|
|
371
|
+
cancel_at: string | null;
|
|
351
372
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
352
|
-
cancellation_amount:
|
|
353
|
-
estimated_arr:
|
|
354
|
-
current_period_started_at:
|
|
355
|
-
current_period_ends_at:
|
|
356
|
-
next_payment_at:
|
|
357
|
-
next_payment_amount:
|
|
358
|
-
renews_at:
|
|
373
|
+
cancellation_amount: number | null;
|
|
374
|
+
estimated_arr: number | null;
|
|
375
|
+
current_period_started_at: string | null;
|
|
376
|
+
current_period_ends_at: string | null;
|
|
377
|
+
next_payment_at: string | null;
|
|
378
|
+
next_payment_amount: number | null;
|
|
379
|
+
renews_at: string | null;
|
|
359
380
|
current_phase_id: string | null;
|
|
360
381
|
properties: {
|
|
361
382
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
362
383
|
} | null;
|
|
363
384
|
custom_properties: {
|
|
364
|
-
[key: string]: string | number | boolean |
|
|
385
|
+
[key: string]: string | number | boolean | null;
|
|
365
386
|
} | null;
|
|
366
|
-
created_at:
|
|
367
|
-
updated_at:
|
|
387
|
+
created_at: string;
|
|
388
|
+
updated_at: string;
|
|
368
389
|
} & {
|
|
369
390
|
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"])[];
|
|
370
391
|
coupons: (({
|
|
371
392
|
description: string | null;
|
|
372
|
-
expiration_date:
|
|
393
|
+
expiration_date: string | null;
|
|
373
394
|
redemption_limit: number | null;
|
|
374
|
-
created_at:
|
|
395
|
+
created_at: string;
|
|
375
396
|
type: "amount";
|
|
376
|
-
discount_amount:
|
|
377
|
-
currency:
|
|
397
|
+
discount_amount: number;
|
|
398
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
378
399
|
} | {
|
|
379
400
|
description: string | null;
|
|
380
|
-
expiration_date:
|
|
401
|
+
expiration_date: string | null;
|
|
381
402
|
redemption_limit: number | null;
|
|
382
|
-
created_at:
|
|
403
|
+
created_at: string;
|
|
383
404
|
type: "percent";
|
|
384
405
|
discount_percent: number;
|
|
385
406
|
}) & {
|
|
386
407
|
id: string | null;
|
|
408
|
+
promotion_code_id: string | null;
|
|
387
409
|
name: string | null;
|
|
388
410
|
subscription_coupon_id: string;
|
|
389
411
|
repeat: "once" | "forever" | "custom";
|
|
390
412
|
product_ids: string[];
|
|
391
|
-
apply_at:
|
|
392
|
-
expires_at:
|
|
413
|
+
apply_at: string | null;
|
|
414
|
+
expires_at: string | null;
|
|
393
415
|
})[];
|
|
394
416
|
phases: {
|
|
395
417
|
id: string;
|
|
@@ -403,39 +425,40 @@ export declare class HyperlineAPI {
|
|
|
403
425
|
count: number;
|
|
404
426
|
} | null;
|
|
405
427
|
billing_date_setting: "phase_start" | "specific_date";
|
|
406
|
-
initial_billing_at:
|
|
407
|
-
starts_at:
|
|
408
|
-
ends_at:
|
|
428
|
+
initial_billing_at: string | null;
|
|
429
|
+
starts_at: string | null;
|
|
430
|
+
ends_at: string | null;
|
|
409
431
|
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
410
432
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
411
433
|
transition_invoicing_schedule: "immediately";
|
|
412
434
|
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"])[];
|
|
413
435
|
coupons: (({
|
|
414
436
|
description: string | null;
|
|
415
|
-
expiration_date:
|
|
437
|
+
expiration_date: string | null;
|
|
416
438
|
redemption_limit: number | null;
|
|
417
|
-
created_at:
|
|
439
|
+
created_at: string;
|
|
418
440
|
type: "amount";
|
|
419
|
-
discount_amount:
|
|
420
|
-
currency:
|
|
441
|
+
discount_amount: number;
|
|
442
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
421
443
|
} | {
|
|
422
444
|
description: string | null;
|
|
423
|
-
expiration_date:
|
|
445
|
+
expiration_date: string | null;
|
|
424
446
|
redemption_limit: number | null;
|
|
425
|
-
created_at:
|
|
447
|
+
created_at: string;
|
|
426
448
|
type: "percent";
|
|
427
449
|
discount_percent: number;
|
|
428
450
|
}) & {
|
|
429
451
|
id: string | null;
|
|
452
|
+
promotion_code_id: string | null;
|
|
430
453
|
name: string | null;
|
|
431
454
|
subscription_coupon_id: string;
|
|
432
455
|
repeat: "once" | "forever" | "custom";
|
|
433
456
|
product_ids: string[];
|
|
434
|
-
apply_at:
|
|
435
|
-
expires_at:
|
|
457
|
+
apply_at: string | null;
|
|
458
|
+
expires_at: string | null;
|
|
436
459
|
})[];
|
|
437
|
-
created_at:
|
|
438
|
-
updated_at:
|
|
460
|
+
created_at: string;
|
|
461
|
+
updated_at: string;
|
|
439
462
|
}[];
|
|
440
463
|
quote: {
|
|
441
464
|
id: string;
|
|
@@ -449,6 +472,24 @@ export declare class HyperlineAPI {
|
|
|
449
472
|
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
450
473
|
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
451
474
|
generate_draft_invoices: boolean;
|
|
475
|
+
contract_terms: {
|
|
476
|
+
status: "active" | "pending" | "finished";
|
|
477
|
+
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
478
|
+
end_strategy: "end_date" | "duration" | "manual";
|
|
479
|
+
starts_at: string | null;
|
|
480
|
+
ends_at: string | null;
|
|
481
|
+
duration: {
|
|
482
|
+
period: "days" | "weeks" | "months" | "years";
|
|
483
|
+
count: number;
|
|
484
|
+
} | null;
|
|
485
|
+
renew_automatically: boolean | ("true" | "false");
|
|
486
|
+
renew_for_duration: {
|
|
487
|
+
period: "days" | "weeks" | "months" | "years";
|
|
488
|
+
count: number;
|
|
489
|
+
} | null;
|
|
490
|
+
current_period_started_at: string | null;
|
|
491
|
+
current_period_ends_at: string | null;
|
|
492
|
+
} | null;
|
|
452
493
|
} & {
|
|
453
494
|
live_billing?: import("./_types.generated").components["schemas"]["LiveBilling"];
|
|
454
495
|
}) | null>;
|
|
@@ -463,7 +504,7 @@ export declare class HyperlineAPI {
|
|
|
463
504
|
getAllSubscriptions(items?: paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getSubscriptions']['parameters']['query']): Promise<paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data']>;
|
|
464
505
|
createSubscription(data: NonNullable<paths['/v2/subscriptions']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
465
506
|
id: string;
|
|
466
|
-
currency:
|
|
507
|
+
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";
|
|
467
508
|
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
468
509
|
purchase_order: string | null;
|
|
469
510
|
customer_id: string;
|
|
@@ -482,55 +523,56 @@ export declare class HyperlineAPI {
|
|
|
482
523
|
count: number;
|
|
483
524
|
} | null;
|
|
484
525
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
485
|
-
starts_at:
|
|
486
|
-
contract_start:
|
|
487
|
-
contract_end:
|
|
488
|
-
initial_billing_at:
|
|
489
|
-
paused_at:
|
|
490
|
-
reactivate_at:
|
|
491
|
-
cancel_at:
|
|
526
|
+
starts_at: string;
|
|
527
|
+
contract_start: string;
|
|
528
|
+
contract_end: string | null;
|
|
529
|
+
initial_billing_at: string | null;
|
|
530
|
+
paused_at: string | null;
|
|
531
|
+
reactivate_at: string | null;
|
|
532
|
+
cancel_at: string | null;
|
|
492
533
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
493
|
-
cancellation_amount:
|
|
494
|
-
estimated_arr:
|
|
495
|
-
current_period_started_at:
|
|
496
|
-
current_period_ends_at:
|
|
497
|
-
next_payment_at:
|
|
498
|
-
next_payment_amount:
|
|
499
|
-
renews_at:
|
|
534
|
+
cancellation_amount: number | null;
|
|
535
|
+
estimated_arr: number | null;
|
|
536
|
+
current_period_started_at: string | null;
|
|
537
|
+
current_period_ends_at: string | null;
|
|
538
|
+
next_payment_at: string | null;
|
|
539
|
+
next_payment_amount: number | null;
|
|
540
|
+
renews_at: string | null;
|
|
500
541
|
current_phase_id: string | null;
|
|
501
542
|
properties: {
|
|
502
543
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
503
544
|
} | null;
|
|
504
545
|
custom_properties: {
|
|
505
|
-
[key: string]: string | number | boolean |
|
|
546
|
+
[key: string]: string | number | boolean | null;
|
|
506
547
|
} | null;
|
|
507
|
-
created_at:
|
|
508
|
-
updated_at:
|
|
548
|
+
created_at: string;
|
|
549
|
+
updated_at: string;
|
|
509
550
|
} & {
|
|
510
551
|
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"])[];
|
|
511
552
|
coupons: (({
|
|
512
553
|
description: string | null;
|
|
513
|
-
expiration_date:
|
|
554
|
+
expiration_date: string | null;
|
|
514
555
|
redemption_limit: number | null;
|
|
515
|
-
created_at:
|
|
556
|
+
created_at: string;
|
|
516
557
|
type: "amount";
|
|
517
|
-
discount_amount:
|
|
518
|
-
currency:
|
|
558
|
+
discount_amount: number;
|
|
559
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
519
560
|
} | {
|
|
520
561
|
description: string | null;
|
|
521
|
-
expiration_date:
|
|
562
|
+
expiration_date: string | null;
|
|
522
563
|
redemption_limit: number | null;
|
|
523
|
-
created_at:
|
|
564
|
+
created_at: string;
|
|
524
565
|
type: "percent";
|
|
525
566
|
discount_percent: number;
|
|
526
567
|
}) & {
|
|
527
568
|
id: string | null;
|
|
569
|
+
promotion_code_id: string | null;
|
|
528
570
|
name: string | null;
|
|
529
571
|
subscription_coupon_id: string;
|
|
530
572
|
repeat: "once" | "forever" | "custom";
|
|
531
573
|
product_ids: string[];
|
|
532
|
-
apply_at:
|
|
533
|
-
expires_at:
|
|
574
|
+
apply_at: string | null;
|
|
575
|
+
expires_at: string | null;
|
|
534
576
|
})[];
|
|
535
577
|
phases: {
|
|
536
578
|
id: string;
|
|
@@ -544,39 +586,40 @@ export declare class HyperlineAPI {
|
|
|
544
586
|
count: number;
|
|
545
587
|
} | null;
|
|
546
588
|
billing_date_setting: "phase_start" | "specific_date";
|
|
547
|
-
initial_billing_at:
|
|
548
|
-
starts_at:
|
|
549
|
-
ends_at:
|
|
589
|
+
initial_billing_at: string | null;
|
|
590
|
+
starts_at: string | null;
|
|
591
|
+
ends_at: string | null;
|
|
550
592
|
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
551
593
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
552
594
|
transition_invoicing_schedule: "immediately";
|
|
553
595
|
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
554
596
|
coupons: (({
|
|
555
597
|
description: string | null;
|
|
556
|
-
expiration_date:
|
|
598
|
+
expiration_date: string | null;
|
|
557
599
|
redemption_limit: number | null;
|
|
558
|
-
created_at:
|
|
600
|
+
created_at: string;
|
|
559
601
|
type: "amount";
|
|
560
|
-
discount_amount:
|
|
561
|
-
currency:
|
|
602
|
+
discount_amount: number;
|
|
603
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
562
604
|
} | {
|
|
563
605
|
description: string | null;
|
|
564
|
-
expiration_date:
|
|
606
|
+
expiration_date: string | null;
|
|
565
607
|
redemption_limit: number | null;
|
|
566
|
-
created_at:
|
|
608
|
+
created_at: string;
|
|
567
609
|
type: "percent";
|
|
568
610
|
discount_percent: number;
|
|
569
611
|
}) & {
|
|
570
612
|
id: string | null;
|
|
613
|
+
promotion_code_id: string | null;
|
|
571
614
|
name: string | null;
|
|
572
615
|
subscription_coupon_id: string;
|
|
573
616
|
repeat: "once" | "forever" | "custom";
|
|
574
617
|
product_ids: string[];
|
|
575
|
-
apply_at:
|
|
576
|
-
expires_at:
|
|
618
|
+
apply_at: string | null;
|
|
619
|
+
expires_at: string | null;
|
|
577
620
|
})[];
|
|
578
|
-
created_at:
|
|
579
|
-
updated_at:
|
|
621
|
+
created_at: string;
|
|
622
|
+
updated_at: string;
|
|
580
623
|
}[];
|
|
581
624
|
quote: {
|
|
582
625
|
id: string;
|
|
@@ -590,13 +633,28 @@ export declare class HyperlineAPI {
|
|
|
590
633
|
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
591
634
|
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
592
635
|
generate_draft_invoices: boolean;
|
|
636
|
+
contract_terms: {
|
|
637
|
+
status: "active" | "pending" | "finished";
|
|
638
|
+
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
639
|
+
end_strategy: "end_date" | "duration" | "manual";
|
|
640
|
+
starts_at: string | null;
|
|
641
|
+
ends_at: string | null;
|
|
642
|
+
duration: {
|
|
643
|
+
period: "days" | "weeks" | "months" | "years";
|
|
644
|
+
count: number;
|
|
645
|
+
} | null;
|
|
646
|
+
renew_automatically: boolean | ("true" | "false");
|
|
647
|
+
renew_for_duration: {
|
|
648
|
+
period: "days" | "weeks" | "months" | "years";
|
|
649
|
+
count: number;
|
|
650
|
+
} | null;
|
|
651
|
+
current_period_started_at: string | null;
|
|
652
|
+
current_period_ends_at: string | null;
|
|
653
|
+
} | null;
|
|
593
654
|
}) | null>;
|
|
594
|
-
updateSubscription(id: string, data: NonNullable<paths['/
|
|
595
|
-
id: string;
|
|
596
|
-
} | null>;
|
|
597
|
-
cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
655
|
+
updateSubscription(id: string, data: NonNullable<paths['/v2/subscriptions/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
|
|
598
656
|
id: string;
|
|
599
|
-
currency:
|
|
657
|
+
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";
|
|
600
658
|
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
601
659
|
purchase_order: string | null;
|
|
602
660
|
customer_id: string;
|
|
@@ -615,55 +673,56 @@ export declare class HyperlineAPI {
|
|
|
615
673
|
count: number;
|
|
616
674
|
} | null;
|
|
617
675
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
618
|
-
starts_at:
|
|
619
|
-
contract_start:
|
|
620
|
-
contract_end:
|
|
621
|
-
initial_billing_at:
|
|
622
|
-
paused_at:
|
|
623
|
-
reactivate_at:
|
|
624
|
-
cancel_at:
|
|
676
|
+
starts_at: string;
|
|
677
|
+
contract_start: string;
|
|
678
|
+
contract_end: string | null;
|
|
679
|
+
initial_billing_at: string | null;
|
|
680
|
+
paused_at: string | null;
|
|
681
|
+
reactivate_at: string | null;
|
|
682
|
+
cancel_at: string | null;
|
|
625
683
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
626
|
-
cancellation_amount:
|
|
627
|
-
estimated_arr:
|
|
628
|
-
current_period_started_at:
|
|
629
|
-
current_period_ends_at:
|
|
630
|
-
next_payment_at:
|
|
631
|
-
next_payment_amount:
|
|
632
|
-
renews_at:
|
|
684
|
+
cancellation_amount: number | null;
|
|
685
|
+
estimated_arr: number | null;
|
|
686
|
+
current_period_started_at: string | null;
|
|
687
|
+
current_period_ends_at: string | null;
|
|
688
|
+
next_payment_at: string | null;
|
|
689
|
+
next_payment_amount: number | null;
|
|
690
|
+
renews_at: string | null;
|
|
633
691
|
current_phase_id: string | null;
|
|
634
692
|
properties: {
|
|
635
693
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
636
694
|
} | null;
|
|
637
695
|
custom_properties: {
|
|
638
|
-
[key: string]: string | number | boolean |
|
|
696
|
+
[key: string]: string | number | boolean | null;
|
|
639
697
|
} | null;
|
|
640
|
-
created_at:
|
|
641
|
-
updated_at:
|
|
698
|
+
created_at: string;
|
|
699
|
+
updated_at: string;
|
|
642
700
|
} & {
|
|
643
701
|
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"])[];
|
|
644
702
|
coupons: (({
|
|
645
703
|
description: string | null;
|
|
646
|
-
expiration_date:
|
|
704
|
+
expiration_date: string | null;
|
|
647
705
|
redemption_limit: number | null;
|
|
648
|
-
created_at:
|
|
706
|
+
created_at: string;
|
|
649
707
|
type: "amount";
|
|
650
|
-
discount_amount:
|
|
651
|
-
currency:
|
|
708
|
+
discount_amount: number;
|
|
709
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
652
710
|
} | {
|
|
653
711
|
description: string | null;
|
|
654
|
-
expiration_date:
|
|
712
|
+
expiration_date: string | null;
|
|
655
713
|
redemption_limit: number | null;
|
|
656
|
-
created_at:
|
|
714
|
+
created_at: string;
|
|
657
715
|
type: "percent";
|
|
658
716
|
discount_percent: number;
|
|
659
717
|
}) & {
|
|
660
718
|
id: string | null;
|
|
719
|
+
promotion_code_id: string | null;
|
|
661
720
|
name: string | null;
|
|
662
721
|
subscription_coupon_id: string;
|
|
663
722
|
repeat: "once" | "forever" | "custom";
|
|
664
723
|
product_ids: string[];
|
|
665
|
-
apply_at:
|
|
666
|
-
expires_at:
|
|
724
|
+
apply_at: string | null;
|
|
725
|
+
expires_at: string | null;
|
|
667
726
|
})[];
|
|
668
727
|
phases: {
|
|
669
728
|
id: string;
|
|
@@ -677,39 +736,40 @@ export declare class HyperlineAPI {
|
|
|
677
736
|
count: number;
|
|
678
737
|
} | null;
|
|
679
738
|
billing_date_setting: "phase_start" | "specific_date";
|
|
680
|
-
initial_billing_at:
|
|
681
|
-
starts_at:
|
|
682
|
-
ends_at:
|
|
739
|
+
initial_billing_at: string | null;
|
|
740
|
+
starts_at: string | null;
|
|
741
|
+
ends_at: string | null;
|
|
683
742
|
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
684
743
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
685
744
|
transition_invoicing_schedule: "immediately";
|
|
686
745
|
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"])[];
|
|
687
746
|
coupons: (({
|
|
688
747
|
description: string | null;
|
|
689
|
-
expiration_date:
|
|
748
|
+
expiration_date: string | null;
|
|
690
749
|
redemption_limit: number | null;
|
|
691
|
-
created_at:
|
|
750
|
+
created_at: string;
|
|
692
751
|
type: "amount";
|
|
693
|
-
discount_amount:
|
|
694
|
-
currency:
|
|
752
|
+
discount_amount: number;
|
|
753
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
695
754
|
} | {
|
|
696
755
|
description: string | null;
|
|
697
|
-
expiration_date:
|
|
756
|
+
expiration_date: string | null;
|
|
698
757
|
redemption_limit: number | null;
|
|
699
|
-
created_at:
|
|
758
|
+
created_at: string;
|
|
700
759
|
type: "percent";
|
|
701
760
|
discount_percent: number;
|
|
702
761
|
}) & {
|
|
703
762
|
id: string | null;
|
|
763
|
+
promotion_code_id: string | null;
|
|
704
764
|
name: string | null;
|
|
705
765
|
subscription_coupon_id: string;
|
|
706
766
|
repeat: "once" | "forever" | "custom";
|
|
707
767
|
product_ids: string[];
|
|
708
|
-
apply_at:
|
|
709
|
-
expires_at:
|
|
768
|
+
apply_at: string | null;
|
|
769
|
+
expires_at: string | null;
|
|
710
770
|
})[];
|
|
711
|
-
created_at:
|
|
712
|
-
updated_at:
|
|
771
|
+
created_at: string;
|
|
772
|
+
updated_at: string;
|
|
713
773
|
}[];
|
|
714
774
|
quote: {
|
|
715
775
|
id: string;
|
|
@@ -723,10 +783,31 @@ export declare class HyperlineAPI {
|
|
|
723
783
|
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
724
784
|
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
725
785
|
generate_draft_invoices: boolean;
|
|
786
|
+
contract_terms: {
|
|
787
|
+
status: "active" | "pending" | "finished";
|
|
788
|
+
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
789
|
+
end_strategy: "end_date" | "duration" | "manual";
|
|
790
|
+
starts_at: string | null;
|
|
791
|
+
ends_at: string | null;
|
|
792
|
+
duration: {
|
|
793
|
+
period: "days" | "weeks" | "months" | "years";
|
|
794
|
+
count: number;
|
|
795
|
+
} | null;
|
|
796
|
+
renew_automatically: boolean | ("true" | "false");
|
|
797
|
+
renew_for_duration: {
|
|
798
|
+
period: "days" | "weeks" | "months" | "years";
|
|
799
|
+
count: number;
|
|
800
|
+
} | null;
|
|
801
|
+
current_period_started_at: string | null;
|
|
802
|
+
current_period_ends_at: string | null;
|
|
803
|
+
} | null;
|
|
726
804
|
}) | null>;
|
|
727
|
-
|
|
805
|
+
createSubscriptionUpdate(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
806
|
+
id: string;
|
|
807
|
+
} | null>;
|
|
808
|
+
cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
728
809
|
id: string;
|
|
729
|
-
currency:
|
|
810
|
+
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";
|
|
730
811
|
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
731
812
|
purchase_order: string | null;
|
|
732
813
|
customer_id: string;
|
|
@@ -745,55 +826,56 @@ export declare class HyperlineAPI {
|
|
|
745
826
|
count: number;
|
|
746
827
|
} | null;
|
|
747
828
|
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
748
|
-
starts_at:
|
|
749
|
-
contract_start:
|
|
750
|
-
contract_end:
|
|
751
|
-
initial_billing_at:
|
|
752
|
-
paused_at:
|
|
753
|
-
reactivate_at:
|
|
754
|
-
cancel_at:
|
|
829
|
+
starts_at: string;
|
|
830
|
+
contract_start: string;
|
|
831
|
+
contract_end: string | null;
|
|
832
|
+
initial_billing_at: string | null;
|
|
833
|
+
paused_at: string | null;
|
|
834
|
+
reactivate_at: string | null;
|
|
835
|
+
cancel_at: string | null;
|
|
755
836
|
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
756
|
-
cancellation_amount:
|
|
757
|
-
estimated_arr:
|
|
758
|
-
current_period_started_at:
|
|
759
|
-
current_period_ends_at:
|
|
760
|
-
next_payment_at:
|
|
761
|
-
next_payment_amount:
|
|
762
|
-
renews_at:
|
|
837
|
+
cancellation_amount: number | null;
|
|
838
|
+
estimated_arr: number | null;
|
|
839
|
+
current_period_started_at: string | null;
|
|
840
|
+
current_period_ends_at: string | null;
|
|
841
|
+
next_payment_at: string | null;
|
|
842
|
+
next_payment_amount: number | null;
|
|
843
|
+
renews_at: string | null;
|
|
763
844
|
current_phase_id: string | null;
|
|
764
845
|
properties: {
|
|
765
846
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
766
847
|
} | null;
|
|
767
848
|
custom_properties: {
|
|
768
|
-
[key: string]: string | number | boolean |
|
|
849
|
+
[key: string]: string | number | boolean | null;
|
|
769
850
|
} | null;
|
|
770
|
-
created_at:
|
|
771
|
-
updated_at:
|
|
851
|
+
created_at: string;
|
|
852
|
+
updated_at: string;
|
|
772
853
|
} & {
|
|
773
854
|
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"])[];
|
|
774
855
|
coupons: (({
|
|
775
856
|
description: string | null;
|
|
776
|
-
expiration_date:
|
|
857
|
+
expiration_date: string | null;
|
|
777
858
|
redemption_limit: number | null;
|
|
778
|
-
created_at:
|
|
859
|
+
created_at: string;
|
|
779
860
|
type: "amount";
|
|
780
|
-
discount_amount:
|
|
781
|
-
currency:
|
|
861
|
+
discount_amount: number;
|
|
862
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
782
863
|
} | {
|
|
783
864
|
description: string | null;
|
|
784
|
-
expiration_date:
|
|
865
|
+
expiration_date: string | null;
|
|
785
866
|
redemption_limit: number | null;
|
|
786
|
-
created_at:
|
|
867
|
+
created_at: string;
|
|
787
868
|
type: "percent";
|
|
788
869
|
discount_percent: number;
|
|
789
870
|
}) & {
|
|
790
871
|
id: string | null;
|
|
872
|
+
promotion_code_id: string | null;
|
|
791
873
|
name: string | null;
|
|
792
874
|
subscription_coupon_id: string;
|
|
793
875
|
repeat: "once" | "forever" | "custom";
|
|
794
876
|
product_ids: string[];
|
|
795
|
-
apply_at:
|
|
796
|
-
expires_at:
|
|
877
|
+
apply_at: string | null;
|
|
878
|
+
expires_at: string | null;
|
|
797
879
|
})[];
|
|
798
880
|
phases: {
|
|
799
881
|
id: string;
|
|
@@ -807,39 +889,40 @@ export declare class HyperlineAPI {
|
|
|
807
889
|
count: number;
|
|
808
890
|
} | null;
|
|
809
891
|
billing_date_setting: "phase_start" | "specific_date";
|
|
810
|
-
initial_billing_at:
|
|
811
|
-
starts_at:
|
|
812
|
-
ends_at:
|
|
892
|
+
initial_billing_at: string | null;
|
|
893
|
+
starts_at: string | null;
|
|
894
|
+
ends_at: string | null;
|
|
813
895
|
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
814
896
|
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
815
897
|
transition_invoicing_schedule: "immediately";
|
|
816
898
|
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"])[];
|
|
817
899
|
coupons: (({
|
|
818
900
|
description: string | null;
|
|
819
|
-
expiration_date:
|
|
901
|
+
expiration_date: string | null;
|
|
820
902
|
redemption_limit: number | null;
|
|
821
|
-
created_at:
|
|
903
|
+
created_at: string;
|
|
822
904
|
type: "amount";
|
|
823
|
-
discount_amount:
|
|
824
|
-
currency:
|
|
905
|
+
discount_amount: number;
|
|
906
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
825
907
|
} | {
|
|
826
908
|
description: string | null;
|
|
827
|
-
expiration_date:
|
|
909
|
+
expiration_date: string | null;
|
|
828
910
|
redemption_limit: number | null;
|
|
829
|
-
created_at:
|
|
911
|
+
created_at: string;
|
|
830
912
|
type: "percent";
|
|
831
913
|
discount_percent: number;
|
|
832
914
|
}) & {
|
|
833
915
|
id: string | null;
|
|
916
|
+
promotion_code_id: string | null;
|
|
834
917
|
name: string | null;
|
|
835
918
|
subscription_coupon_id: string;
|
|
836
919
|
repeat: "once" | "forever" | "custom";
|
|
837
920
|
product_ids: string[];
|
|
838
|
-
apply_at:
|
|
839
|
-
expires_at:
|
|
921
|
+
apply_at: string | null;
|
|
922
|
+
expires_at: string | null;
|
|
840
923
|
})[];
|
|
841
|
-
created_at:
|
|
842
|
-
updated_at:
|
|
924
|
+
created_at: string;
|
|
925
|
+
updated_at: string;
|
|
843
926
|
}[];
|
|
844
927
|
quote: {
|
|
845
928
|
id: string;
|
|
@@ -853,98 +936,199 @@ export declare class HyperlineAPI {
|
|
|
853
936
|
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
854
937
|
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
855
938
|
generate_draft_invoices: boolean;
|
|
939
|
+
contract_terms: {
|
|
940
|
+
status: "active" | "pending" | "finished";
|
|
941
|
+
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
942
|
+
end_strategy: "end_date" | "duration" | "manual";
|
|
943
|
+
starts_at: string | null;
|
|
944
|
+
ends_at: string | null;
|
|
945
|
+
duration: {
|
|
946
|
+
period: "days" | "weeks" | "months" | "years";
|
|
947
|
+
count: number;
|
|
948
|
+
} | null;
|
|
949
|
+
renew_automatically: boolean | ("true" | "false");
|
|
950
|
+
renew_for_duration: {
|
|
951
|
+
period: "days" | "weeks" | "months" | "years";
|
|
952
|
+
count: number;
|
|
953
|
+
} | null;
|
|
954
|
+
current_period_started_at: string | null;
|
|
955
|
+
current_period_ends_at: string | null;
|
|
956
|
+
} | null;
|
|
856
957
|
}) | null>;
|
|
857
|
-
|
|
958
|
+
reinstateSubscription(id: string): Promise<({
|
|
858
959
|
id: string;
|
|
859
|
-
|
|
860
|
-
|
|
960
|
+
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";
|
|
961
|
+
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
962
|
+
purchase_order: string | null;
|
|
963
|
+
customer_id: string;
|
|
964
|
+
plan_id: string | null;
|
|
965
|
+
invoicing_entity_id: string;
|
|
966
|
+
checkout_session_id: string | null;
|
|
967
|
+
crm_opportunity_id: string | null;
|
|
968
|
+
minimum_invoice_fee: number | null;
|
|
861
969
|
commitment_interval: {
|
|
862
970
|
period: "days" | "weeks" | "months" | "years";
|
|
863
971
|
count: number;
|
|
864
972
|
} | null;
|
|
865
|
-
contract_start_strategy: "start_date" | "immediately" | "manual" | "manual_with_latest" | "quote_signature" | "checkout";
|
|
866
|
-
contract_start: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
867
|
-
contract_end_strategy: "duration" | "manual" | "end_date";
|
|
868
|
-
contract_end: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
|
|
869
|
-
contract_duration: {
|
|
870
|
-
period: "days" | "weeks" | "months" | "years" | "forever";
|
|
871
|
-
count: number | null;
|
|
872
|
-
} | null;
|
|
873
973
|
renew_automatically: boolean;
|
|
874
974
|
renew_for: {
|
|
875
975
|
period: "days" | "weeks" | "months" | "years";
|
|
876
|
-
count: number
|
|
976
|
+
count: number;
|
|
877
977
|
} | null;
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
978
|
+
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
979
|
+
starts_at: string;
|
|
980
|
+
contract_start: string;
|
|
981
|
+
contract_end: string | null;
|
|
982
|
+
initial_billing_at: string | null;
|
|
983
|
+
paused_at: string | null;
|
|
984
|
+
reactivate_at: string | null;
|
|
985
|
+
cancel_at: string | null;
|
|
986
|
+
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
987
|
+
cancellation_amount: number | null;
|
|
988
|
+
estimated_arr: number | null;
|
|
989
|
+
current_period_started_at: string | null;
|
|
990
|
+
current_period_ends_at: string | null;
|
|
991
|
+
next_payment_at: string | null;
|
|
992
|
+
next_payment_amount: number | null;
|
|
993
|
+
renews_at: string | null;
|
|
994
|
+
current_phase_id: string | null;
|
|
995
|
+
properties: {
|
|
996
|
+
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
997
|
+
} | null;
|
|
998
|
+
custom_properties: {
|
|
999
|
+
[key: string]: string | number | boolean | null;
|
|
1000
|
+
} | null;
|
|
1001
|
+
created_at: string;
|
|
1002
|
+
updated_at: string;
|
|
1003
|
+
} & {
|
|
1004
|
+
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"])[];
|
|
1005
|
+
coupons: (({
|
|
881
1006
|
description: string | null;
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
} | null;
|
|
889
|
-
payment_schedule: "start" | "end" | null;
|
|
890
|
-
type: "flat_fee";
|
|
891
|
-
prices: import("./_types.generated").components["schemas"]["PriceFee"][];
|
|
1007
|
+
expiration_date: string | null;
|
|
1008
|
+
redemption_limit: number | null;
|
|
1009
|
+
created_at: string;
|
|
1010
|
+
type: "amount";
|
|
1011
|
+
discount_amount: number;
|
|
1012
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
892
1013
|
} | {
|
|
893
|
-
id: string;
|
|
894
|
-
name: string;
|
|
895
1014
|
description: string | null;
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
1015
|
+
expiration_date: string | null;
|
|
1016
|
+
redemption_limit: number | null;
|
|
1017
|
+
created_at: string;
|
|
1018
|
+
type: "percent";
|
|
1019
|
+
discount_percent: number;
|
|
1020
|
+
}) & {
|
|
1021
|
+
id: string | null;
|
|
1022
|
+
promotion_code_id: string | null;
|
|
1023
|
+
name: string | null;
|
|
1024
|
+
subscription_coupon_id: string;
|
|
1025
|
+
repeat: "once" | "forever" | "custom";
|
|
1026
|
+
product_ids: string[];
|
|
1027
|
+
apply_at: string | null;
|
|
1028
|
+
expires_at: string | null;
|
|
1029
|
+
})[];
|
|
1030
|
+
phases: {
|
|
1031
|
+
id: string;
|
|
1032
|
+
type: "setup" | "trial" | "standard";
|
|
1033
|
+
status: "pending" | "active" | "finished";
|
|
1034
|
+
order: number;
|
|
1035
|
+
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
1036
|
+
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
1037
|
+
duration: {
|
|
900
1038
|
period: "days" | "weeks" | "months" | "years";
|
|
901
1039
|
count: number;
|
|
902
1040
|
} | null;
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
1041
|
+
billing_date_setting: "phase_start" | "specific_date";
|
|
1042
|
+
initial_billing_at: string | null;
|
|
1043
|
+
starts_at: string | null;
|
|
1044
|
+
ends_at: string | null;
|
|
1045
|
+
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
1046
|
+
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
1047
|
+
transition_invoicing_schedule: "immediately";
|
|
1048
|
+
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"])[];
|
|
1049
|
+
coupons: (({
|
|
1050
|
+
description: string | null;
|
|
1051
|
+
expiration_date: string | null;
|
|
1052
|
+
redemption_limit: number | null;
|
|
1053
|
+
created_at: string;
|
|
1054
|
+
type: "amount";
|
|
1055
|
+
discount_amount: number;
|
|
1056
|
+
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
1057
|
+
} | {
|
|
1058
|
+
description: string | null;
|
|
1059
|
+
expiration_date: string | null;
|
|
1060
|
+
redemption_limit: number | null;
|
|
1061
|
+
created_at: string;
|
|
1062
|
+
type: "percent";
|
|
1063
|
+
discount_percent: number;
|
|
1064
|
+
}) & {
|
|
1065
|
+
id: string | null;
|
|
1066
|
+
promotion_code_id: string | null;
|
|
1067
|
+
name: string | null;
|
|
1068
|
+
subscription_coupon_id: string;
|
|
1069
|
+
repeat: "once" | "forever" | "custom";
|
|
1070
|
+
product_ids: string[];
|
|
1071
|
+
apply_at: string | null;
|
|
1072
|
+
expires_at: string | null;
|
|
1073
|
+
})[];
|
|
1074
|
+
created_at: string;
|
|
1075
|
+
updated_at: string;
|
|
1076
|
+
}[];
|
|
1077
|
+
quote: {
|
|
1078
|
+
id: string;
|
|
1079
|
+
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
1080
|
+
} | null;
|
|
1081
|
+
plan: {
|
|
908
1082
|
id: string;
|
|
909
1083
|
name: string;
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
1084
|
+
} | null;
|
|
1085
|
+
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
1086
|
+
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
|
|
1087
|
+
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
1088
|
+
generate_draft_invoices: boolean;
|
|
1089
|
+
contract_terms: {
|
|
1090
|
+
status: "active" | "pending" | "finished";
|
|
1091
|
+
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
1092
|
+
end_strategy: "end_date" | "duration" | "manual";
|
|
1093
|
+
starts_at: string | null;
|
|
1094
|
+
ends_at: string | null;
|
|
1095
|
+
duration: {
|
|
915
1096
|
period: "days" | "weeks" | "months" | "years";
|
|
916
1097
|
count: number;
|
|
917
1098
|
} | null;
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
unit_name: string | null;
|
|
921
|
-
min_committed_count: number | null;
|
|
922
|
-
min_amount: number | null;
|
|
923
|
-
max_amount: number | null;
|
|
924
|
-
metering_interval_type: "subscription_commitment" | "payment_interval" | "full_database" | "phase_duration" | null;
|
|
925
|
-
bill_usage_difference: boolean;
|
|
926
|
-
prices: ((import("./_types.generated").components["schemas"]["PriceVolume"] | import("./_types.generated").components["schemas"]["PricePackaged"] | import("./_types.generated").components["schemas"]["PriceBulk"] | import("./_types.generated").components["schemas"]["PriceBps"]) & {
|
|
927
|
-
metering_filter: import("./_types.generated").components["schemas"]["MeteringFilter"];
|
|
928
|
-
})[];
|
|
929
|
-
} | {
|
|
930
|
-
id: string;
|
|
931
|
-
name: string;
|
|
932
|
-
description: string | null;
|
|
933
|
-
description_display_interval_dates: boolean;
|
|
934
|
-
payment_interval: {
|
|
935
|
-
period: "once";
|
|
936
|
-
} | {
|
|
1099
|
+
renew_automatically: boolean | ("true" | "false");
|
|
1100
|
+
renew_for_duration: {
|
|
937
1101
|
period: "days" | "weeks" | "months" | "years";
|
|
938
1102
|
count: number;
|
|
939
1103
|
} | null;
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
1104
|
+
current_period_started_at: string | null;
|
|
1105
|
+
current_period_ends_at: string | null;
|
|
1106
|
+
} | null;
|
|
1107
|
+
}) | null>;
|
|
1108
|
+
getPlan(id: string): Promise<{
|
|
1109
|
+
id: string;
|
|
1110
|
+
name: string;
|
|
1111
|
+
description: string | null;
|
|
1112
|
+
commitment_interval: {
|
|
1113
|
+
period: "days" | "weeks" | "months" | "years";
|
|
943
1114
|
count: number;
|
|
944
|
-
|
|
945
|
-
|
|
1115
|
+
} | null;
|
|
1116
|
+
contract_start_strategy: "start_date" | "immediately" | "manual" | "manual_with_latest" | "quote_signature" | "checkout";
|
|
1117
|
+
contract_start: string | null;
|
|
1118
|
+
contract_end_strategy: "duration" | "manual" | "end_date";
|
|
1119
|
+
contract_end: string | null;
|
|
1120
|
+
contract_duration: {
|
|
1121
|
+
period: "days" | "weeks" | "months" | "years" | "forever";
|
|
1122
|
+
count: number | null;
|
|
1123
|
+
} | null;
|
|
1124
|
+
renew_automatically: boolean;
|
|
1125
|
+
renew_for: {
|
|
1126
|
+
period: "days" | "weeks" | "months" | "years";
|
|
1127
|
+
count: number | null;
|
|
1128
|
+
} | null;
|
|
1129
|
+
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"])[];
|
|
946
1130
|
custom_properties: {
|
|
947
|
-
[key: string]: string | number | boolean |
|
|
1131
|
+
[key: string]: string | number | boolean | null;
|
|
948
1132
|
} | null;
|
|
949
1133
|
} | null>;
|
|
950
1134
|
getPlans(skip?: number, take?: number): Promise<{
|
|
@@ -965,21 +1149,24 @@ export declare class HyperlineAPI {
|
|
|
965
1149
|
purchase_order: string | null;
|
|
966
1150
|
original_invoice_id: string | null;
|
|
967
1151
|
original_invoice_number: string | null;
|
|
968
|
-
currency:
|
|
969
|
-
total_amount:
|
|
970
|
-
amount_due:
|
|
971
|
-
amount_paid:
|
|
972
|
-
amount_fixed:
|
|
973
|
-
amount_excluding_tax:
|
|
1152
|
+
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";
|
|
1153
|
+
total_amount: number;
|
|
1154
|
+
amount_due: number;
|
|
1155
|
+
amount_paid: number;
|
|
1156
|
+
amount_fixed: number;
|
|
1157
|
+
amount_excluding_tax: number;
|
|
974
1158
|
tax_rate: number;
|
|
975
|
-
tax_amount:
|
|
1159
|
+
tax_amount: number;
|
|
976
1160
|
tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
|
|
977
|
-
discount_amount:
|
|
1161
|
+
discount_amount: number;
|
|
978
1162
|
conversion_rate: number | null;
|
|
979
|
-
converted_amount:
|
|
980
|
-
converted_at:
|
|
1163
|
+
converted_amount: number | null;
|
|
1164
|
+
converted_at: string | null;
|
|
981
1165
|
payment_method_id: string | null;
|
|
1166
|
+
bank_account_id: string | null;
|
|
982
1167
|
custom_note: string | null;
|
|
1168
|
+
additional_info: string | null;
|
|
1169
|
+
footer: string | null;
|
|
983
1170
|
customer: {
|
|
984
1171
|
id: string;
|
|
985
1172
|
name: string;
|
|
@@ -995,34 +1182,34 @@ export declare class HyperlineAPI {
|
|
|
995
1182
|
address: import("./_types.generated").components["schemas"]["Address"] & unknown;
|
|
996
1183
|
};
|
|
997
1184
|
subscription_id: string | null;
|
|
998
|
-
period_starts_at:
|
|
999
|
-
period_ends_at:
|
|
1000
|
-
emitted_at:
|
|
1001
|
-
due_at:
|
|
1002
|
-
refunded_at:
|
|
1003
|
-
grace_period_ended_at:
|
|
1004
|
-
settled_at:
|
|
1005
|
-
updated_at:
|
|
1185
|
+
period_starts_at: string | null;
|
|
1186
|
+
period_ends_at: string | null;
|
|
1187
|
+
emitted_at: string;
|
|
1188
|
+
due_at: string;
|
|
1189
|
+
refunded_at: string | null;
|
|
1190
|
+
grace_period_ended_at: string | null;
|
|
1191
|
+
settled_at: string | null;
|
|
1192
|
+
updated_at: string | null;
|
|
1006
1193
|
line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
|
|
1007
1194
|
} & {
|
|
1008
1195
|
transactions: ({
|
|
1009
1196
|
id: string;
|
|
1010
1197
|
type: "subscription" | "one_time" | "refund";
|
|
1011
|
-
amount:
|
|
1012
|
-
currency:
|
|
1198
|
+
amount: number;
|
|
1199
|
+
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";
|
|
1013
1200
|
customer_id: string;
|
|
1014
1201
|
provider_id: string | null;
|
|
1015
|
-
process_at:
|
|
1016
|
-
refunded_at:
|
|
1017
|
-
last_refreshed_at:
|
|
1202
|
+
process_at: string;
|
|
1203
|
+
refunded_at: string | null;
|
|
1204
|
+
last_refreshed_at: string | null;
|
|
1018
1205
|
provider_fee: {
|
|
1019
|
-
amount:
|
|
1020
|
-
currency:
|
|
1206
|
+
amount: number;
|
|
1207
|
+
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";
|
|
1021
1208
|
exchange_rate: number | null;
|
|
1022
1209
|
} | null;
|
|
1023
1210
|
chargeback: {
|
|
1024
|
-
amount:
|
|
1025
|
-
last_chargeback_at:
|
|
1211
|
+
amount: number;
|
|
1212
|
+
last_chargeback_at: string;
|
|
1026
1213
|
} | null;
|
|
1027
1214
|
} & ({
|
|
1028
1215
|
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
@@ -1045,10 +1232,15 @@ export declare class HyperlineAPI {
|
|
|
1045
1232
|
coupons: {
|
|
1046
1233
|
id: string | null;
|
|
1047
1234
|
name: string | null;
|
|
1048
|
-
discount_amount:
|
|
1235
|
+
discount_amount: number | null;
|
|
1049
1236
|
discount_percent: number | null;
|
|
1050
1237
|
line_item_ids: string[];
|
|
1051
1238
|
}[];
|
|
1239
|
+
integrations: {
|
|
1240
|
+
entity_id: string;
|
|
1241
|
+
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1242
|
+
provider_account_id: string;
|
|
1243
|
+
}[];
|
|
1052
1244
|
}) | null>;
|
|
1053
1245
|
getInvoices(skip?: number, take?: number, query?: operations['getInvoices']['parameters']['query']): Promise<{
|
|
1054
1246
|
meta: {
|
|
@@ -1058,7 +1250,7 @@ export declare class HyperlineAPI {
|
|
|
1058
1250
|
};
|
|
1059
1251
|
data: import("./_types.generated").components["schemas"]["Invoice"][];
|
|
1060
1252
|
} | null>;
|
|
1061
|
-
getInvoicesByCustomerId(id: string): Promise<{
|
|
1253
|
+
getInvoicesByCustomerId(id: string, filters?: Partial<operations['getInvoices']['parameters']['query']>): Promise<{
|
|
1062
1254
|
meta: {
|
|
1063
1255
|
total: number;
|
|
1064
1256
|
taken: number;
|
|
@@ -1067,7 +1259,66 @@ export declare class HyperlineAPI {
|
|
|
1067
1259
|
data: import("./_types.generated").components["schemas"]["Invoice"][];
|
|
1068
1260
|
} | null>;
|
|
1069
1261
|
getInvoiceDownload(id: string): Promise<string | null>;
|
|
1070
|
-
getAllInvoices(items?: paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']): Promise<paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']>;
|
|
1262
|
+
getAllInvoices(items?: paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getInvoices']['parameters']['query']): Promise<paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']>;
|
|
1263
|
+
getPaymentMethod(customerId: string, paymentMethodId: string): Promise<({
|
|
1264
|
+
id: string;
|
|
1265
|
+
} & {
|
|
1266
|
+
status: "active" | "pending";
|
|
1267
|
+
} & {
|
|
1268
|
+
type: "card";
|
|
1269
|
+
last_4_digits: number | null;
|
|
1270
|
+
expiration_date: string | null;
|
|
1271
|
+
brand: string | null;
|
|
1272
|
+
} & {
|
|
1273
|
+
integration: {
|
|
1274
|
+
entity_id: string;
|
|
1275
|
+
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1276
|
+
provider_account_id: string;
|
|
1277
|
+
} | null;
|
|
1278
|
+
}) | ({
|
|
1279
|
+
id: string;
|
|
1280
|
+
} & {
|
|
1281
|
+
status: "errored";
|
|
1282
|
+
error_type: "authentication_required" | "authorization_error" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
|
|
1283
|
+
} & {
|
|
1284
|
+
type: "card";
|
|
1285
|
+
last_4_digits: number | null;
|
|
1286
|
+
expiration_date: string | null;
|
|
1287
|
+
brand: string | null;
|
|
1288
|
+
} & {
|
|
1289
|
+
integration: {
|
|
1290
|
+
entity_id: string;
|
|
1291
|
+
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1292
|
+
provider_account_id: string;
|
|
1293
|
+
} | null;
|
|
1294
|
+
}) | ({
|
|
1295
|
+
id: string;
|
|
1296
|
+
} & {
|
|
1297
|
+
status: "active" | "pending";
|
|
1298
|
+
} & {
|
|
1299
|
+
type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1300
|
+
account_number_ending: string | null;
|
|
1301
|
+
} & {
|
|
1302
|
+
integration: {
|
|
1303
|
+
entity_id: string;
|
|
1304
|
+
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1305
|
+
provider_account_id: string;
|
|
1306
|
+
} | null;
|
|
1307
|
+
}) | ({
|
|
1308
|
+
id: string;
|
|
1309
|
+
} & {
|
|
1310
|
+
status: "errored";
|
|
1311
|
+
error_type: "authentication_required" | "authorization_error" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
|
|
1312
|
+
} & {
|
|
1313
|
+
type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1314
|
+
account_number_ending: string | null;
|
|
1315
|
+
} & {
|
|
1316
|
+
integration: {
|
|
1317
|
+
entity_id: string;
|
|
1318
|
+
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1319
|
+
provider_account_id: string;
|
|
1320
|
+
} | null;
|
|
1321
|
+
}) | null>;
|
|
1071
1322
|
createBillableEvent(data: CreateBillableEvent[]): Promise<BillableEvents | null>;
|
|
1072
1323
|
getComponentToken(data: {
|
|
1073
1324
|
customer_id: string;
|