@vrplatform/hyperline-client 1.0.31 → 1.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/build/main/client.d.ts +977 -88
  2. package/build/main/client.js +49 -2
  3. package/build/main/client.js.map +1 -1
  4. package/build/main/const.d.ts +18 -20
  5. package/build/main/const.js +30 -22
  6. package/build/main/const.js.map +1 -1
  7. package/build/main/hyperlineError.d.ts +5 -0
  8. package/build/main/hyperlineError.js +14 -0
  9. package/build/main/hyperlineError.js.map +1 -0
  10. package/build/main/index.d.ts +1 -0
  11. package/build/main/index.js +1 -0
  12. package/build/main/index.js.map +1 -1
  13. package/build/main/types.d.ts +2 -10
  14. package/build/main/types.js.map +1 -1
  15. package/build/main/utils/calculateMrr.d.ts +2 -2
  16. package/build/main/utils/calculateMrr.js +6 -15
  17. package/build/main/utils/calculateMrr.js.map +1 -1
  18. package/build/main/utils/index.d.ts +0 -1
  19. package/build/main/utils/index.js +0 -1
  20. package/build/main/utils/index.js.map +1 -1
  21. package/build/module/client.d.ts +977 -88
  22. package/build/module/client.js +49 -2
  23. package/build/module/client.js.map +1 -1
  24. package/build/module/const.d.ts +18 -20
  25. package/build/module/const.js +30 -22
  26. package/build/module/const.js.map +1 -1
  27. package/build/module/hyperlineError.d.ts +5 -0
  28. package/build/module/hyperlineError.js +16 -0
  29. package/build/module/hyperlineError.js.map +1 -0
  30. package/build/module/index.d.ts +1 -0
  31. package/build/module/index.js +1 -0
  32. package/build/module/index.js.map +1 -1
  33. package/build/module/types.d.ts +2 -10
  34. package/build/module/types.js.map +1 -1
  35. package/build/module/utils/calculateMrr.d.ts +2 -2
  36. package/build/module/utils/calculateMrr.js +6 -15
  37. package/build/module/utils/calculateMrr.js.map +1 -1
  38. package/build/module/utils/index.d.ts +0 -1
  39. package/build/module/utils/index.js +0 -1
  40. package/build/module/utils/index.js.map +1 -1
  41. package/package.json +1 -1
  42. package/src/client.ts +107 -6
  43. package/src/const.ts +40 -28
  44. package/src/hyperlineError.ts +17 -0
  45. package/src/index.ts +1 -0
  46. package/src/types.ts +2 -11
  47. package/src/utils/calculateMrr.ts +11 -30
  48. package/src/utils/index.ts +0 -1
  49. package/build/main/utils/isTestingTeam.d.ts +0 -5
  50. package/build/main/utils/isTestingTeam.js +0 -4
  51. package/build/main/utils/isTestingTeam.js.map +0 -1
  52. package/build/module/utils/isTestingTeam.d.ts +0 -5
  53. package/build/module/utils/isTestingTeam.js +0 -4
  54. package/build/module/utils/isTestingTeam.js.map +0 -1
  55. package/src/utils/isTestingTeam.ts +0 -11
package/build/main/client.d.ts CHANGED
@@ -101,6 +101,24 @@ export declare class HyperlineAPI {
101
101
  updated_at: string;
102
102
  deleted_at: string | null;
103
103
  } | null>;
104
+ getOrganisation(id: string): Promise<{
105
+ id: string;
106
+ name: string;
107
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
108
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ES-CE" | "ES-ML" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
109
+ invoice_schedule: "month" | "quarter" | "year" | null;
110
+ next_invoice_at: string | null;
111
+ child_customer_ids: string[];
112
+ } | null>;
113
+ updateOrganisation(id: string, data: NonNullable<paths['/v1/organisations/{id}']['patch']['requestBody']>['content']['application/json']): Promise<{
114
+ id: string;
115
+ name: string;
116
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
117
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ES-CE" | "ES-ML" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
118
+ invoice_schedule: "month" | "quarter" | "year" | null;
119
+ next_invoice_at: string | null;
120
+ child_customer_ids: string[];
121
+ } | null>;
104
122
  getCustomer(id?: string): Promise<({
105
123
  id: string;
106
124
  name: string;
@@ -623,6 +641,280 @@ export declare class HyperlineAPI {
623
641
  getCustomerPortal(id: string): Promise<{
624
642
  url: string;
625
643
  } | null>;
644
+ getSubscriptionTemplate(id: string): Promise<{
645
+ id: string;
646
+ name: string;
647
+ description: string | null;
648
+ configurations: ({
649
+ id: string;
650
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
651
+ country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BF" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ES-CE" | "ES-ML" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
652
+ } & {
653
+ name: string | null;
654
+ minimum_invoice_fee: number | null;
655
+ cancel_at: string | null;
656
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
657
+ custom_properties: {
658
+ [key: string]: string | number | boolean | string[] | null;
659
+ } | null;
660
+ generate_document: boolean;
661
+ document_name: string | null;
662
+ add_tax_to_document: boolean;
663
+ generate_draft_invoices: boolean;
664
+ contract_terms: {
665
+ status: "active" | "pending" | "finished";
666
+ activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
667
+ end_strategy: "end_date" | "duration" | "manual";
668
+ starts_at: string | null;
669
+ ends_at: string | null;
670
+ duration: {
671
+ period: "days" | "weeks" | "months" | "years";
672
+ count: number;
673
+ } | null;
674
+ renew_automatically: boolean | ("true" | "false");
675
+ renew_for_duration: {
676
+ period: "days" | "weeks" | "months" | "years";
677
+ count: number;
678
+ } | null;
679
+ } | null;
680
+ phases: {
681
+ id: string;
682
+ type: "setup" | "trial" | "standard";
683
+ status: "pending" | "active" | "finished";
684
+ order: number;
685
+ activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
686
+ end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
687
+ duration: {
688
+ period: "days" | "weeks" | "months" | "years";
689
+ count: number;
690
+ } | null;
691
+ billing_date_setting: "phase_start" | "specific_date";
692
+ starts_at: string | null;
693
+ ends_at: string | null;
694
+ billing_cycle_alignment: "calendar_period" | "anniversary";
695
+ do_not_invoice_phase: boolean;
696
+ transition_calculation_method: "prorata" | "pay_in_full" | "none";
697
+ transition_invoicing_schedule: "immediately";
698
+ coupons: (({
699
+ description: string | null;
700
+ expiration_date: string | null;
701
+ redemption_limit: number | null;
702
+ repeat: "once" | "forever" | "custom" | "duration" | null;
703
+ duration: {
704
+ count: number;
705
+ period: "days" | "weeks" | "months" | "years";
706
+ } | null;
707
+ created_at: string;
708
+ type: "amount";
709
+ discount_amount: number;
710
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
711
+ } | {
712
+ description: string | null;
713
+ expiration_date: string | null;
714
+ redemption_limit: number | null;
715
+ repeat: "once" | "forever" | "custom" | "duration" | null;
716
+ duration: {
717
+ count: number;
718
+ period: "days" | "weeks" | "months" | "years";
719
+ } | null;
720
+ created_at: string;
721
+ type: "percent";
722
+ discount_percent: number;
723
+ }) & {
724
+ id: string | null;
725
+ promotion_code_id: string | null;
726
+ name: string | null;
727
+ subscription_coupon_id: string;
728
+ repeat: "once" | "forever" | "custom" | "duration";
729
+ duration_period: "days" | "weeks" | "months" | "years" | null;
730
+ duration_count: number | null;
731
+ product_ids: string[] | null;
732
+ apply_at: string | null;
733
+ expires_at: string | null;
734
+ })[];
735
+ products: ({
736
+ id: string;
737
+ type: "flat_fee";
738
+ count: number;
739
+ name: string;
740
+ description: string | null;
741
+ description_display_interval_dates: boolean;
742
+ payment_interval: {
743
+ period: "once";
744
+ } | {
745
+ period: "days" | "weeks" | "months" | "years";
746
+ count: number;
747
+ } | null;
748
+ payment_schedule: "start" | "end" | null;
749
+ prices: (import("./_types.generated").components["schemas"]["PriceFee"] & {
750
+ price_configuration_id: string | null;
751
+ })[];
752
+ } | {
753
+ id: string;
754
+ type: "seat";
755
+ count: number;
756
+ name: string;
757
+ description: string | null;
758
+ description_display_interval_dates: boolean;
759
+ unit_name: string | null;
760
+ payment_interval: {
761
+ period: "once";
762
+ } | {
763
+ period: "days" | "weeks" | "months" | "years";
764
+ count: number;
765
+ } | null;
766
+ payment_schedule: "start" | "end" | null;
767
+ prices: ((import("./_types.generated").components["schemas"]["PriceVolume"] & {
768
+ price_configuration_id: string | null;
769
+ }) | (import("./_types.generated").components["schemas"]["PricePackaged"] & {
770
+ price_configuration_id: string | null;
771
+ }) | (import("./_types.generated").components["schemas"]["PriceBulk"] & {
772
+ price_configuration_id: string | null;
773
+ }) | (import("./_types.generated").components["schemas"]["PriceBundle"] & {
774
+ price_configuration_id: string | null;
775
+ }))[];
776
+ } | {
777
+ id: string;
778
+ type: "dynamic";
779
+ name: string;
780
+ description: string | null;
781
+ description_display_interval_dates: boolean;
782
+ unit_name: string | null;
783
+ payment_interval: {
784
+ period: "once";
785
+ } | {
786
+ period: "days" | "weeks" | "months" | "years";
787
+ count: number;
788
+ } | null;
789
+ payment_schedule: "start" | "end" | null;
790
+ min_committed_count: number | null;
791
+ min_amount: number | null;
792
+ max_amount: number | null;
793
+ metering_interval_type: "subscription_commitment" | "payment_interval" | "full_database" | "phase_duration" | "custom" | null;
794
+ bill_usage_difference: boolean;
795
+ children_usage_aggregation: "sum" | "max" | null;
796
+ prices: ((import("./_types.generated").components["schemas"]["PriceVolume"] & {
797
+ price_configuration_id: string | null;
798
+ } & {
799
+ metering_filter?: {
800
+ name: string;
801
+ configuration: import("./_types.generated").components["schemas"]["MeteringFilterConfiguration"];
802
+ } | null;
803
+ }) | (import("./_types.generated").components["schemas"]["PricePackaged"] & {
804
+ price_configuration_id: string | null;
805
+ } & {
806
+ metering_filter?: {
807
+ name: string;
808
+ configuration: import("./_types.generated").components["schemas"]["MeteringFilterConfiguration"];
809
+ } | null;
810
+ }) | (import("./_types.generated").components["schemas"]["PriceBulk"] & {
811
+ price_configuration_id: string | null;
812
+ } & {
813
+ metering_filter?: {
814
+ name: string;
815
+ configuration: import("./_types.generated").components["schemas"]["MeteringFilterConfiguration"];
816
+ } | null;
817
+ }) | (import("./_types.generated").components["schemas"]["PriceBps"] & {
818
+ price_configuration_id: string | null;
819
+ } & {
820
+ metering_filter?: {
821
+ name: string;
822
+ configuration: import("./_types.generated").components["schemas"]["MeteringFilterConfiguration"];
823
+ } | null;
824
+ }))[];
825
+ } | {
826
+ id: string;
827
+ type: "credit";
828
+ count: number;
829
+ name: string;
830
+ description: string | null;
831
+ description_display_interval_dates: boolean;
832
+ unit_name: string | null;
833
+ payment_interval: {
834
+ period: "once";
835
+ } | {
836
+ period: "days" | "weeks" | "months" | "years";
837
+ count: number;
838
+ } | null;
839
+ payment_schedule: "start" | "end" | null;
840
+ credits_expiration_in_days: number | null;
841
+ expire_credits_at_end_of_period: boolean | ("true" | "false") | null;
842
+ prices: (import("./_types.generated").components["schemas"]["PriceFee"] & {
843
+ price_configuration_id: string | null;
844
+ })[];
845
+ } | {
846
+ id: string;
847
+ type: "bundle";
848
+ count: number;
849
+ name: string;
850
+ description: string | null;
851
+ description_display_interval_dates: boolean;
852
+ display_mode: "single_line" | "ventilated";
853
+ payment_interval: {
854
+ period: "once";
855
+ } | {
856
+ period: "days" | "weeks" | "months" | "years";
857
+ count: number;
858
+ } | null;
859
+ payment_schedule: "start" | "end" | null;
860
+ prices: ((import("./_types.generated").components["schemas"]["PriceVolume"] & {
861
+ price_configuration_id: string | null;
862
+ }) | (import("./_types.generated").components["schemas"]["PricePackaged"] & {
863
+ price_configuration_id: string | null;
864
+ }) | (import("./_types.generated").components["schemas"]["PriceBulk"] & {
865
+ price_configuration_id: string | null;
866
+ }) | (import("./_types.generated").components["schemas"]["PriceBundle"] & {
867
+ price_configuration_id: string | null;
868
+ }))[];
869
+ })[];
870
+ }[];
871
+ })[];
872
+ created_at: string;
873
+ updated_at: string;
874
+ } | null>;
875
+ previewSubscriptionTransition(data: NonNullable<paths['/v2/subscriptions/transitions/preview']['post']['requestBody']>['content']['application/json']): Promise<{
876
+ transition_invoice: import("./_types.generated").components["schemas"]["SimulateInvoiceDetails"] & (((import("./_types.generated").components["schemas"]["InvoiceDeprecated"] & {
877
+ public_url?: string | null;
878
+ }) & {
879
+ integrations: {
880
+ entity_id: string;
881
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
882
+ provider_account_id: string;
883
+ }[];
884
+ }) | null);
885
+ transition_credit_note: import("./_types.generated").components["schemas"]["SimulateInvoiceDetails"] & (((import("./_types.generated").components["schemas"]["InvoiceDeprecated"] & {
886
+ public_url?: string | null;
887
+ }) & {
888
+ integrations: {
889
+ entity_id: string;
890
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
891
+ provider_account_id: string;
892
+ }[];
893
+ }) | null);
894
+ next_invoice_after_transition: import("./_types.generated").components["schemas"]["SimulateInvoiceDetails"] & (((import("./_types.generated").components["schemas"]["InvoiceDeprecated"] & {
895
+ public_url?: string | null;
896
+ }) & {
897
+ integrations: {
898
+ entity_id: string;
899
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
900
+ provider_account_id: string;
901
+ }[];
902
+ }) | null);
903
+ } | null>;
904
+ createSubscriptionTransition(data: NonNullable<paths['/v2/subscriptions/transitions']['post']['requestBody']>['content']['application/json']): Promise<{
905
+ id: string;
906
+ customer_id: string;
907
+ base_subscription_id: string;
908
+ source_subscription_id: string;
909
+ target_subscription_id: string | null;
910
+ status: "scheduled" | "completed" | "failed" | "draft" | "pending_approval" | "changes_requested" | "cancelled" | "pending_quote_signature";
911
+ transitioned_at: string | null;
912
+ name: string | null;
913
+ transition_date: string | null;
914
+ application_schedule: "immediately" | "scheduled" | "next_renewal" | "last_renewal" | "quote_signature" | "scheduled_after_quote_signature";
915
+ billing_cycle_transition_method: "keep_current_billing_cycle" | "align_to_new_billing_cycle" | null;
916
+ calculation_method: "do_not_charge" | "pro_rata" | "pro_rata_separate_documents" | null;
917
+ } | null>;
626
918
  getSubscription(id: string, liveBilling?: boolean): Promise<({
627
919
  id: string;
628
920
  name: string | null;
@@ -1030,7 +1322,7 @@ export declare class HyperlineAPI {
1030
1322
  current_period_ends_at: string | null;
1031
1323
  } | null;
1032
1324
  }) | null>;
1033
- updateSubscription(id: string, data: NonNullable<paths['/v2/subscriptions/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
1325
+ activateSubscription(id: string): Promise<({
1034
1326
  id: string;
1035
1327
  name: string | null;
1036
1328
  currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
@@ -1228,10 +1520,7 @@ export declare class HyperlineAPI {
1228
1520
  current_period_ends_at: string | null;
1229
1521
  } | null;
1230
1522
  }) | null>;
1231
- createSubscriptionUpdate(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update']['post']['requestBody']>['content']['application/json']): Promise<{
1232
- id: string;
1233
- } | null>;
1234
- cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
1523
+ updateSubscription(id: string, data: NonNullable<paths['/v2/subscriptions/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
1235
1524
  id: string;
1236
1525
  name: string | null;
1237
1526
  currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
@@ -1429,7 +1718,13 @@ export declare class HyperlineAPI {
1429
1718
  current_period_ends_at: string | null;
1430
1719
  } | null;
1431
1720
  }) | null>;
1432
- reinstateSubscription(id: string): Promise<({
1721
+ createSubscriptionUpdate(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update']['post']['requestBody']>['content']['application/json']): Promise<{
1722
+ id: string;
1723
+ } | null>;
1724
+ createSubscriptionUpdates(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update-many']['post']['requestBody']>['content']['application/json']): Promise<{
1725
+ id: string;
1726
+ }[] | null>;
1727
+ cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
1433
1728
  id: string;
1434
1729
  name: string | null;
1435
1730
  currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
@@ -1627,99 +1922,561 @@ export declare class HyperlineAPI {
1627
1922
  current_period_ends_at: string | null;
1628
1923
  } | null;
1629
1924
  }) | null>;
1630
- getInvoice(id: string): Promise<({
1925
+ reinstateSubscription(id: string): Promise<({
1631
1926
  id: string;
1632
- number: string;
1633
- type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
1634
- document_name: string | null;
1635
- status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
1636
- reference: string | null;
1637
- purchase_order: string | null;
1927
+ name: string | null;
1638
1928
  currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
1639
- source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
1640
- total_amount: number;
1641
- amount_due: number;
1642
- amount_paid: number;
1643
- amount_fixed: number;
1644
- amount_excluding_tax: number;
1645
- tax_amount: number;
1646
- tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
1647
- discount_amount: number;
1648
- conversion_rate: number | null;
1649
- converted_amount: number | null;
1650
- converted_at: string | null;
1651
- payment_method_id: string | null;
1652
- bank_account_id: string | null;
1653
- custom_note: string | null;
1654
- additional_info: string | null;
1655
- footer: string | null;
1656
- customer: {
1657
- id: string;
1658
- name: string;
1659
- email: string | null;
1660
- external_id: string | null;
1661
- tax_id: string | null;
1662
- local_tax_number: string | null;
1663
- registration_number: string | null;
1664
- address: import("./_types.generated").components["schemas"]["Address"];
1665
- };
1666
- seller: {
1667
- id: string;
1668
- name: string;
1669
- tax_id: string | null;
1670
- registration_number: string | null;
1671
- address: import("./_types.generated").components["schemas"]["Address"] & unknown;
1672
- };
1673
- subscription_id: string | null;
1674
- period_starts_at: string | null;
1675
- period_ends_at: string | null;
1676
- due_at: string;
1677
- refunded_at: string | null;
1678
- grace_period_ended_at: string | null;
1679
- settled_at: string | null;
1680
- updated_at: string | null;
1929
+ status: "active" | "cancelled" | "draft" | "errored" | "archived" | "paused" | "pending" | "voided";
1930
+ purchase_order: string | null;
1931
+ customer_id: string;
1932
+ invoicing_entity_id: string | null;
1933
+ plan_id: string | null;
1934
+ template_id: string | null;
1935
+ checkout_session_id: string | null;
1936
+ crm_opportunity_id: string | null;
1937
+ minimum_invoice_fee: number | null;
1938
+ commitment_interval: {
1939
+ period: "days" | "weeks" | "months" | "years";
1940
+ count: number;
1941
+ } | null;
1942
+ renew_automatically: boolean;
1943
+ renew_for: {
1944
+ period: "days" | "weeks" | "months" | "years";
1945
+ count: number;
1946
+ } | null;
1947
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
1948
+ starts_at: string | null;
1949
+ contract_start: string | null;
1950
+ contract_end: string | null;
1951
+ initial_billing_at: string | null;
1952
+ paused_at: string | null;
1953
+ reactivate_at: string | null;
1954
+ cancel_at: string | null;
1955
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
1956
+ cancellation_amount: number | null;
1957
+ cancellation_reason: string | null;
1958
+ cancellation_source: "portal" | "app" | "api" | "system" | null;
1959
+ estimated_arr: number | null;
1960
+ contract_value: number | null;
1961
+ current_period_started_at: string | null;
1962
+ current_period_ends_at: string | null;
1963
+ next_payment_at: string | null;
1964
+ next_payment_amount: number | null;
1965
+ renews_at: string | null;
1966
+ current_phase_id: string | null;
1967
+ display_shipping_details: boolean | null;
1681
1968
  properties: {
1682
1969
  [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
1683
1970
  } | null;
1684
1971
  custom_properties: {
1685
1972
  [key: string]: string | number | boolean | string[] | null;
1686
1973
  } | null;
1687
- additional_display_fields: ({
1688
- type: "standard";
1689
- field: "customer_id" | "subscription_id" | "quote_id";
1690
- } | {
1691
- type: "custom_property";
1692
- slug: string;
1974
+ invoice_schedule: "period_start" | "period_end" | null;
1975
+ generate_document: boolean;
1976
+ document_name: string | null;
1977
+ add_tax_to_document: boolean;
1978
+ generate_draft_invoices: boolean;
1979
+ do_not_charge_subscription: boolean;
1980
+ invoice_custom_note: string | null;
1981
+ created_at: string;
1982
+ updated_at: string;
1983
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
1984
+ coupons: (({
1985
+ description: string | null;
1986
+ expiration_date: string | null;
1987
+ redemption_limit: number | null;
1988
+ repeat: "once" | "forever" | "custom" | "duration" | null;
1989
+ duration: {
1990
+ count: number;
1991
+ period: "days" | "weeks" | "months" | "years";
1992
+ } | null;
1993
+ created_at: string;
1994
+ type: "amount";
1995
+ discount_amount: number;
1996
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
1693
1997
  } | {
1694
- type: "custom";
1695
- label: string;
1696
- value: string;
1697
- })[] | null;
1698
- original_invoice_id: string | null;
1699
- original_invoice_number: string | null;
1700
- line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
1701
- allocations?: {
1702
- invoice_id: string;
1703
- amount: number;
1998
+ description: string | null;
1999
+ expiration_date: string | null;
2000
+ redemption_limit: number | null;
2001
+ repeat: "once" | "forever" | "custom" | "duration" | null;
2002
+ duration: {
2003
+ count: number;
2004
+ period: "days" | "weeks" | "months" | "years";
2005
+ } | null;
2006
+ created_at: string;
2007
+ type: "percent";
2008
+ discount_percent: number;
2009
+ }) & {
2010
+ id: string | null;
2011
+ promotion_code_id: string | null;
2012
+ name: string | null;
2013
+ subscription_coupon_id: string;
2014
+ repeat: "once" | "forever" | "custom" | "duration";
2015
+ duration_period: "days" | "weeks" | "months" | "years" | null;
2016
+ duration_count: number | null;
2017
+ product_ids: string[] | null;
2018
+ apply_at: string | null;
2019
+ expires_at: string | null;
2020
+ })[];
2021
+ integrations: {
2022
+ entity_id: string;
2023
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2024
+ provider_account_id: string;
1704
2025
  }[];
1705
- coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
1706
- transactions: ({
2026
+ } & {
2027
+ phases: {
1707
2028
  id: string;
1708
- type: "subscription" | "one_time" | "refund" | "chargeback";
1709
- amount: number;
1710
- currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
1711
- customer_id: string;
1712
- provider_id: string | null;
1713
- process_at: string;
1714
- settled_at: string | null;
1715
- refunded_at: string | null;
1716
- original_transaction_id: string | null;
1717
- reversed_at: string | null;
1718
- last_refreshed_at: string | null;
1719
- provider_fee: {
1720
- amount: number;
1721
- currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
1722
- exchange_rate: number | null;
2029
+ name: string | null;
2030
+ type: "setup" | "trial" | "standard";
2031
+ status: "pending" | "active" | "finished";
2032
+ order: number;
2033
+ activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
2034
+ end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
2035
+ duration: {
2036
+ period: "days" | "weeks" | "months" | "years";
2037
+ count: number;
2038
+ } | null;
2039
+ billing_date_setting: "phase_start" | "specific_date";
2040
+ initial_billing_at: string | null;
2041
+ starts_at: string | null;
2042
+ ends_at: string | null;
2043
+ billing_cycle_alignment: "calendar_period" | "anniversary";
2044
+ do_not_invoice_phase: boolean;
2045
+ transition_calculation_method: "prorata" | "pay_in_full" | "none";
2046
+ transition_invoicing_schedule: "immediately";
2047
+ products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductBundle"])[];
2048
+ coupons: (({
2049
+ description: string | null;
2050
+ expiration_date: string | null;
2051
+ redemption_limit: number | null;
2052
+ repeat: "once" | "forever" | "custom" | "duration" | null;
2053
+ duration: {
2054
+ count: number;
2055
+ period: "days" | "weeks" | "months" | "years";
2056
+ } | null;
2057
+ created_at: string;
2058
+ type: "amount";
2059
+ discount_amount: number;
2060
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
2061
+ } | {
2062
+ description: string | null;
2063
+ expiration_date: string | null;
2064
+ redemption_limit: number | null;
2065
+ repeat: "once" | "forever" | "custom" | "duration" | null;
2066
+ duration: {
2067
+ count: number;
2068
+ period: "days" | "weeks" | "months" | "years";
2069
+ } | null;
2070
+ created_at: string;
2071
+ type: "percent";
2072
+ discount_percent: number;
2073
+ }) & {
2074
+ id: string | null;
2075
+ promotion_code_id: string | null;
2076
+ name: string | null;
2077
+ subscription_coupon_id: string;
2078
+ repeat: "once" | "forever" | "custom" | "duration";
2079
+ duration_period: "days" | "weeks" | "months" | "years" | null;
2080
+ duration_count: number | null;
2081
+ product_ids: string[] | null;
2082
+ apply_at: string | null;
2083
+ expires_at: string | null;
2084
+ })[];
2085
+ created_at: string;
2086
+ updated_at: string;
2087
+ }[];
2088
+ quote: {
2089
+ id: string;
2090
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
2091
+ } | null;
2092
+ plan: {
2093
+ id: string;
2094
+ name: string;
2095
+ } | null;
2096
+ template: {
2097
+ id: string;
2098
+ name: string;
2099
+ configurationId: string;
2100
+ } | null;
2101
+ checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
2102
+ payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
2103
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
2104
+ contract_terms: {
2105
+ status: "active" | "pending" | "finished";
2106
+ activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
2107
+ end_strategy: "end_date" | "duration" | "manual";
2108
+ starts_at: string | null;
2109
+ ends_at: string | null;
2110
+ duration: {
2111
+ period: "days" | "weeks" | "months" | "years";
2112
+ count: number;
2113
+ } | null;
2114
+ renew_automatically: boolean | ("true" | "false");
2115
+ renew_for_duration: {
2116
+ period: "days" | "weeks" | "months" | "years";
2117
+ count: number;
2118
+ } | null;
2119
+ current_period_started_at: string | null;
2120
+ current_period_ends_at: string | null;
2121
+ } | null;
2122
+ }) | null>;
2123
+ createInvoice(data: NonNullable<paths['/v1/invoices']['post']['requestBody']>['content']['application/json']): Promise<({
2124
+ id: string;
2125
+ number: string;
2126
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
2127
+ document_name: string | null;
2128
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
2129
+ reference: string | null;
2130
+ purchase_order: string | null;
2131
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2132
+ source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
2133
+ total_amount: number;
2134
+ amount_due: number;
2135
+ amount_paid: number;
2136
+ amount_fixed: number;
2137
+ amount_excluding_tax: number;
2138
+ tax_rate: number;
2139
+ tax_amount: number;
2140
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
2141
+ discount_amount: number;
2142
+ conversion_rate: number | null;
2143
+ converted_amount: number | null;
2144
+ converted_at: string | null;
2145
+ payment_method_id: string | null;
2146
+ bank_account_id: string | null;
2147
+ custom_note: string | null;
2148
+ additional_info: string | null;
2149
+ footer: string | null;
2150
+ customer: {
2151
+ id: string;
2152
+ name: string;
2153
+ email: string | null;
2154
+ external_id: string | null;
2155
+ vat_number: string | null;
2156
+ tax_id: string | null;
2157
+ local_tax_number: string | null;
2158
+ registration_number: string | null;
2159
+ address: import("./_types.generated").components["schemas"]["Address"];
2160
+ };
2161
+ seller: {
2162
+ id: string;
2163
+ name: string;
2164
+ tax_id: string | null;
2165
+ registration_number: string | null;
2166
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
2167
+ };
2168
+ subscription_id: string | null;
2169
+ period_starts_at: string | null;
2170
+ period_ends_at: string | null;
2171
+ emitted_at: string;
2172
+ due_at: string;
2173
+ refunded_at: string | null;
2174
+ grace_period_ended_at: string | null;
2175
+ settled_at: string | null;
2176
+ updated_at: string | null;
2177
+ properties: {
2178
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
2179
+ } | null;
2180
+ custom_properties: {
2181
+ [key: string]: string | number | boolean | string[] | null;
2182
+ } | null;
2183
+ additional_display_fields: ({
2184
+ type: "standard";
2185
+ field: "customer_id" | "subscription_id" | "quote_id";
2186
+ } | {
2187
+ type: "custom_property";
2188
+ slug: string;
2189
+ } | {
2190
+ type: "custom";
2191
+ label: string;
2192
+ value: string;
2193
+ })[] | null;
2194
+ original_invoice_id: string | null;
2195
+ original_invoice_number: string | null;
2196
+ line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2197
+ allocations?: {
2198
+ invoice_id: string;
2199
+ amount: number;
2200
+ }[];
2201
+ coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
2202
+ transactions: ({
2203
+ id: string;
2204
+ type: "subscription" | "one_time" | "refund" | "chargeback";
2205
+ amount: number;
2206
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2207
+ customer_id: string;
2208
+ provider_id: string | null;
2209
+ process_at: string;
2210
+ settled_at: string | null;
2211
+ refunded_at: string | null;
2212
+ original_transaction_id: string | null;
2213
+ reversed_at: string | null;
2214
+ last_refreshed_at: string | null;
2215
+ provider_fee: {
2216
+ amount: number;
2217
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2218
+ exchange_rate: number | null;
2219
+ } | null;
2220
+ chargeback: {
2221
+ amount: number;
2222
+ last_chargeback_at: string;
2223
+ } | null;
2224
+ integrations: {
2225
+ entity_id: string;
2226
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2227
+ provider_account_id: string;
2228
+ }[];
2229
+ } & ({
2230
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
2231
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
2232
+ } | {
2233
+ payment_method_type: "transfer" | "transfer_automated";
2234
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
2235
+ } | {
2236
+ payment_method_type: "wallet";
2237
+ wallet_id: string;
2238
+ } | {
2239
+ payment_method_type: "external";
2240
+ }) & ({
2241
+ status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
2242
+ } | {
2243
+ status: "failed";
2244
+ error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "mandate_invalid" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
2245
+ error_message: string | null;
2246
+ }))[];
2247
+ public_url: string;
2248
+ } & {
2249
+ integrations: {
2250
+ entity_id: string;
2251
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2252
+ provider_account_id: string;
2253
+ }[];
2254
+ }) | null>;
2255
+ updateInvoice(id: string, data: NonNullable<paths['/v1/invoices/{id}']['patch']['requestBody']>['content']['application/json']): Promise<({
2256
+ id: string;
2257
+ number: string;
2258
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
2259
+ document_name: string | null;
2260
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
2261
+ reference: string | null;
2262
+ purchase_order: string | null;
2263
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2264
+ source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
2265
+ total_amount: number;
2266
+ amount_due: number;
2267
+ amount_paid: number;
2268
+ amount_fixed: number;
2269
+ amount_excluding_tax: number;
2270
+ tax_rate: number;
2271
+ tax_amount: number;
2272
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
2273
+ discount_amount: number;
2274
+ conversion_rate: number | null;
2275
+ converted_amount: number | null;
2276
+ converted_at: string | null;
2277
+ payment_method_id: string | null;
2278
+ bank_account_id: string | null;
2279
+ custom_note: string | null;
2280
+ additional_info: string | null;
2281
+ footer: string | null;
2282
+ customer: {
2283
+ id: string;
2284
+ name: string;
2285
+ email: string | null;
2286
+ external_id: string | null;
2287
+ vat_number: string | null;
2288
+ tax_id: string | null;
2289
+ local_tax_number: string | null;
2290
+ registration_number: string | null;
2291
+ address: import("./_types.generated").components["schemas"]["Address"];
2292
+ };
2293
+ seller: {
2294
+ id: string;
2295
+ name: string;
2296
+ tax_id: string | null;
2297
+ registration_number: string | null;
2298
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
2299
+ };
2300
+ subscription_id: string | null;
2301
+ period_starts_at: string | null;
2302
+ period_ends_at: string | null;
2303
+ emitted_at: string;
2304
+ due_at: string;
2305
+ refunded_at: string | null;
2306
+ grace_period_ended_at: string | null;
2307
+ settled_at: string | null;
2308
+ updated_at: string | null;
2309
+ properties: {
2310
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
2311
+ } | null;
2312
+ custom_properties: {
2313
+ [key: string]: string | number | boolean | string[] | null;
2314
+ } | null;
2315
+ additional_display_fields: ({
2316
+ type: "standard";
2317
+ field: "customer_id" | "subscription_id" | "quote_id";
2318
+ } | {
2319
+ type: "custom_property";
2320
+ slug: string;
2321
+ } | {
2322
+ type: "custom";
2323
+ label: string;
2324
+ value: string;
2325
+ })[] | null;
2326
+ original_invoice_id: string | null;
2327
+ original_invoice_number: string | null;
2328
+ line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2329
+ allocations?: {
2330
+ invoice_id: string;
2331
+ amount: number;
2332
+ }[];
2333
+ coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
2334
+ transactions: ({
2335
+ id: string;
2336
+ type: "subscription" | "one_time" | "refund" | "chargeback";
2337
+ amount: number;
2338
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2339
+ customer_id: string;
2340
+ provider_id: string | null;
2341
+ process_at: string;
2342
+ settled_at: string | null;
2343
+ refunded_at: string | null;
2344
+ original_transaction_id: string | null;
2345
+ reversed_at: string | null;
2346
+ last_refreshed_at: string | null;
2347
+ provider_fee: {
2348
+ amount: number;
2349
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2350
+ exchange_rate: number | null;
2351
+ } | null;
2352
+ chargeback: {
2353
+ amount: number;
2354
+ last_chargeback_at: string;
2355
+ } | null;
2356
+ integrations: {
2357
+ entity_id: string;
2358
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2359
+ provider_account_id: string;
2360
+ }[];
2361
+ } & ({
2362
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
2363
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
2364
+ } | {
2365
+ payment_method_type: "transfer" | "transfer_automated";
2366
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
2367
+ } | {
2368
+ payment_method_type: "wallet";
2369
+ wallet_id: string;
2370
+ } | {
2371
+ payment_method_type: "external";
2372
+ }) & ({
2373
+ status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
2374
+ } | {
2375
+ status: "failed";
2376
+ error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "mandate_invalid" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
2377
+ error_message: string | null;
2378
+ }))[];
2379
+ public_url: string;
2380
+ } & {
2381
+ integrations: {
2382
+ entity_id: string;
2383
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2384
+ provider_account_id: string;
2385
+ }[];
2386
+ }) | null>;
2387
+ getInvoice(id: string): Promise<({
2388
+ id: string;
2389
+ number: string;
2390
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
2391
+ document_name: string | null;
2392
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
2393
+ reference: string | null;
2394
+ purchase_order: string | null;
2395
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2396
+ source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
2397
+ total_amount: number;
2398
+ amount_due: number;
2399
+ amount_paid: number;
2400
+ amount_fixed: number;
2401
+ amount_excluding_tax: number;
2402
+ tax_amount: number;
2403
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
2404
+ discount_amount: number;
2405
+ conversion_rate: number | null;
2406
+ converted_amount: number | null;
2407
+ converted_at: string | null;
2408
+ payment_method_id: string | null;
2409
+ bank_account_id: string | null;
2410
+ custom_note: string | null;
2411
+ additional_info: string | null;
2412
+ footer: string | null;
2413
+ customer: {
2414
+ id: string;
2415
+ name: string;
2416
+ email: string | null;
2417
+ external_id: string | null;
2418
+ tax_id: string | null;
2419
+ local_tax_number: string | null;
2420
+ registration_number: string | null;
2421
+ address: import("./_types.generated").components["schemas"]["Address"];
2422
+ };
2423
+ seller: {
2424
+ id: string;
2425
+ name: string;
2426
+ tax_id: string | null;
2427
+ registration_number: string | null;
2428
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
2429
+ };
2430
+ subscription_id: string | null;
2431
+ period_starts_at: string | null;
2432
+ period_ends_at: string | null;
2433
+ due_at: string;
2434
+ refunded_at: string | null;
2435
+ grace_period_ended_at: string | null;
2436
+ settled_at: string | null;
2437
+ updated_at: string | null;
2438
+ properties: {
2439
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
2440
+ } | null;
2441
+ custom_properties: {
2442
+ [key: string]: string | number | boolean | string[] | null;
2443
+ } | null;
2444
+ additional_display_fields: ({
2445
+ type: "standard";
2446
+ field: "customer_id" | "subscription_id" | "quote_id";
2447
+ } | {
2448
+ type: "custom_property";
2449
+ slug: string;
2450
+ } | {
2451
+ type: "custom";
2452
+ label: string;
2453
+ value: string;
2454
+ })[] | null;
2455
+ original_invoice_id: string | null;
2456
+ original_invoice_number: string | null;
2457
+ line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2458
+ allocations?: {
2459
+ invoice_id: string;
2460
+ amount: number;
2461
+ }[];
2462
+ coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
2463
+ transactions: ({
2464
+ id: string;
2465
+ type: "subscription" | "one_time" | "refund" | "chargeback";
2466
+ amount: number;
2467
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2468
+ customer_id: string;
2469
+ provider_id: string | null;
2470
+ process_at: string;
2471
+ settled_at: string | null;
2472
+ refunded_at: string | null;
2473
+ original_transaction_id: string | null;
2474
+ reversed_at: string | null;
2475
+ last_refreshed_at: string | null;
2476
+ provider_fee: {
2477
+ amount: number;
2478
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2479
+ exchange_rate: number | null;
1723
2480
  } | null;
1724
2481
  chargeback: {
1725
2482
  amount: number;
@@ -1757,6 +2514,138 @@ export declare class HyperlineAPI {
1757
2514
  provider_account_id: string;
1758
2515
  }[];
1759
2516
  }) | null>;
2517
+ validateInvoice(id: string): Promise<({
2518
+ id: string;
2519
+ number: string;
2520
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
2521
+ document_name: string | null;
2522
+ status: "draft" | "pending_approval" | "changes_requested" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "pending_consolidation" | "consolidated" | "uncollectible";
2523
+ reference: string | null;
2524
+ purchase_order: string | null;
2525
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2526
+ source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
2527
+ total_amount: number;
2528
+ amount_due: number;
2529
+ amount_paid: number;
2530
+ amount_fixed: number;
2531
+ amount_excluding_tax: number;
2532
+ tax_rate: number;
2533
+ tax_amount: number;
2534
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
2535
+ discount_amount: number;
2536
+ conversion_rate: number | null;
2537
+ converted_amount: number | null;
2538
+ converted_at: string | null;
2539
+ payment_method_id: string | null;
2540
+ bank_account_id: string | null;
2541
+ custom_note: string | null;
2542
+ additional_info: string | null;
2543
+ footer: string | null;
2544
+ customer: {
2545
+ id: string;
2546
+ name: string;
2547
+ email: string | null;
2548
+ external_id: string | null;
2549
+ vat_number: string | null;
2550
+ tax_id: string | null;
2551
+ local_tax_number: string | null;
2552
+ registration_number: string | null;
2553
+ address: import("./_types.generated").components["schemas"]["Address"];
2554
+ };
2555
+ seller: {
2556
+ id: string;
2557
+ name: string;
2558
+ tax_id: string | null;
2559
+ registration_number: string | null;
2560
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
2561
+ };
2562
+ subscription_id: string | null;
2563
+ period_starts_at: string | null;
2564
+ period_ends_at: string | null;
2565
+ emitted_at: string;
2566
+ due_at: string;
2567
+ refunded_at: string | null;
2568
+ grace_period_ended_at: string | null;
2569
+ settled_at: string | null;
2570
+ updated_at: string | null;
2571
+ properties: {
2572
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
2573
+ } | null;
2574
+ custom_properties: {
2575
+ [key: string]: string | number | boolean | string[] | null;
2576
+ } | null;
2577
+ additional_display_fields: ({
2578
+ type: "standard";
2579
+ field: "customer_id" | "subscription_id" | "quote_id";
2580
+ } | {
2581
+ type: "custom_property";
2582
+ slug: string;
2583
+ } | {
2584
+ type: "custom";
2585
+ label: string;
2586
+ value: string;
2587
+ })[] | null;
2588
+ original_invoice_id: string | null;
2589
+ original_invoice_number: string | null;
2590
+ line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
2591
+ allocations?: {
2592
+ invoice_id: string;
2593
+ amount: number;
2594
+ }[];
2595
+ coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
2596
+ transactions: ({
2597
+ id: string;
2598
+ type: "subscription" | "one_time" | "refund" | "chargeback";
2599
+ amount: number;
2600
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2601
+ customer_id: string;
2602
+ provider_id: string | null;
2603
+ process_at: string;
2604
+ settled_at: string | null;
2605
+ refunded_at: string | null;
2606
+ original_transaction_id: string | null;
2607
+ reversed_at: string | null;
2608
+ last_refreshed_at: string | null;
2609
+ provider_fee: {
2610
+ amount: number;
2611
+ currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "XOF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
2612
+ exchange_rate: number | null;
2613
+ } | null;
2614
+ chargeback: {
2615
+ amount: number;
2616
+ last_chargeback_at: string;
2617
+ } | null;
2618
+ integrations: {
2619
+ entity_id: string;
2620
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2621
+ provider_account_id: string;
2622
+ }[];
2623
+ } & ({
2624
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
2625
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
2626
+ } | {
2627
+ payment_method_type: "transfer" | "transfer_automated";
2628
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (import("./_types.generated").components["schemas"]["StandardBankAccount"] | import("./_types.generated").components["schemas"]["ConnectedBankAccount"] | null);
2629
+ } | {
2630
+ payment_method_type: "wallet";
2631
+ wallet_id: string;
2632
+ } | {
2633
+ payment_method_type: "external";
2634
+ }) & ({
2635
+ status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
2636
+ } | {
2637
+ status: "failed";
2638
+ error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "mandate_invalid" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
2639
+ error_message: string | null;
2640
+ }))[];
2641
+ public_url: string;
2642
+ } & {
2643
+ integrations: {
2644
+ entity_id: string;
2645
+ provider_name: "adyen" | "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "zoho-books" | "exact-online" | "quickbooks" | "netsuite" | "rillet" | "datev" | "anrok" | "chargebee" | "slack" | "plain" | "zendesk" | "pylon" | "intercom" | "front" | "helpscout" | "claap" | "grain" | "gong" | "jiminny" | "posthog";
2646
+ provider_account_id: string;
2647
+ }[];
2648
+ }) | null>;
1760
2649
  getInvoices(query?: paths['/v2/invoices']['get']['parameters']['query']): Promise<{
1761
2650
  data: import("./_types.generated").components["schemas"]["Invoice"][];
1762
2651
  next_cursor: string | null;