@vrplatform/hyperline-client 1.0.26 → 1.0.27
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/const.d.ts +1 -0
- package/build/main/const.js +1 -0
- package/build/main/const.js.map +1 -1
- package/build/main/utils/index.d.ts +1 -1
- package/build/main/utils/index.js +1 -1
- package/build/main/utils/index.js.map +1 -1
- package/build/main/utils/isTestingTeam.d.ts +5 -0
- package/build/main/utils/isTestingTeam.js +4 -0
- package/build/main/utils/isTestingTeam.js.map +1 -0
- package/build/module/const.d.ts +1 -0
- package/build/module/const.js +1 -0
- package/build/module/const.js.map +1 -1
- package/build/module/utils/index.d.ts +1 -1
- package/build/module/utils/index.js +1 -1
- package/build/module/utils/index.js.map +1 -1
- package/build/module/utils/isTestingTeam.d.ts +5 -0
- package/build/module/utils/isTestingTeam.js +4 -0
- package/build/module/utils/isTestingTeam.js.map +1 -0
- package/package.json +2 -2
- package/src/const.ts +1 -0
- package/src/utils/index.ts +1 -1
- package/src/utils/isTestingTeam.ts +11 -0
- package/build/main/src/_types.generated.d.ts +0 -22310
- package/build/main/src/_types.generated.js +0 -6
- package/build/main/src/_types.generated.js.map +0 -1
- package/build/main/src/client.d.ts +0 -1706
- package/build/main/src/client.js +0 -294
- package/build/main/src/client.js.map +0 -1
- package/build/main/src/const.d.ts +0 -73
- package/build/main/src/const.js +0 -257
- package/build/main/src/const.js.map +0 -1
- package/build/main/src/hooks.d.ts +0 -10
- package/build/main/src/hooks.js +0 -13
- package/build/main/src/hooks.js.map +0 -1
- package/build/main/src/index.d.ts +0 -5
- package/build/main/src/index.js +0 -6
- package/build/main/src/index.js.map +0 -1
- package/build/main/src/types.d.ts +0 -35
- package/build/main/src/types.js +0 -2
- package/build/main/src/types.js.map +0 -1
- package/build/main/src/utils/arrayBufferToBase64.d.ts +0 -1
- package/build/main/src/utils/arrayBufferToBase64.js +0 -9
- package/build/main/src/utils/arrayBufferToBase64.js.map +0 -1
- package/build/main/src/utils/calculateMrr.d.ts +0 -45
- package/build/main/src/utils/calculateMrr.js +0 -107
- package/build/main/src/utils/calculateMrr.js.map +0 -1
- package/build/main/src/utils/getMrrDiffReasons.d.ts +0 -15
- package/build/main/src/utils/getMrrDiffReasons.js +0 -217
- package/build/main/src/utils/getMrrDiffReasons.js.map +0 -1
- package/build/main/src/utils/index.d.ts +0 -3
- package/build/main/src/utils/index.js +0 -4
- package/build/main/src/utils/index.js.map +0 -1
- package/build/main/tsconfig.main.tsbuildinfo +0 -1
- package/build/main/utils/getMrrDiffReasons.d.ts +0 -15
- package/build/main/utils/getMrrDiffReasons.js +0 -217
- package/build/main/utils/getMrrDiffReasons.js.map +0 -1
- package/build/module/src/_types.generated.d.ts +0 -22310
- package/build/module/src/_types.generated.js +0 -6
- package/build/module/src/_types.generated.js.map +0 -1
- package/build/module/src/client.d.ts +0 -1706
- package/build/module/src/client.js +0 -296
- package/build/module/src/client.js.map +0 -1
- package/build/module/src/const.d.ts +0 -73
- package/build/module/src/const.js +0 -257
- package/build/module/src/const.js.map +0 -1
- package/build/module/src/hooks.d.ts +0 -10
- package/build/module/src/hooks.js +0 -13
- package/build/module/src/hooks.js.map +0 -1
- package/build/module/src/index.d.ts +0 -5
- package/build/module/src/index.js +0 -6
- package/build/module/src/index.js.map +0 -1
- package/build/module/src/types.d.ts +0 -35
- package/build/module/src/types.js +0 -2
- package/build/module/src/types.js.map +0 -1
- package/build/module/src/utils/arrayBufferToBase64.d.ts +0 -1
- package/build/module/src/utils/arrayBufferToBase64.js +0 -9
- package/build/module/src/utils/arrayBufferToBase64.js.map +0 -1
- package/build/module/src/utils/calculateMrr.d.ts +0 -45
- package/build/module/src/utils/calculateMrr.js +0 -107
- package/build/module/src/utils/calculateMrr.js.map +0 -1
- package/build/module/src/utils/getMrrDiffReasons.d.ts +0 -15
- package/build/module/src/utils/getMrrDiffReasons.js +0 -217
- package/build/module/src/utils/getMrrDiffReasons.js.map +0 -1
- package/build/module/src/utils/index.d.ts +0 -3
- package/build/module/src/utils/index.js +0 -4
- package/build/module/src/utils/index.js.map +0 -1
- package/build/module/tsconfig.esm.tsbuildinfo +0 -1
- package/build/module/utils/getMrrDiffReasons.d.ts +0 -15
- package/build/module/utils/getMrrDiffReasons.js +0 -217
- package/build/module/utils/getMrrDiffReasons.js.map +0 -1
- package/src/utils/getMrrDiffReasons.ts +0 -306
|
@@ -1,1706 +0,0 @@
|
|
|
1
|
-
import type { operations, paths } from './_types.generated';
|
|
2
|
-
import { BillableEvents, CreateBillableEvent } from './types';
|
|
3
|
-
export type Logger = {
|
|
4
|
-
error(message?: any, ...optionalParams: any[]): void;
|
|
5
|
-
};
|
|
6
|
-
export declare class HyperlineAPI {
|
|
7
|
-
constructor(token: string, logger?: Logger);
|
|
8
|
-
private headers;
|
|
9
|
-
private logger;
|
|
10
|
-
private fetchBasic;
|
|
11
|
-
private fetch;
|
|
12
|
-
private fetchIngest;
|
|
13
|
-
getInvoicingEntities(): Promise<{
|
|
14
|
-
meta: {
|
|
15
|
-
total: number;
|
|
16
|
-
taken: number;
|
|
17
|
-
skipped: number;
|
|
18
|
-
};
|
|
19
|
-
data: {
|
|
20
|
-
id: string;
|
|
21
|
-
name: string;
|
|
22
|
-
trade_name?: string;
|
|
23
|
-
timezone: string;
|
|
24
|
-
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl";
|
|
25
|
-
is_default: boolean;
|
|
26
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
27
|
-
accounting_currency: string;
|
|
28
|
-
address_line1: string | null;
|
|
29
|
-
address_line2: string | null;
|
|
30
|
-
zip_code: string | null;
|
|
31
|
-
state: string | null;
|
|
32
|
-
city: string | null;
|
|
33
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
|
|
34
|
-
tax_id: string | null;
|
|
35
|
-
tax_id_valid?: boolean;
|
|
36
|
-
billing_email: string | null;
|
|
37
|
-
invoice_number_pattern: string;
|
|
38
|
-
credit_note_number_pattern: string;
|
|
39
|
-
document_number_pattern: string;
|
|
40
|
-
next_invoice_number: number;
|
|
41
|
-
next_credit_note_number: number;
|
|
42
|
-
next_document_number: number;
|
|
43
|
-
default_payment_delay: number;
|
|
44
|
-
invoice_grace_period_duration: number;
|
|
45
|
-
invoice_payment_initiation_delay: number | null;
|
|
46
|
-
document_payment_initiation_delay: number | null;
|
|
47
|
-
invoice_late_fees: string | null;
|
|
48
|
-
invoice_footer: string | null;
|
|
49
|
-
document_footer: string | null;
|
|
50
|
-
logo_url: string | null;
|
|
51
|
-
favicon_url: string | null;
|
|
52
|
-
brand_color: string | null;
|
|
53
|
-
forced_customer_type: "corporate" | "person" | null;
|
|
54
|
-
created_at: string;
|
|
55
|
-
updated_at: string;
|
|
56
|
-
deleted_at: string | null;
|
|
57
|
-
}[];
|
|
58
|
-
} | null>;
|
|
59
|
-
getInvoicingEntity(id?: string): Promise<{
|
|
60
|
-
id: string;
|
|
61
|
-
name: string;
|
|
62
|
-
trade_name?: string;
|
|
63
|
-
timezone: string;
|
|
64
|
-
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl";
|
|
65
|
-
is_default: boolean;
|
|
66
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
67
|
-
accounting_currency: string;
|
|
68
|
-
address_line1: string | null;
|
|
69
|
-
address_line2: string | null;
|
|
70
|
-
zip_code: string | null;
|
|
71
|
-
state: string | null;
|
|
72
|
-
city: string | null;
|
|
73
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
|
|
74
|
-
tax_id: string | null;
|
|
75
|
-
tax_id_valid?: boolean;
|
|
76
|
-
billing_email: string | null;
|
|
77
|
-
invoice_number_pattern: string;
|
|
78
|
-
credit_note_number_pattern: string;
|
|
79
|
-
document_number_pattern: string;
|
|
80
|
-
next_invoice_number: number;
|
|
81
|
-
next_credit_note_number: number;
|
|
82
|
-
next_document_number: number;
|
|
83
|
-
default_payment_delay: number;
|
|
84
|
-
invoice_grace_period_duration: number;
|
|
85
|
-
invoice_payment_initiation_delay: number | null;
|
|
86
|
-
document_payment_initiation_delay: number | null;
|
|
87
|
-
invoice_late_fees: string | null;
|
|
88
|
-
invoice_footer: string | null;
|
|
89
|
-
document_footer: string | null;
|
|
90
|
-
logo_url: string | null;
|
|
91
|
-
favicon_url: string | null;
|
|
92
|
-
brand_color: string | null;
|
|
93
|
-
forced_customer_type: "corporate" | "person" | null;
|
|
94
|
-
created_at: string;
|
|
95
|
-
updated_at: string;
|
|
96
|
-
deleted_at: string | null;
|
|
97
|
-
} | null>;
|
|
98
|
-
getCustomer(id?: string): Promise<({
|
|
99
|
-
id: string;
|
|
100
|
-
name: string;
|
|
101
|
-
type: "corporate" | "person" | "automatically_created" | null;
|
|
102
|
-
status: "active" | "archived";
|
|
103
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
104
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
105
|
-
vat_number: string | null;
|
|
106
|
-
vat_number_valid: boolean;
|
|
107
|
-
vat_rate_custom: number | null;
|
|
108
|
-
registration_number: string | null;
|
|
109
|
-
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
110
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
111
|
-
external_id: string | null;
|
|
112
|
-
properties: {
|
|
113
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
114
|
-
} | null;
|
|
115
|
-
custom_properties: {
|
|
116
|
-
[key: string]: string | number | boolean | null;
|
|
117
|
-
} | null;
|
|
118
|
-
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
119
|
-
billing_email: string | null;
|
|
120
|
-
invoice_emails: string[];
|
|
121
|
-
invoicing_entity_id: string;
|
|
122
|
-
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
123
|
-
price_book_id: string | null;
|
|
124
|
-
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
125
|
-
current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
126
|
-
current_payment_method_id: string | null;
|
|
127
|
-
custom_payment_delay: number | null;
|
|
128
|
-
subscriptions: {
|
|
129
|
-
id: string;
|
|
130
|
-
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
131
|
-
current_period_started_at: string | null;
|
|
132
|
-
current_period_ends_at: string | null;
|
|
133
|
-
plan_id: string | null;
|
|
134
|
-
checkout_session_id: string | null;
|
|
135
|
-
}[];
|
|
136
|
-
created_at: string;
|
|
137
|
-
updated_at: string;
|
|
138
|
-
deleted_at: string | null;
|
|
139
|
-
} & {
|
|
140
|
-
providers: {
|
|
141
|
-
stripe?: string;
|
|
142
|
-
mollie?: string;
|
|
143
|
-
gocardless?: string;
|
|
144
|
-
airwallex?: string;
|
|
145
|
-
salesforce?: string;
|
|
146
|
-
hubspot?: string;
|
|
147
|
-
attio?: string;
|
|
148
|
-
xero?: string;
|
|
149
|
-
pennylane?: string;
|
|
150
|
-
"exact-online"?: string;
|
|
151
|
-
quickbooks?: string;
|
|
152
|
-
netsuite?: string;
|
|
153
|
-
anrok?: string;
|
|
154
|
-
};
|
|
155
|
-
integrations: {
|
|
156
|
-
entity_id: string;
|
|
157
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
158
|
-
provider_account_id: string;
|
|
159
|
-
}[];
|
|
160
|
-
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
|
|
161
|
-
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
|
|
162
|
-
id: string;
|
|
163
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
164
|
-
bank_name: string | null;
|
|
165
|
-
} & ({
|
|
166
|
-
format: "iban_bic_swift";
|
|
167
|
-
iban: string;
|
|
168
|
-
bic_swift: string | null;
|
|
169
|
-
} | {
|
|
170
|
-
format: "sort_code_account_number";
|
|
171
|
-
sort_code: string;
|
|
172
|
-
account_number: string;
|
|
173
|
-
} | {
|
|
174
|
-
format: "account_number_routing_number";
|
|
175
|
-
account_number: string;
|
|
176
|
-
routing_number: string;
|
|
177
|
-
} | {
|
|
178
|
-
format: "account_number_bic_swift";
|
|
179
|
-
account_number: string;
|
|
180
|
-
bic_swift: string;
|
|
181
|
-
})) | null);
|
|
182
|
-
organisation_id: string | null;
|
|
183
|
-
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
184
|
-
}) | null>;
|
|
185
|
-
getCustomerById(id?: string): Promise<{
|
|
186
|
-
id: string;
|
|
187
|
-
name: string;
|
|
188
|
-
type: "corporate" | "person" | "automatically_created" | null;
|
|
189
|
-
status: "active" | "archived";
|
|
190
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
191
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
192
|
-
vat_number: string | null;
|
|
193
|
-
vat_number_valid: boolean;
|
|
194
|
-
vat_rate_custom: number | null;
|
|
195
|
-
registration_number: string | null;
|
|
196
|
-
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
197
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
198
|
-
external_id: string | null;
|
|
199
|
-
properties: {
|
|
200
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
201
|
-
} | null;
|
|
202
|
-
custom_properties: {
|
|
203
|
-
[key: string]: string | number | boolean | null;
|
|
204
|
-
} | null;
|
|
205
|
-
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
206
|
-
billing_email: string | null;
|
|
207
|
-
invoice_emails: string[];
|
|
208
|
-
invoicing_entity_id: string;
|
|
209
|
-
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
210
|
-
price_book_id: string | null;
|
|
211
|
-
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
212
|
-
current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
213
|
-
current_payment_method_id: string | null;
|
|
214
|
-
custom_payment_delay: number | null;
|
|
215
|
-
subscriptions: {
|
|
216
|
-
id: string;
|
|
217
|
-
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
218
|
-
current_period_started_at: string | null;
|
|
219
|
-
current_period_ends_at: string | null;
|
|
220
|
-
plan_id: string | null;
|
|
221
|
-
checkout_session_id: string | null;
|
|
222
|
-
}[];
|
|
223
|
-
created_at: string;
|
|
224
|
-
updated_at: string;
|
|
225
|
-
deleted_at: string | null;
|
|
226
|
-
} | undefined>;
|
|
227
|
-
getCustomers(skip?: number, take?: number, query?: operations['getCustomers']['parameters']['query']): Promise<{
|
|
228
|
-
meta: {
|
|
229
|
-
total: number;
|
|
230
|
-
taken: number;
|
|
231
|
-
skipped: number;
|
|
232
|
-
};
|
|
233
|
-
data: import("./_types.generated").components["schemas"]["Customer"][];
|
|
234
|
-
} | null>;
|
|
235
|
-
getAllCustomers(items?: paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getCustomers']['parameters']['query']): Promise<paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']>;
|
|
236
|
-
createCustomer(data: NonNullable<paths['/v1/customers']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
237
|
-
id: string;
|
|
238
|
-
name: string;
|
|
239
|
-
type: "corporate" | "person" | "automatically_created" | null;
|
|
240
|
-
status: "active" | "archived";
|
|
241
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
242
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
243
|
-
vat_number: string | null;
|
|
244
|
-
vat_number_valid: boolean;
|
|
245
|
-
vat_rate_custom: number | null;
|
|
246
|
-
registration_number: string | null;
|
|
247
|
-
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
248
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
249
|
-
external_id: string | null;
|
|
250
|
-
properties: {
|
|
251
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
252
|
-
} | null;
|
|
253
|
-
custom_properties: {
|
|
254
|
-
[key: string]: string | number | boolean | null;
|
|
255
|
-
} | null;
|
|
256
|
-
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
257
|
-
billing_email: string | null;
|
|
258
|
-
invoice_emails: string[];
|
|
259
|
-
invoicing_entity_id: string;
|
|
260
|
-
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
261
|
-
price_book_id: string | null;
|
|
262
|
-
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
263
|
-
current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
264
|
-
current_payment_method_id: string | null;
|
|
265
|
-
custom_payment_delay: number | null;
|
|
266
|
-
subscriptions: {
|
|
267
|
-
id: string;
|
|
268
|
-
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
269
|
-
current_period_started_at: string | null;
|
|
270
|
-
current_period_ends_at: string | null;
|
|
271
|
-
plan_id: string | null;
|
|
272
|
-
checkout_session_id: string | null;
|
|
273
|
-
}[];
|
|
274
|
-
created_at: string;
|
|
275
|
-
updated_at: string;
|
|
276
|
-
deleted_at: string | null;
|
|
277
|
-
} & {
|
|
278
|
-
providers: {
|
|
279
|
-
stripe?: string;
|
|
280
|
-
mollie?: string;
|
|
281
|
-
gocardless?: string;
|
|
282
|
-
airwallex?: string;
|
|
283
|
-
salesforce?: string;
|
|
284
|
-
hubspot?: string;
|
|
285
|
-
attio?: string;
|
|
286
|
-
xero?: string;
|
|
287
|
-
pennylane?: string;
|
|
288
|
-
"exact-online"?: string;
|
|
289
|
-
quickbooks?: string;
|
|
290
|
-
netsuite?: string;
|
|
291
|
-
anrok?: string;
|
|
292
|
-
};
|
|
293
|
-
integrations: {
|
|
294
|
-
entity_id: string;
|
|
295
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
296
|
-
provider_account_id: string;
|
|
297
|
-
}[];
|
|
298
|
-
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
|
|
299
|
-
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
|
|
300
|
-
id: string;
|
|
301
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
302
|
-
bank_name: string | null;
|
|
303
|
-
} & ({
|
|
304
|
-
format: "iban_bic_swift";
|
|
305
|
-
iban: string;
|
|
306
|
-
bic_swift: string | null;
|
|
307
|
-
} | {
|
|
308
|
-
format: "sort_code_account_number";
|
|
309
|
-
sort_code: string;
|
|
310
|
-
account_number: string;
|
|
311
|
-
} | {
|
|
312
|
-
format: "account_number_routing_number";
|
|
313
|
-
account_number: string;
|
|
314
|
-
routing_number: string;
|
|
315
|
-
} | {
|
|
316
|
-
format: "account_number_bic_swift";
|
|
317
|
-
account_number: string;
|
|
318
|
-
bic_swift: string;
|
|
319
|
-
})) | null);
|
|
320
|
-
organisation_id: string | null;
|
|
321
|
-
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
322
|
-
}) | null>;
|
|
323
|
-
updateCustomer(id: string, data: NonNullable<paths['/v1/customers/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
|
|
324
|
-
id: string;
|
|
325
|
-
name: string;
|
|
326
|
-
type: "corporate" | "person" | "automatically_created" | null;
|
|
327
|
-
status: "active" | "archived";
|
|
328
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
329
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
330
|
-
vat_number: string | null;
|
|
331
|
-
vat_number_valid: boolean;
|
|
332
|
-
vat_rate_custom: number | null;
|
|
333
|
-
registration_number: string | null;
|
|
334
|
-
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
335
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
336
|
-
external_id: string | null;
|
|
337
|
-
properties: {
|
|
338
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
339
|
-
} | null;
|
|
340
|
-
custom_properties: {
|
|
341
|
-
[key: string]: string | number | boolean | null;
|
|
342
|
-
} | null;
|
|
343
|
-
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
344
|
-
billing_email: string | null;
|
|
345
|
-
invoice_emails: string[];
|
|
346
|
-
invoicing_entity_id: string;
|
|
347
|
-
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
348
|
-
price_book_id: string | null;
|
|
349
|
-
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
350
|
-
current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
351
|
-
current_payment_method_id: string | null;
|
|
352
|
-
custom_payment_delay: number | null;
|
|
353
|
-
subscriptions: {
|
|
354
|
-
id: string;
|
|
355
|
-
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
356
|
-
current_period_started_at: string | null;
|
|
357
|
-
current_period_ends_at: string | null;
|
|
358
|
-
plan_id: string | null;
|
|
359
|
-
checkout_session_id: string | null;
|
|
360
|
-
}[];
|
|
361
|
-
created_at: string;
|
|
362
|
-
updated_at: string;
|
|
363
|
-
deleted_at: string | null;
|
|
364
|
-
} & {
|
|
365
|
-
providers: {
|
|
366
|
-
stripe?: string;
|
|
367
|
-
mollie?: string;
|
|
368
|
-
gocardless?: string;
|
|
369
|
-
airwallex?: string;
|
|
370
|
-
salesforce?: string;
|
|
371
|
-
hubspot?: string;
|
|
372
|
-
attio?: string;
|
|
373
|
-
xero?: string;
|
|
374
|
-
pennylane?: string;
|
|
375
|
-
"exact-online"?: string;
|
|
376
|
-
quickbooks?: string;
|
|
377
|
-
netsuite?: string;
|
|
378
|
-
anrok?: string;
|
|
379
|
-
};
|
|
380
|
-
integrations: {
|
|
381
|
-
entity_id: string;
|
|
382
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
383
|
-
provider_account_id: string;
|
|
384
|
-
}[];
|
|
385
|
-
current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
|
|
386
|
-
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
|
|
387
|
-
id: string;
|
|
388
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
389
|
-
bank_name: string | null;
|
|
390
|
-
} & ({
|
|
391
|
-
format: "iban_bic_swift";
|
|
392
|
-
iban: string;
|
|
393
|
-
bic_swift: string | null;
|
|
394
|
-
} | {
|
|
395
|
-
format: "sort_code_account_number";
|
|
396
|
-
sort_code: string;
|
|
397
|
-
account_number: string;
|
|
398
|
-
} | {
|
|
399
|
-
format: "account_number_routing_number";
|
|
400
|
-
account_number: string;
|
|
401
|
-
routing_number: string;
|
|
402
|
-
} | {
|
|
403
|
-
format: "account_number_bic_swift";
|
|
404
|
-
account_number: string;
|
|
405
|
-
bic_swift: string;
|
|
406
|
-
})) | null);
|
|
407
|
-
organisation_id: string | null;
|
|
408
|
-
organisation_invoicing: "none" | "every_invoice" | "concat" | null;
|
|
409
|
-
}) | null>;
|
|
410
|
-
deleteCustomer(id: string): Promise<null | undefined>;
|
|
411
|
-
archiveCustomer(id: string): Promise<{
|
|
412
|
-
id: string;
|
|
413
|
-
name: string;
|
|
414
|
-
type: "corporate" | "person" | "automatically_created" | null;
|
|
415
|
-
status: "active" | "archived";
|
|
416
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
417
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
418
|
-
vat_number: string | null;
|
|
419
|
-
vat_number_valid: boolean;
|
|
420
|
-
vat_rate_custom: number | null;
|
|
421
|
-
registration_number: string | null;
|
|
422
|
-
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
423
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
424
|
-
external_id: string | null;
|
|
425
|
-
properties: {
|
|
426
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
427
|
-
} | null;
|
|
428
|
-
custom_properties: {
|
|
429
|
-
[key: string]: string | number | boolean | null;
|
|
430
|
-
} | null;
|
|
431
|
-
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
432
|
-
billing_email: string | null;
|
|
433
|
-
invoice_emails: string[];
|
|
434
|
-
invoicing_entity_id: string;
|
|
435
|
-
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
436
|
-
price_book_id: string | null;
|
|
437
|
-
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
438
|
-
current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
439
|
-
current_payment_method_id: string | null;
|
|
440
|
-
custom_payment_delay: number | null;
|
|
441
|
-
subscriptions: {
|
|
442
|
-
id: string;
|
|
443
|
-
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
444
|
-
current_period_started_at: string | null;
|
|
445
|
-
current_period_ends_at: string | null;
|
|
446
|
-
plan_id: string | null;
|
|
447
|
-
checkout_session_id: string | null;
|
|
448
|
-
}[];
|
|
449
|
-
created_at: string;
|
|
450
|
-
updated_at: string;
|
|
451
|
-
deleted_at: string | null;
|
|
452
|
-
} | null>;
|
|
453
|
-
unarchiveCustomer(id: string): Promise<{
|
|
454
|
-
id: string;
|
|
455
|
-
name: string;
|
|
456
|
-
type: "corporate" | "person" | "automatically_created" | null;
|
|
457
|
-
status: "active" | "archived";
|
|
458
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
459
|
-
country: "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IC" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PT-20" | "PT-30" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | null;
|
|
460
|
-
vat_number: string | null;
|
|
461
|
-
vat_number_valid: boolean;
|
|
462
|
-
vat_rate_custom: number | null;
|
|
463
|
-
registration_number: string | null;
|
|
464
|
-
language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
|
|
465
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
466
|
-
external_id: string | null;
|
|
467
|
-
properties: {
|
|
468
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
469
|
-
} | null;
|
|
470
|
-
custom_properties: {
|
|
471
|
-
[key: string]: string | number | boolean | null;
|
|
472
|
-
} | null;
|
|
473
|
-
billing_address: import("./_types.generated").components["schemas"]["Address"];
|
|
474
|
-
billing_email: string | null;
|
|
475
|
-
invoice_emails: string[];
|
|
476
|
-
invoicing_entity_id: string;
|
|
477
|
-
invoice_reminders_enabled: boolean | ("true" | "false");
|
|
478
|
-
price_book_id: string | null;
|
|
479
|
-
available_payment_methods: ("card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated")[];
|
|
480
|
-
current_payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
481
|
-
current_payment_method_id: string | null;
|
|
482
|
-
custom_payment_delay: number | null;
|
|
483
|
-
subscriptions: {
|
|
484
|
-
id: string;
|
|
485
|
-
status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
|
|
486
|
-
current_period_started_at: string | null;
|
|
487
|
-
current_period_ends_at: string | null;
|
|
488
|
-
plan_id: string | null;
|
|
489
|
-
checkout_session_id: string | null;
|
|
490
|
-
}[];
|
|
491
|
-
created_at: string;
|
|
492
|
-
updated_at: string;
|
|
493
|
-
deleted_at: string | null;
|
|
494
|
-
} | null>;
|
|
495
|
-
getCustomerPortal(id: string): Promise<{
|
|
496
|
-
url: string;
|
|
497
|
-
} | null>;
|
|
498
|
-
getSubscription(id: string, liveBilling?: boolean): Promise<({
|
|
499
|
-
id: string;
|
|
500
|
-
name: string | null;
|
|
501
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
502
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
503
|
-
purchase_order: string | null;
|
|
504
|
-
customer_id: string;
|
|
505
|
-
plan_id: string | null;
|
|
506
|
-
invoicing_entity_id: string;
|
|
507
|
-
checkout_session_id: string | null;
|
|
508
|
-
crm_opportunity_id: string | null;
|
|
509
|
-
transition_from_subscription_id: string | null;
|
|
510
|
-
minimum_invoice_fee: number | null;
|
|
511
|
-
commitment_interval: {
|
|
512
|
-
period: "days" | "weeks" | "months" | "years";
|
|
513
|
-
count: number;
|
|
514
|
-
} | null;
|
|
515
|
-
renew_automatically: boolean;
|
|
516
|
-
renew_for: {
|
|
517
|
-
period: "days" | "weeks" | "months" | "years";
|
|
518
|
-
count: number;
|
|
519
|
-
} | null;
|
|
520
|
-
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
521
|
-
starts_at: string;
|
|
522
|
-
contract_start: string;
|
|
523
|
-
contract_end: string | null;
|
|
524
|
-
initial_billing_at: string | null;
|
|
525
|
-
paused_at: string | null;
|
|
526
|
-
reactivate_at: string | null;
|
|
527
|
-
cancel_at: string | null;
|
|
528
|
-
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
529
|
-
cancellation_amount: number | null;
|
|
530
|
-
cancellation_reason: string | null;
|
|
531
|
-
estimated_arr: number | null;
|
|
532
|
-
current_period_started_at: string | null;
|
|
533
|
-
current_period_ends_at: string | null;
|
|
534
|
-
next_payment_at: string | null;
|
|
535
|
-
next_payment_amount: number | null;
|
|
536
|
-
renews_at: string | null;
|
|
537
|
-
current_phase_id: string | null;
|
|
538
|
-
properties: {
|
|
539
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
540
|
-
} | null;
|
|
541
|
-
custom_properties: {
|
|
542
|
-
[key: string]: string | number | boolean | null;
|
|
543
|
-
} | null;
|
|
544
|
-
generate_document: boolean;
|
|
545
|
-
document_name: string | null;
|
|
546
|
-
add_tax_to_document: boolean;
|
|
547
|
-
created_at: string;
|
|
548
|
-
updated_at: string;
|
|
549
|
-
} & {
|
|
550
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
551
|
-
coupons: (({
|
|
552
|
-
description: string | null;
|
|
553
|
-
expiration_date: string | null;
|
|
554
|
-
redemption_limit: number | null;
|
|
555
|
-
created_at: string;
|
|
556
|
-
type: "amount";
|
|
557
|
-
discount_amount: number;
|
|
558
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
559
|
-
} | {
|
|
560
|
-
description: string | null;
|
|
561
|
-
expiration_date: string | null;
|
|
562
|
-
redemption_limit: number | null;
|
|
563
|
-
created_at: string;
|
|
564
|
-
type: "percent";
|
|
565
|
-
discount_percent: number;
|
|
566
|
-
}) & {
|
|
567
|
-
id: string | null;
|
|
568
|
-
promotion_code_id: string | null;
|
|
569
|
-
name: string | null;
|
|
570
|
-
subscription_coupon_id: string;
|
|
571
|
-
repeat: "once" | "forever" | "custom";
|
|
572
|
-
product_ids: string[];
|
|
573
|
-
apply_at: string | null;
|
|
574
|
-
expires_at: string | null;
|
|
575
|
-
})[];
|
|
576
|
-
phases: {
|
|
577
|
-
id: string;
|
|
578
|
-
type: "setup" | "trial" | "standard";
|
|
579
|
-
status: "pending" | "active" | "finished";
|
|
580
|
-
order: number;
|
|
581
|
-
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
582
|
-
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
583
|
-
duration: {
|
|
584
|
-
period: "days" | "weeks" | "months" | "years";
|
|
585
|
-
count: number;
|
|
586
|
-
} | null;
|
|
587
|
-
billing_date_setting: "phase_start" | "specific_date";
|
|
588
|
-
initial_billing_at: string | null;
|
|
589
|
-
starts_at: string | null;
|
|
590
|
-
ends_at: string | null;
|
|
591
|
-
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
592
|
-
do_not_invoice_phase: boolean;
|
|
593
|
-
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
594
|
-
transition_invoicing_schedule: "immediately";
|
|
595
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
596
|
-
coupons: (({
|
|
597
|
-
description: string | null;
|
|
598
|
-
expiration_date: string | null;
|
|
599
|
-
redemption_limit: number | null;
|
|
600
|
-
created_at: string;
|
|
601
|
-
type: "amount";
|
|
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;
|
|
604
|
-
} | {
|
|
605
|
-
description: string | null;
|
|
606
|
-
expiration_date: string | null;
|
|
607
|
-
redemption_limit: number | null;
|
|
608
|
-
created_at: string;
|
|
609
|
-
type: "percent";
|
|
610
|
-
discount_percent: number;
|
|
611
|
-
}) & {
|
|
612
|
-
id: string | null;
|
|
613
|
-
promotion_code_id: string | null;
|
|
614
|
-
name: string | null;
|
|
615
|
-
subscription_coupon_id: string;
|
|
616
|
-
repeat: "once" | "forever" | "custom";
|
|
617
|
-
product_ids: string[];
|
|
618
|
-
apply_at: string | null;
|
|
619
|
-
expires_at: string | null;
|
|
620
|
-
})[];
|
|
621
|
-
created_at: string;
|
|
622
|
-
updated_at: string;
|
|
623
|
-
}[];
|
|
624
|
-
quote: {
|
|
625
|
-
id: string;
|
|
626
|
-
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
627
|
-
} | null;
|
|
628
|
-
plan: {
|
|
629
|
-
id: string;
|
|
630
|
-
name: string;
|
|
631
|
-
} | null;
|
|
632
|
-
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
633
|
-
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
634
|
-
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
635
|
-
generate_draft_invoices: boolean;
|
|
636
|
-
generate_document: boolean;
|
|
637
|
-
document_name: string | null;
|
|
638
|
-
add_tax_to_document: boolean;
|
|
639
|
-
contract_terms: {
|
|
640
|
-
status: "active" | "pending" | "finished";
|
|
641
|
-
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
642
|
-
end_strategy: "end_date" | "duration" | "manual";
|
|
643
|
-
starts_at: string | null;
|
|
644
|
-
ends_at: string | null;
|
|
645
|
-
duration: {
|
|
646
|
-
period: "days" | "weeks" | "months" | "years";
|
|
647
|
-
count: number;
|
|
648
|
-
} | null;
|
|
649
|
-
renew_automatically: boolean | ("true" | "false");
|
|
650
|
-
renew_for_duration: {
|
|
651
|
-
period: "days" | "weeks" | "months" | "years";
|
|
652
|
-
count: number;
|
|
653
|
-
} | null;
|
|
654
|
-
current_period_started_at: string | null;
|
|
655
|
-
current_period_ends_at: string | null;
|
|
656
|
-
} | null;
|
|
657
|
-
} & {
|
|
658
|
-
live_billing?: import("./_types.generated").components["schemas"]["LiveBilling"];
|
|
659
|
-
}) | null>;
|
|
660
|
-
getSubscriptions(skip?: number, take?: number, query?: operations['getSubscriptions']['parameters']['query']): Promise<{
|
|
661
|
-
meta: {
|
|
662
|
-
total: number;
|
|
663
|
-
taken: number;
|
|
664
|
-
skipped: number;
|
|
665
|
-
};
|
|
666
|
-
data: import("./_types.generated").components["schemas"]["Subscription"][];
|
|
667
|
-
} | null>;
|
|
668
|
-
getAllSubscriptions(items?: paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getSubscriptions']['parameters']['query']): Promise<paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data']>;
|
|
669
|
-
createSubscription(data: NonNullable<paths['/v2/subscriptions']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
670
|
-
id: string;
|
|
671
|
-
name: string | null;
|
|
672
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
673
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
674
|
-
purchase_order: string | null;
|
|
675
|
-
customer_id: string;
|
|
676
|
-
plan_id: string | null;
|
|
677
|
-
invoicing_entity_id: string;
|
|
678
|
-
checkout_session_id: string | null;
|
|
679
|
-
crm_opportunity_id: string | null;
|
|
680
|
-
transition_from_subscription_id: string | null;
|
|
681
|
-
minimum_invoice_fee: number | null;
|
|
682
|
-
commitment_interval: {
|
|
683
|
-
period: "days" | "weeks" | "months" | "years";
|
|
684
|
-
count: number;
|
|
685
|
-
} | null;
|
|
686
|
-
renew_automatically: boolean;
|
|
687
|
-
renew_for: {
|
|
688
|
-
period: "days" | "weeks" | "months" | "years";
|
|
689
|
-
count: number;
|
|
690
|
-
} | null;
|
|
691
|
-
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
692
|
-
starts_at: string;
|
|
693
|
-
contract_start: string;
|
|
694
|
-
contract_end: string | null;
|
|
695
|
-
initial_billing_at: string | null;
|
|
696
|
-
paused_at: string | null;
|
|
697
|
-
reactivate_at: string | null;
|
|
698
|
-
cancel_at: string | null;
|
|
699
|
-
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
700
|
-
cancellation_amount: number | null;
|
|
701
|
-
cancellation_reason: string | null;
|
|
702
|
-
estimated_arr: number | null;
|
|
703
|
-
current_period_started_at: string | null;
|
|
704
|
-
current_period_ends_at: string | null;
|
|
705
|
-
next_payment_at: string | null;
|
|
706
|
-
next_payment_amount: number | null;
|
|
707
|
-
renews_at: string | null;
|
|
708
|
-
current_phase_id: string | null;
|
|
709
|
-
properties: {
|
|
710
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
711
|
-
} | null;
|
|
712
|
-
custom_properties: {
|
|
713
|
-
[key: string]: string | number | boolean | null;
|
|
714
|
-
} | null;
|
|
715
|
-
generate_document: boolean;
|
|
716
|
-
document_name: string | null;
|
|
717
|
-
add_tax_to_document: boolean;
|
|
718
|
-
created_at: string;
|
|
719
|
-
updated_at: string;
|
|
720
|
-
} & {
|
|
721
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
722
|
-
coupons: (({
|
|
723
|
-
description: string | null;
|
|
724
|
-
expiration_date: string | null;
|
|
725
|
-
redemption_limit: number | null;
|
|
726
|
-
created_at: string;
|
|
727
|
-
type: "amount";
|
|
728
|
-
discount_amount: number;
|
|
729
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
730
|
-
} | {
|
|
731
|
-
description: string | null;
|
|
732
|
-
expiration_date: string | null;
|
|
733
|
-
redemption_limit: number | null;
|
|
734
|
-
created_at: string;
|
|
735
|
-
type: "percent";
|
|
736
|
-
discount_percent: number;
|
|
737
|
-
}) & {
|
|
738
|
-
id: string | null;
|
|
739
|
-
promotion_code_id: string | null;
|
|
740
|
-
name: string | null;
|
|
741
|
-
subscription_coupon_id: string;
|
|
742
|
-
repeat: "once" | "forever" | "custom";
|
|
743
|
-
product_ids: string[];
|
|
744
|
-
apply_at: string | null;
|
|
745
|
-
expires_at: string | null;
|
|
746
|
-
})[];
|
|
747
|
-
phases: {
|
|
748
|
-
id: string;
|
|
749
|
-
type: "setup" | "trial" | "standard";
|
|
750
|
-
status: "pending" | "active" | "finished";
|
|
751
|
-
order: number;
|
|
752
|
-
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
753
|
-
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
754
|
-
duration: {
|
|
755
|
-
period: "days" | "weeks" | "months" | "years";
|
|
756
|
-
count: number;
|
|
757
|
-
} | null;
|
|
758
|
-
billing_date_setting: "phase_start" | "specific_date";
|
|
759
|
-
initial_billing_at: string | null;
|
|
760
|
-
starts_at: string | null;
|
|
761
|
-
ends_at: string | null;
|
|
762
|
-
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
763
|
-
do_not_invoice_phase: boolean;
|
|
764
|
-
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
765
|
-
transition_invoicing_schedule: "immediately";
|
|
766
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
767
|
-
coupons: (({
|
|
768
|
-
description: string | null;
|
|
769
|
-
expiration_date: string | null;
|
|
770
|
-
redemption_limit: number | null;
|
|
771
|
-
created_at: string;
|
|
772
|
-
type: "amount";
|
|
773
|
-
discount_amount: number;
|
|
774
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
775
|
-
} | {
|
|
776
|
-
description: string | null;
|
|
777
|
-
expiration_date: string | null;
|
|
778
|
-
redemption_limit: number | null;
|
|
779
|
-
created_at: string;
|
|
780
|
-
type: "percent";
|
|
781
|
-
discount_percent: number;
|
|
782
|
-
}) & {
|
|
783
|
-
id: string | null;
|
|
784
|
-
promotion_code_id: string | null;
|
|
785
|
-
name: string | null;
|
|
786
|
-
subscription_coupon_id: string;
|
|
787
|
-
repeat: "once" | "forever" | "custom";
|
|
788
|
-
product_ids: string[];
|
|
789
|
-
apply_at: string | null;
|
|
790
|
-
expires_at: string | null;
|
|
791
|
-
})[];
|
|
792
|
-
created_at: string;
|
|
793
|
-
updated_at: string;
|
|
794
|
-
}[];
|
|
795
|
-
quote: {
|
|
796
|
-
id: string;
|
|
797
|
-
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
798
|
-
} | null;
|
|
799
|
-
plan: {
|
|
800
|
-
id: string;
|
|
801
|
-
name: string;
|
|
802
|
-
} | null;
|
|
803
|
-
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
804
|
-
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
805
|
-
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
806
|
-
generate_draft_invoices: boolean;
|
|
807
|
-
generate_document: boolean;
|
|
808
|
-
document_name: string | null;
|
|
809
|
-
add_tax_to_document: boolean;
|
|
810
|
-
contract_terms: {
|
|
811
|
-
status: "active" | "pending" | "finished";
|
|
812
|
-
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
813
|
-
end_strategy: "end_date" | "duration" | "manual";
|
|
814
|
-
starts_at: string | null;
|
|
815
|
-
ends_at: string | null;
|
|
816
|
-
duration: {
|
|
817
|
-
period: "days" | "weeks" | "months" | "years";
|
|
818
|
-
count: number;
|
|
819
|
-
} | null;
|
|
820
|
-
renew_automatically: boolean | ("true" | "false");
|
|
821
|
-
renew_for_duration: {
|
|
822
|
-
period: "days" | "weeks" | "months" | "years";
|
|
823
|
-
count: number;
|
|
824
|
-
} | null;
|
|
825
|
-
current_period_started_at: string | null;
|
|
826
|
-
current_period_ends_at: string | null;
|
|
827
|
-
} | null;
|
|
828
|
-
}) | null>;
|
|
829
|
-
updateSubscription(id: string, data: NonNullable<paths['/v2/subscriptions/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
|
|
830
|
-
id: string;
|
|
831
|
-
name: string | null;
|
|
832
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
833
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
834
|
-
purchase_order: string | null;
|
|
835
|
-
customer_id: string;
|
|
836
|
-
plan_id: string | null;
|
|
837
|
-
invoicing_entity_id: string;
|
|
838
|
-
checkout_session_id: string | null;
|
|
839
|
-
crm_opportunity_id: string | null;
|
|
840
|
-
transition_from_subscription_id: string | null;
|
|
841
|
-
minimum_invoice_fee: number | null;
|
|
842
|
-
commitment_interval: {
|
|
843
|
-
period: "days" | "weeks" | "months" | "years";
|
|
844
|
-
count: number;
|
|
845
|
-
} | null;
|
|
846
|
-
renew_automatically: boolean;
|
|
847
|
-
renew_for: {
|
|
848
|
-
period: "days" | "weeks" | "months" | "years";
|
|
849
|
-
count: number;
|
|
850
|
-
} | null;
|
|
851
|
-
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
852
|
-
starts_at: string;
|
|
853
|
-
contract_start: string;
|
|
854
|
-
contract_end: string | null;
|
|
855
|
-
initial_billing_at: string | null;
|
|
856
|
-
paused_at: string | null;
|
|
857
|
-
reactivate_at: string | null;
|
|
858
|
-
cancel_at: string | null;
|
|
859
|
-
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
860
|
-
cancellation_amount: number | null;
|
|
861
|
-
cancellation_reason: string | null;
|
|
862
|
-
estimated_arr: number | null;
|
|
863
|
-
current_period_started_at: string | null;
|
|
864
|
-
current_period_ends_at: string | null;
|
|
865
|
-
next_payment_at: string | null;
|
|
866
|
-
next_payment_amount: number | null;
|
|
867
|
-
renews_at: string | null;
|
|
868
|
-
current_phase_id: string | null;
|
|
869
|
-
properties: {
|
|
870
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
871
|
-
} | null;
|
|
872
|
-
custom_properties: {
|
|
873
|
-
[key: string]: string | number | boolean | null;
|
|
874
|
-
} | null;
|
|
875
|
-
generate_document: boolean;
|
|
876
|
-
document_name: string | null;
|
|
877
|
-
add_tax_to_document: boolean;
|
|
878
|
-
created_at: string;
|
|
879
|
-
updated_at: string;
|
|
880
|
-
} & {
|
|
881
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
882
|
-
coupons: (({
|
|
883
|
-
description: string | null;
|
|
884
|
-
expiration_date: string | null;
|
|
885
|
-
redemption_limit: number | null;
|
|
886
|
-
created_at: string;
|
|
887
|
-
type: "amount";
|
|
888
|
-
discount_amount: number;
|
|
889
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
890
|
-
} | {
|
|
891
|
-
description: string | null;
|
|
892
|
-
expiration_date: string | null;
|
|
893
|
-
redemption_limit: number | null;
|
|
894
|
-
created_at: string;
|
|
895
|
-
type: "percent";
|
|
896
|
-
discount_percent: number;
|
|
897
|
-
}) & {
|
|
898
|
-
id: string | null;
|
|
899
|
-
promotion_code_id: string | null;
|
|
900
|
-
name: string | null;
|
|
901
|
-
subscription_coupon_id: string;
|
|
902
|
-
repeat: "once" | "forever" | "custom";
|
|
903
|
-
product_ids: string[];
|
|
904
|
-
apply_at: string | null;
|
|
905
|
-
expires_at: string | null;
|
|
906
|
-
})[];
|
|
907
|
-
phases: {
|
|
908
|
-
id: string;
|
|
909
|
-
type: "setup" | "trial" | "standard";
|
|
910
|
-
status: "pending" | "active" | "finished";
|
|
911
|
-
order: number;
|
|
912
|
-
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
913
|
-
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
914
|
-
duration: {
|
|
915
|
-
period: "days" | "weeks" | "months" | "years";
|
|
916
|
-
count: number;
|
|
917
|
-
} | null;
|
|
918
|
-
billing_date_setting: "phase_start" | "specific_date";
|
|
919
|
-
initial_billing_at: string | null;
|
|
920
|
-
starts_at: string | null;
|
|
921
|
-
ends_at: string | null;
|
|
922
|
-
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
923
|
-
do_not_invoice_phase: boolean;
|
|
924
|
-
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
925
|
-
transition_invoicing_schedule: "immediately";
|
|
926
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
927
|
-
coupons: (({
|
|
928
|
-
description: string | null;
|
|
929
|
-
expiration_date: string | null;
|
|
930
|
-
redemption_limit: number | null;
|
|
931
|
-
created_at: string;
|
|
932
|
-
type: "amount";
|
|
933
|
-
discount_amount: number;
|
|
934
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
935
|
-
} | {
|
|
936
|
-
description: string | null;
|
|
937
|
-
expiration_date: string | null;
|
|
938
|
-
redemption_limit: number | null;
|
|
939
|
-
created_at: string;
|
|
940
|
-
type: "percent";
|
|
941
|
-
discount_percent: number;
|
|
942
|
-
}) & {
|
|
943
|
-
id: string | null;
|
|
944
|
-
promotion_code_id: string | null;
|
|
945
|
-
name: string | null;
|
|
946
|
-
subscription_coupon_id: string;
|
|
947
|
-
repeat: "once" | "forever" | "custom";
|
|
948
|
-
product_ids: string[];
|
|
949
|
-
apply_at: string | null;
|
|
950
|
-
expires_at: string | null;
|
|
951
|
-
})[];
|
|
952
|
-
created_at: string;
|
|
953
|
-
updated_at: string;
|
|
954
|
-
}[];
|
|
955
|
-
quote: {
|
|
956
|
-
id: string;
|
|
957
|
-
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
958
|
-
} | null;
|
|
959
|
-
plan: {
|
|
960
|
-
id: string;
|
|
961
|
-
name: string;
|
|
962
|
-
} | null;
|
|
963
|
-
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
964
|
-
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
965
|
-
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
966
|
-
generate_draft_invoices: boolean;
|
|
967
|
-
generate_document: boolean;
|
|
968
|
-
document_name: string | null;
|
|
969
|
-
add_tax_to_document: boolean;
|
|
970
|
-
contract_terms: {
|
|
971
|
-
status: "active" | "pending" | "finished";
|
|
972
|
-
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
973
|
-
end_strategy: "end_date" | "duration" | "manual";
|
|
974
|
-
starts_at: string | null;
|
|
975
|
-
ends_at: string | null;
|
|
976
|
-
duration: {
|
|
977
|
-
period: "days" | "weeks" | "months" | "years";
|
|
978
|
-
count: number;
|
|
979
|
-
} | null;
|
|
980
|
-
renew_automatically: boolean | ("true" | "false");
|
|
981
|
-
renew_for_duration: {
|
|
982
|
-
period: "days" | "weeks" | "months" | "years";
|
|
983
|
-
count: number;
|
|
984
|
-
} | null;
|
|
985
|
-
current_period_started_at: string | null;
|
|
986
|
-
current_period_ends_at: string | null;
|
|
987
|
-
} | null;
|
|
988
|
-
}) | null>;
|
|
989
|
-
createSubscriptionUpdate(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update']['post']['requestBody']>['content']['application/json']): Promise<{
|
|
990
|
-
id: string;
|
|
991
|
-
} | null>;
|
|
992
|
-
cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
993
|
-
id: string;
|
|
994
|
-
name: string | null;
|
|
995
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
996
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
997
|
-
purchase_order: string | null;
|
|
998
|
-
customer_id: string;
|
|
999
|
-
plan_id: string | null;
|
|
1000
|
-
invoicing_entity_id: string;
|
|
1001
|
-
checkout_session_id: string | null;
|
|
1002
|
-
crm_opportunity_id: string | null;
|
|
1003
|
-
transition_from_subscription_id: string | null;
|
|
1004
|
-
minimum_invoice_fee: number | null;
|
|
1005
|
-
commitment_interval: {
|
|
1006
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1007
|
-
count: number;
|
|
1008
|
-
} | null;
|
|
1009
|
-
renew_automatically: boolean;
|
|
1010
|
-
renew_for: {
|
|
1011
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1012
|
-
count: number;
|
|
1013
|
-
} | null;
|
|
1014
|
-
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
1015
|
-
starts_at: string;
|
|
1016
|
-
contract_start: string;
|
|
1017
|
-
contract_end: string | null;
|
|
1018
|
-
initial_billing_at: string | null;
|
|
1019
|
-
paused_at: string | null;
|
|
1020
|
-
reactivate_at: string | null;
|
|
1021
|
-
cancel_at: string | null;
|
|
1022
|
-
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
1023
|
-
cancellation_amount: number | null;
|
|
1024
|
-
cancellation_reason: string | null;
|
|
1025
|
-
estimated_arr: number | null;
|
|
1026
|
-
current_period_started_at: string | null;
|
|
1027
|
-
current_period_ends_at: string | null;
|
|
1028
|
-
next_payment_at: string | null;
|
|
1029
|
-
next_payment_amount: number | null;
|
|
1030
|
-
renews_at: string | null;
|
|
1031
|
-
current_phase_id: string | null;
|
|
1032
|
-
properties: {
|
|
1033
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
1034
|
-
} | null;
|
|
1035
|
-
custom_properties: {
|
|
1036
|
-
[key: string]: string | number | boolean | null;
|
|
1037
|
-
} | null;
|
|
1038
|
-
generate_document: boolean;
|
|
1039
|
-
document_name: string | null;
|
|
1040
|
-
add_tax_to_document: boolean;
|
|
1041
|
-
created_at: string;
|
|
1042
|
-
updated_at: string;
|
|
1043
|
-
} & {
|
|
1044
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
1045
|
-
coupons: (({
|
|
1046
|
-
description: string | null;
|
|
1047
|
-
expiration_date: string | null;
|
|
1048
|
-
redemption_limit: number | null;
|
|
1049
|
-
created_at: string;
|
|
1050
|
-
type: "amount";
|
|
1051
|
-
discount_amount: number;
|
|
1052
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
1053
|
-
} | {
|
|
1054
|
-
description: string | null;
|
|
1055
|
-
expiration_date: string | null;
|
|
1056
|
-
redemption_limit: number | null;
|
|
1057
|
-
created_at: string;
|
|
1058
|
-
type: "percent";
|
|
1059
|
-
discount_percent: number;
|
|
1060
|
-
}) & {
|
|
1061
|
-
id: string | null;
|
|
1062
|
-
promotion_code_id: string | null;
|
|
1063
|
-
name: string | null;
|
|
1064
|
-
subscription_coupon_id: string;
|
|
1065
|
-
repeat: "once" | "forever" | "custom";
|
|
1066
|
-
product_ids: string[];
|
|
1067
|
-
apply_at: string | null;
|
|
1068
|
-
expires_at: string | null;
|
|
1069
|
-
})[];
|
|
1070
|
-
phases: {
|
|
1071
|
-
id: string;
|
|
1072
|
-
type: "setup" | "trial" | "standard";
|
|
1073
|
-
status: "pending" | "active" | "finished";
|
|
1074
|
-
order: number;
|
|
1075
|
-
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
1076
|
-
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
1077
|
-
duration: {
|
|
1078
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1079
|
-
count: number;
|
|
1080
|
-
} | null;
|
|
1081
|
-
billing_date_setting: "phase_start" | "specific_date";
|
|
1082
|
-
initial_billing_at: string | null;
|
|
1083
|
-
starts_at: string | null;
|
|
1084
|
-
ends_at: string | null;
|
|
1085
|
-
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
1086
|
-
do_not_invoice_phase: boolean;
|
|
1087
|
-
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
1088
|
-
transition_invoicing_schedule: "immediately";
|
|
1089
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
1090
|
-
coupons: (({
|
|
1091
|
-
description: string | null;
|
|
1092
|
-
expiration_date: string | null;
|
|
1093
|
-
redemption_limit: number | null;
|
|
1094
|
-
created_at: string;
|
|
1095
|
-
type: "amount";
|
|
1096
|
-
discount_amount: number;
|
|
1097
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
1098
|
-
} | {
|
|
1099
|
-
description: string | null;
|
|
1100
|
-
expiration_date: string | null;
|
|
1101
|
-
redemption_limit: number | null;
|
|
1102
|
-
created_at: string;
|
|
1103
|
-
type: "percent";
|
|
1104
|
-
discount_percent: number;
|
|
1105
|
-
}) & {
|
|
1106
|
-
id: string | null;
|
|
1107
|
-
promotion_code_id: string | null;
|
|
1108
|
-
name: string | null;
|
|
1109
|
-
subscription_coupon_id: string;
|
|
1110
|
-
repeat: "once" | "forever" | "custom";
|
|
1111
|
-
product_ids: string[];
|
|
1112
|
-
apply_at: string | null;
|
|
1113
|
-
expires_at: string | null;
|
|
1114
|
-
})[];
|
|
1115
|
-
created_at: string;
|
|
1116
|
-
updated_at: string;
|
|
1117
|
-
}[];
|
|
1118
|
-
quote: {
|
|
1119
|
-
id: string;
|
|
1120
|
-
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
1121
|
-
} | null;
|
|
1122
|
-
plan: {
|
|
1123
|
-
id: string;
|
|
1124
|
-
name: string;
|
|
1125
|
-
} | null;
|
|
1126
|
-
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
1127
|
-
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
1128
|
-
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
1129
|
-
generate_draft_invoices: boolean;
|
|
1130
|
-
generate_document: boolean;
|
|
1131
|
-
document_name: string | null;
|
|
1132
|
-
add_tax_to_document: boolean;
|
|
1133
|
-
contract_terms: {
|
|
1134
|
-
status: "active" | "pending" | "finished";
|
|
1135
|
-
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
1136
|
-
end_strategy: "end_date" | "duration" | "manual";
|
|
1137
|
-
starts_at: string | null;
|
|
1138
|
-
ends_at: string | null;
|
|
1139
|
-
duration: {
|
|
1140
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1141
|
-
count: number;
|
|
1142
|
-
} | null;
|
|
1143
|
-
renew_automatically: boolean | ("true" | "false");
|
|
1144
|
-
renew_for_duration: {
|
|
1145
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1146
|
-
count: number;
|
|
1147
|
-
} | null;
|
|
1148
|
-
current_period_started_at: string | null;
|
|
1149
|
-
current_period_ends_at: string | null;
|
|
1150
|
-
} | null;
|
|
1151
|
-
}) | null>;
|
|
1152
|
-
reinstateSubscription(id: string): Promise<({
|
|
1153
|
-
id: string;
|
|
1154
|
-
name: string | null;
|
|
1155
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1156
|
-
status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
|
|
1157
|
-
purchase_order: string | null;
|
|
1158
|
-
customer_id: string;
|
|
1159
|
-
plan_id: string | null;
|
|
1160
|
-
invoicing_entity_id: string;
|
|
1161
|
-
checkout_session_id: string | null;
|
|
1162
|
-
crm_opportunity_id: string | null;
|
|
1163
|
-
transition_from_subscription_id: string | null;
|
|
1164
|
-
minimum_invoice_fee: number | null;
|
|
1165
|
-
commitment_interval: {
|
|
1166
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1167
|
-
count: number;
|
|
1168
|
-
} | null;
|
|
1169
|
-
renew_automatically: boolean;
|
|
1170
|
-
renew_for: {
|
|
1171
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1172
|
-
count: number;
|
|
1173
|
-
} | null;
|
|
1174
|
-
activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
|
|
1175
|
-
starts_at: string;
|
|
1176
|
-
contract_start: string;
|
|
1177
|
-
contract_end: string | null;
|
|
1178
|
-
initial_billing_at: string | null;
|
|
1179
|
-
paused_at: string | null;
|
|
1180
|
-
reactivate_at: string | null;
|
|
1181
|
-
cancel_at: string | null;
|
|
1182
|
-
cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
|
|
1183
|
-
cancellation_amount: number | null;
|
|
1184
|
-
cancellation_reason: string | null;
|
|
1185
|
-
estimated_arr: number | null;
|
|
1186
|
-
current_period_started_at: string | null;
|
|
1187
|
-
current_period_ends_at: string | null;
|
|
1188
|
-
next_payment_at: string | null;
|
|
1189
|
-
next_payment_amount: number | null;
|
|
1190
|
-
renews_at: string | null;
|
|
1191
|
-
current_phase_id: string | null;
|
|
1192
|
-
properties: {
|
|
1193
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
1194
|
-
} | null;
|
|
1195
|
-
custom_properties: {
|
|
1196
|
-
[key: string]: string | number | boolean | null;
|
|
1197
|
-
} | null;
|
|
1198
|
-
generate_document: boolean;
|
|
1199
|
-
document_name: string | null;
|
|
1200
|
-
add_tax_to_document: boolean;
|
|
1201
|
-
created_at: string;
|
|
1202
|
-
updated_at: string;
|
|
1203
|
-
} & {
|
|
1204
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
1205
|
-
coupons: (({
|
|
1206
|
-
description: string | null;
|
|
1207
|
-
expiration_date: string | null;
|
|
1208
|
-
redemption_limit: number | null;
|
|
1209
|
-
created_at: string;
|
|
1210
|
-
type: "amount";
|
|
1211
|
-
discount_amount: number;
|
|
1212
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
1213
|
-
} | {
|
|
1214
|
-
description: string | null;
|
|
1215
|
-
expiration_date: string | null;
|
|
1216
|
-
redemption_limit: number | null;
|
|
1217
|
-
created_at: string;
|
|
1218
|
-
type: "percent";
|
|
1219
|
-
discount_percent: number;
|
|
1220
|
-
}) & {
|
|
1221
|
-
id: string | null;
|
|
1222
|
-
promotion_code_id: string | null;
|
|
1223
|
-
name: string | null;
|
|
1224
|
-
subscription_coupon_id: string;
|
|
1225
|
-
repeat: "once" | "forever" | "custom";
|
|
1226
|
-
product_ids: string[];
|
|
1227
|
-
apply_at: string | null;
|
|
1228
|
-
expires_at: string | null;
|
|
1229
|
-
})[];
|
|
1230
|
-
phases: {
|
|
1231
|
-
id: string;
|
|
1232
|
-
type: "setup" | "trial" | "standard";
|
|
1233
|
-
status: "pending" | "active" | "finished";
|
|
1234
|
-
order: number;
|
|
1235
|
-
activation_strategy: "immediately" | "manual" | "start_date" | "quote_signature" | "checkout" | "contract_start_date" | "previous_phase_end";
|
|
1236
|
-
end_strategy: "manual" | "end_date" | "duration" | "contract_end_date";
|
|
1237
|
-
duration: {
|
|
1238
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1239
|
-
count: number;
|
|
1240
|
-
} | null;
|
|
1241
|
-
billing_date_setting: "phase_start" | "specific_date";
|
|
1242
|
-
initial_billing_at: string | null;
|
|
1243
|
-
starts_at: string | null;
|
|
1244
|
-
ends_at: string | null;
|
|
1245
|
-
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
1246
|
-
do_not_invoice_phase: boolean;
|
|
1247
|
-
transition_calculation_method: "prorata" | "pay_in_full" | "none";
|
|
1248
|
-
transition_invoicing_schedule: "immediately";
|
|
1249
|
-
products: (import("./_types.generated").components["schemas"]["SubscriptionProductFee"] | import("./_types.generated").components["schemas"]["SubscriptionProductCredit"] | import("./_types.generated").components["schemas"]["SubscriptionProductSeat"] | import("./_types.generated").components["schemas"]["SubscriptionProductDynamic"])[];
|
|
1250
|
-
coupons: (({
|
|
1251
|
-
description: string | null;
|
|
1252
|
-
expiration_date: string | null;
|
|
1253
|
-
redemption_limit: number | null;
|
|
1254
|
-
created_at: string;
|
|
1255
|
-
type: "amount";
|
|
1256
|
-
discount_amount: number;
|
|
1257
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL" | null;
|
|
1258
|
-
} | {
|
|
1259
|
-
description: string | null;
|
|
1260
|
-
expiration_date: string | null;
|
|
1261
|
-
redemption_limit: number | null;
|
|
1262
|
-
created_at: string;
|
|
1263
|
-
type: "percent";
|
|
1264
|
-
discount_percent: number;
|
|
1265
|
-
}) & {
|
|
1266
|
-
id: string | null;
|
|
1267
|
-
promotion_code_id: string | null;
|
|
1268
|
-
name: string | null;
|
|
1269
|
-
subscription_coupon_id: string;
|
|
1270
|
-
repeat: "once" | "forever" | "custom";
|
|
1271
|
-
product_ids: string[];
|
|
1272
|
-
apply_at: string | null;
|
|
1273
|
-
expires_at: string | null;
|
|
1274
|
-
})[];
|
|
1275
|
-
created_at: string;
|
|
1276
|
-
updated_at: string;
|
|
1277
|
-
}[];
|
|
1278
|
-
quote: {
|
|
1279
|
-
id: string;
|
|
1280
|
-
status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
|
|
1281
|
-
} | null;
|
|
1282
|
-
plan: {
|
|
1283
|
-
id: string;
|
|
1284
|
-
name: string;
|
|
1285
|
-
} | null;
|
|
1286
|
-
checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
|
|
1287
|
-
payment_method_type: "card" | "apple_pay" | "google_pay" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "stripe_link" | "transfer" | "transfer_automated" | "external" | null;
|
|
1288
|
-
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
|
|
1289
|
-
generate_draft_invoices: boolean;
|
|
1290
|
-
generate_document: boolean;
|
|
1291
|
-
document_name: string | null;
|
|
1292
|
-
add_tax_to_document: boolean;
|
|
1293
|
-
contract_terms: {
|
|
1294
|
-
status: "active" | "pending" | "finished";
|
|
1295
|
-
activation_strategy: "start_date" | "immediately" | "manual" | "quote_signature" | "checkout";
|
|
1296
|
-
end_strategy: "end_date" | "duration" | "manual";
|
|
1297
|
-
starts_at: string | null;
|
|
1298
|
-
ends_at: string | null;
|
|
1299
|
-
duration: {
|
|
1300
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1301
|
-
count: number;
|
|
1302
|
-
} | null;
|
|
1303
|
-
renew_automatically: boolean | ("true" | "false");
|
|
1304
|
-
renew_for_duration: {
|
|
1305
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1306
|
-
count: number;
|
|
1307
|
-
} | null;
|
|
1308
|
-
current_period_started_at: string | null;
|
|
1309
|
-
current_period_ends_at: string | null;
|
|
1310
|
-
} | null;
|
|
1311
|
-
}) | null>;
|
|
1312
|
-
getPlan(id: string): Promise<{
|
|
1313
|
-
id: string;
|
|
1314
|
-
name: string;
|
|
1315
|
-
description: string | null;
|
|
1316
|
-
commitment_interval: {
|
|
1317
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1318
|
-
count: number;
|
|
1319
|
-
} | null;
|
|
1320
|
-
contract_start_strategy: "start_date" | "immediately" | "manual" | "manual_with_latest" | "quote_signature" | "checkout";
|
|
1321
|
-
contract_start: string | null;
|
|
1322
|
-
contract_end_strategy: "duration" | "manual" | "end_date";
|
|
1323
|
-
contract_end: string | null;
|
|
1324
|
-
contract_duration: {
|
|
1325
|
-
period: "days" | "weeks" | "months" | "years" | "forever";
|
|
1326
|
-
count: number | null;
|
|
1327
|
-
} | null;
|
|
1328
|
-
renew_automatically: boolean;
|
|
1329
|
-
renew_for: {
|
|
1330
|
-
period: "days" | "weeks" | "months" | "years";
|
|
1331
|
-
count: number | null;
|
|
1332
|
-
} | null;
|
|
1333
|
-
products: (import("./_types.generated").components["schemas"]["PlanProductFee"] | import("./_types.generated").components["schemas"]["PlanProductSeat"] | import("./_types.generated").components["schemas"]["PlanProductDynamic"] | import("./_types.generated").components["schemas"]["PlanProductCredit"])[];
|
|
1334
|
-
custom_properties: {
|
|
1335
|
-
[key: string]: string | number | boolean | null;
|
|
1336
|
-
} | null;
|
|
1337
|
-
} | null>;
|
|
1338
|
-
getPlans(skip?: number, take?: number): Promise<{
|
|
1339
|
-
meta: {
|
|
1340
|
-
total: number;
|
|
1341
|
-
taken: number;
|
|
1342
|
-
skipped: number;
|
|
1343
|
-
};
|
|
1344
|
-
data: import("./_types.generated").components["schemas"]["PlanSimple"][];
|
|
1345
|
-
} | null>;
|
|
1346
|
-
getInvoice(id: string): Promise<({
|
|
1347
|
-
id: string;
|
|
1348
|
-
number: string;
|
|
1349
|
-
type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
|
|
1350
|
-
document_name: string | null;
|
|
1351
|
-
status: "draft" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "uncollectible";
|
|
1352
|
-
reference: string | null;
|
|
1353
|
-
purchase_order: string | null;
|
|
1354
|
-
original_invoice_id: string | null;
|
|
1355
|
-
original_invoice_number: string | null;
|
|
1356
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1357
|
-
source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
|
|
1358
|
-
total_amount: number;
|
|
1359
|
-
amount_due: number;
|
|
1360
|
-
amount_paid: number;
|
|
1361
|
-
amount_fixed: number;
|
|
1362
|
-
amount_excluding_tax: number;
|
|
1363
|
-
tax_rate: number;
|
|
1364
|
-
tax_amount: number;
|
|
1365
|
-
tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
|
|
1366
|
-
discount_amount: number;
|
|
1367
|
-
conversion_rate: number | null;
|
|
1368
|
-
converted_amount: number | null;
|
|
1369
|
-
converted_at: string | null;
|
|
1370
|
-
payment_method_id: string | null;
|
|
1371
|
-
bank_account_id: string | null;
|
|
1372
|
-
custom_note: string | null;
|
|
1373
|
-
additional_info: string | null;
|
|
1374
|
-
footer: string | null;
|
|
1375
|
-
customer: {
|
|
1376
|
-
id: string;
|
|
1377
|
-
name: string;
|
|
1378
|
-
email: string | null;
|
|
1379
|
-
external_id: string | null;
|
|
1380
|
-
vat_number: string | null;
|
|
1381
|
-
address: import("./_types.generated").components["schemas"]["Address"];
|
|
1382
|
-
};
|
|
1383
|
-
seller: {
|
|
1384
|
-
id: string;
|
|
1385
|
-
name: string;
|
|
1386
|
-
tax_id: string | null;
|
|
1387
|
-
address: import("./_types.generated").components["schemas"]["Address"];
|
|
1388
|
-
};
|
|
1389
|
-
subscription_id: string | null;
|
|
1390
|
-
period_starts_at: string | null;
|
|
1391
|
-
period_ends_at: string | null;
|
|
1392
|
-
emitted_at: string;
|
|
1393
|
-
due_at: string;
|
|
1394
|
-
refunded_at: string | null;
|
|
1395
|
-
grace_period_ended_at: string | null;
|
|
1396
|
-
settled_at: string | null;
|
|
1397
|
-
updated_at: string | null;
|
|
1398
|
-
properties: {
|
|
1399
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
1400
|
-
} | null;
|
|
1401
|
-
line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
|
|
1402
|
-
coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
|
|
1403
|
-
transactions: ({
|
|
1404
|
-
id: string;
|
|
1405
|
-
type: "subscription" | "one_time" | "refund";
|
|
1406
|
-
amount: number;
|
|
1407
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1408
|
-
customer_id: string;
|
|
1409
|
-
provider_id: string | null;
|
|
1410
|
-
process_at: string;
|
|
1411
|
-
refunded_at: string | null;
|
|
1412
|
-
last_refreshed_at: string | null;
|
|
1413
|
-
provider_fee: {
|
|
1414
|
-
amount: number;
|
|
1415
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1416
|
-
exchange_rate: number | null;
|
|
1417
|
-
} | null;
|
|
1418
|
-
chargeback: {
|
|
1419
|
-
amount: number;
|
|
1420
|
-
last_chargeback_at: string;
|
|
1421
|
-
} | null;
|
|
1422
|
-
} & ({
|
|
1423
|
-
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1424
|
-
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
|
|
1425
|
-
} | {
|
|
1426
|
-
payment_method_type: "transfer" | "transfer_automated";
|
|
1427
|
-
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
|
|
1428
|
-
id: string;
|
|
1429
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1430
|
-
bank_name: string | null;
|
|
1431
|
-
} & ({
|
|
1432
|
-
format: "iban_bic_swift";
|
|
1433
|
-
iban: string;
|
|
1434
|
-
bic_swift: string | null;
|
|
1435
|
-
} | {
|
|
1436
|
-
format: "sort_code_account_number";
|
|
1437
|
-
sort_code: string;
|
|
1438
|
-
account_number: string;
|
|
1439
|
-
} | {
|
|
1440
|
-
format: "account_number_routing_number";
|
|
1441
|
-
account_number: string;
|
|
1442
|
-
routing_number: string;
|
|
1443
|
-
} | {
|
|
1444
|
-
format: "account_number_bic_swift";
|
|
1445
|
-
account_number: string;
|
|
1446
|
-
bic_swift: string;
|
|
1447
|
-
})) | null);
|
|
1448
|
-
} | {
|
|
1449
|
-
payment_method_type: "wallet";
|
|
1450
|
-
wallet_id: string;
|
|
1451
|
-
} | {
|
|
1452
|
-
payment_method_type: "external";
|
|
1453
|
-
}) & ({
|
|
1454
|
-
status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
|
|
1455
|
-
} | {
|
|
1456
|
-
status: "failed";
|
|
1457
|
-
error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
|
|
1458
|
-
error_message: string | null;
|
|
1459
|
-
}))[];
|
|
1460
|
-
} & {
|
|
1461
|
-
integrations: {
|
|
1462
|
-
entity_id: string;
|
|
1463
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1464
|
-
provider_account_id: string;
|
|
1465
|
-
}[];
|
|
1466
|
-
}) | null>;
|
|
1467
|
-
getInvoices(skip?: number, take?: number, query?: operations['getInvoices']['parameters']['query']): Promise<{
|
|
1468
|
-
meta: {
|
|
1469
|
-
total: number;
|
|
1470
|
-
taken: number;
|
|
1471
|
-
skipped: number;
|
|
1472
|
-
};
|
|
1473
|
-
data: import("./_types.generated").components["schemas"]["Invoice"][];
|
|
1474
|
-
} | null>;
|
|
1475
|
-
getInvoicesByCustomerId(id: string, filters?: Partial<operations['getInvoices']['parameters']['query']>): Promise<{
|
|
1476
|
-
meta: {
|
|
1477
|
-
total: number;
|
|
1478
|
-
taken: number;
|
|
1479
|
-
skipped: number;
|
|
1480
|
-
};
|
|
1481
|
-
data: import("./_types.generated").components["schemas"]["Invoice"][];
|
|
1482
|
-
} | null>;
|
|
1483
|
-
getInvoiceDownload(id: string): Promise<string | null>;
|
|
1484
|
-
getAllInvoices(items?: paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data'], query?: operations['getInvoices']['parameters']['query']): Promise<paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']>;
|
|
1485
|
-
voidInvoice(id: string, data?: NonNullable<paths['/v1/invoices/{id}/void']['post']['requestBody']>['content']['application/json']): Promise<({
|
|
1486
|
-
id: string;
|
|
1487
|
-
number: string;
|
|
1488
|
-
type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
|
|
1489
|
-
document_name: string | null;
|
|
1490
|
-
status: "draft" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat" | "uncollectible";
|
|
1491
|
-
reference: string | null;
|
|
1492
|
-
purchase_order: string | null;
|
|
1493
|
-
original_invoice_id: string | null;
|
|
1494
|
-
original_invoice_number: string | null;
|
|
1495
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1496
|
-
source: "hyperline" | "api" | "pennylane" | "chargebee" | "stripe" | "lago" | "sequence" | "other";
|
|
1497
|
-
total_amount: number;
|
|
1498
|
-
amount_due: number;
|
|
1499
|
-
amount_paid: number;
|
|
1500
|
-
amount_fixed: number;
|
|
1501
|
-
amount_excluding_tax: number;
|
|
1502
|
-
tax_rate: number;
|
|
1503
|
-
tax_amount: number;
|
|
1504
|
-
tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
|
|
1505
|
-
discount_amount: number;
|
|
1506
|
-
conversion_rate: number | null;
|
|
1507
|
-
converted_amount: number | null;
|
|
1508
|
-
converted_at: string | null;
|
|
1509
|
-
payment_method_id: string | null;
|
|
1510
|
-
bank_account_id: string | null;
|
|
1511
|
-
custom_note: string | null;
|
|
1512
|
-
additional_info: string | null;
|
|
1513
|
-
footer: string | null;
|
|
1514
|
-
customer: {
|
|
1515
|
-
id: string;
|
|
1516
|
-
name: string;
|
|
1517
|
-
email: string | null;
|
|
1518
|
-
external_id: string | null;
|
|
1519
|
-
vat_number: string | null;
|
|
1520
|
-
address: import("./_types.generated").components["schemas"]["Address"];
|
|
1521
|
-
};
|
|
1522
|
-
seller: {
|
|
1523
|
-
id: string;
|
|
1524
|
-
name: string;
|
|
1525
|
-
tax_id: string | null;
|
|
1526
|
-
address: import("./_types.generated").components["schemas"]["Address"];
|
|
1527
|
-
};
|
|
1528
|
-
subscription_id: string | null;
|
|
1529
|
-
period_starts_at: string | null;
|
|
1530
|
-
period_ends_at: string | null;
|
|
1531
|
-
emitted_at: string;
|
|
1532
|
-
due_at: string;
|
|
1533
|
-
refunded_at: string | null;
|
|
1534
|
-
grace_period_ended_at: string | null;
|
|
1535
|
-
settled_at: string | null;
|
|
1536
|
-
updated_at: string | null;
|
|
1537
|
-
properties: {
|
|
1538
|
-
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
1539
|
-
} | null;
|
|
1540
|
-
line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
|
|
1541
|
-
coupons: import("./_types.generated").components["schemas"]["InvoiceCoupon"][];
|
|
1542
|
-
transactions: ({
|
|
1543
|
-
id: string;
|
|
1544
|
-
type: "subscription" | "one_time" | "refund";
|
|
1545
|
-
amount: number;
|
|
1546
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1547
|
-
customer_id: string;
|
|
1548
|
-
provider_id: string | null;
|
|
1549
|
-
process_at: string;
|
|
1550
|
-
refunded_at: string | null;
|
|
1551
|
-
last_refreshed_at: string | null;
|
|
1552
|
-
provider_fee: {
|
|
1553
|
-
amount: number;
|
|
1554
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1555
|
-
exchange_rate: number | null;
|
|
1556
|
-
} | null;
|
|
1557
|
-
chargeback: {
|
|
1558
|
-
amount: number;
|
|
1559
|
-
last_chargeback_at: string;
|
|
1560
|
-
} | null;
|
|
1561
|
-
} & ({
|
|
1562
|
-
payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1563
|
-
payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
|
|
1564
|
-
} | {
|
|
1565
|
-
payment_method_type: "transfer" | "transfer_automated";
|
|
1566
|
-
bank_account: import("./_types.generated").components["schemas"]["BankAccount"] & (({
|
|
1567
|
-
id: string;
|
|
1568
|
-
currency: "EUR" | "AED" | "AFN" | "XCD" | "ALL" | "AMD" | "AOA" | "ARS" | "USD" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "XOF" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "NOK" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "XAF" | "CHF" | "NZD" | "CLP" | "CNY" | "COP" | "CRC" | "CUP" | "CVE" | "ANG" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "MAD" | "ERN" | "ETB" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "XPF" | "NGN" | "NIO" | "NPR" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "YER" | "ZAR" | "ZMW" | "ZWL";
|
|
1569
|
-
bank_name: string | null;
|
|
1570
|
-
} & ({
|
|
1571
|
-
format: "iban_bic_swift";
|
|
1572
|
-
iban: string;
|
|
1573
|
-
bic_swift: string | null;
|
|
1574
|
-
} | {
|
|
1575
|
-
format: "sort_code_account_number";
|
|
1576
|
-
sort_code: string;
|
|
1577
|
-
account_number: string;
|
|
1578
|
-
} | {
|
|
1579
|
-
format: "account_number_routing_number";
|
|
1580
|
-
account_number: string;
|
|
1581
|
-
routing_number: string;
|
|
1582
|
-
} | {
|
|
1583
|
-
format: "account_number_bic_swift";
|
|
1584
|
-
account_number: string;
|
|
1585
|
-
bic_swift: string;
|
|
1586
|
-
})) | null);
|
|
1587
|
-
} | {
|
|
1588
|
-
payment_method_type: "wallet";
|
|
1589
|
-
wallet_id: string;
|
|
1590
|
-
} | {
|
|
1591
|
-
payment_method_type: "external";
|
|
1592
|
-
}) & ({
|
|
1593
|
-
status: "scheduled" | "to_process" | "pending" | "settled" | "cancelled";
|
|
1594
|
-
} | {
|
|
1595
|
-
status: "failed";
|
|
1596
|
-
error_type: "authentication_required" | "declined" | "fraud" | "insufficient_funds" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
|
|
1597
|
-
error_message: string | null;
|
|
1598
|
-
}))[];
|
|
1599
|
-
} & {
|
|
1600
|
-
integrations: {
|
|
1601
|
-
entity_id: string;
|
|
1602
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1603
|
-
provider_account_id: string;
|
|
1604
|
-
}[];
|
|
1605
|
-
}) | null>;
|
|
1606
|
-
deleteInvoice(id: string): Promise<null | undefined>;
|
|
1607
|
-
getCustomerPaymentMethods(customerId: string): Promise<{
|
|
1608
|
-
meta: {
|
|
1609
|
-
total: number;
|
|
1610
|
-
taken: number;
|
|
1611
|
-
skipped: number;
|
|
1612
|
-
};
|
|
1613
|
-
data: (import("./_types.generated").components["schemas"]["PaymentMethod"] & (import("./_types.generated").components["schemas"]["PaymentMethodCard"] | import("./_types.generated").components["schemas"]["PaymentMethodDirectDebit"] | import("./_types.generated").components["schemas"]["PaymentMethodStripeLink"]))[];
|
|
1614
|
-
} | null>;
|
|
1615
|
-
getPaymentMethod(customerId: string, paymentMethodId: string): Promise<({
|
|
1616
|
-
id: string;
|
|
1617
|
-
} & {
|
|
1618
|
-
status: "active" | "pending";
|
|
1619
|
-
} & {
|
|
1620
|
-
type: "card" | "apple_pay" | "google_pay";
|
|
1621
|
-
last_4_digits: number | null;
|
|
1622
|
-
expiration_date: string | null;
|
|
1623
|
-
brand: string | null;
|
|
1624
|
-
} & {
|
|
1625
|
-
integration: {
|
|
1626
|
-
entity_id: string;
|
|
1627
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1628
|
-
provider_account_id: string;
|
|
1629
|
-
} | null;
|
|
1630
|
-
}) | ({
|
|
1631
|
-
id: string;
|
|
1632
|
-
} & {
|
|
1633
|
-
status: "errored";
|
|
1634
|
-
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
|
|
1635
|
-
} & {
|
|
1636
|
-
type: "card" | "apple_pay" | "google_pay";
|
|
1637
|
-
last_4_digits: number | null;
|
|
1638
|
-
expiration_date: string | null;
|
|
1639
|
-
brand: string | null;
|
|
1640
|
-
} & {
|
|
1641
|
-
integration: {
|
|
1642
|
-
entity_id: string;
|
|
1643
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1644
|
-
provider_account_id: string;
|
|
1645
|
-
} | null;
|
|
1646
|
-
}) | ({
|
|
1647
|
-
id: string;
|
|
1648
|
-
} & {
|
|
1649
|
-
status: "active" | "pending";
|
|
1650
|
-
} & {
|
|
1651
|
-
type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1652
|
-
account_number_ending: string | null;
|
|
1653
|
-
} & {
|
|
1654
|
-
integration: {
|
|
1655
|
-
entity_id: string;
|
|
1656
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1657
|
-
provider_account_id: string;
|
|
1658
|
-
} | null;
|
|
1659
|
-
}) | ({
|
|
1660
|
-
id: string;
|
|
1661
|
-
} & {
|
|
1662
|
-
status: "errored";
|
|
1663
|
-
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
|
|
1664
|
-
} & {
|
|
1665
|
-
type: "direct_debit" | "direct_debit_ach" | "direct_debit_bacs";
|
|
1666
|
-
account_number_ending: string | null;
|
|
1667
|
-
} & {
|
|
1668
|
-
integration: {
|
|
1669
|
-
entity_id: string;
|
|
1670
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1671
|
-
provider_account_id: string;
|
|
1672
|
-
} | null;
|
|
1673
|
-
}) | ({
|
|
1674
|
-
id: string;
|
|
1675
|
-
} & {
|
|
1676
|
-
status: "active" | "pending";
|
|
1677
|
-
} & {
|
|
1678
|
-
type: "stripe_link";
|
|
1679
|
-
} & {
|
|
1680
|
-
integration: {
|
|
1681
|
-
entity_id: string;
|
|
1682
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1683
|
-
provider_account_id: string;
|
|
1684
|
-
} | null;
|
|
1685
|
-
}) | ({
|
|
1686
|
-
id: string;
|
|
1687
|
-
} & {
|
|
1688
|
-
status: "errored";
|
|
1689
|
-
error_type: "authentication_required" | "authorization_error" | "insufficient_funds" | "declined" | "expired" | "fraud" | "invalid" | "not_supported" | "unknown";
|
|
1690
|
-
} & {
|
|
1691
|
-
type: "stripe_link";
|
|
1692
|
-
} & {
|
|
1693
|
-
integration: {
|
|
1694
|
-
entity_id: string;
|
|
1695
|
-
provider_name: "stripe" | "mollie" | "gocardless" | "airwallex" | "salesforce" | "hubspot" | "attio" | "xero" | "pennylane" | "exact-online" | "quickbooks" | "netsuite" | "anrok";
|
|
1696
|
-
provider_account_id: string;
|
|
1697
|
-
} | null;
|
|
1698
|
-
}) | null>;
|
|
1699
|
-
createBillableEvent(data: CreateBillableEvent[]): Promise<BillableEvents | null>;
|
|
1700
|
-
getComponentToken(data: {
|
|
1701
|
-
customer_id: string;
|
|
1702
|
-
}): Promise<{
|
|
1703
|
-
token: string;
|
|
1704
|
-
token_type: "bearer";
|
|
1705
|
-
} | null>;
|
|
1706
|
-
}
|