@vrplatform/hyperline-client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/build/main/_types.generated.d.ts +13431 -0
  2. package/build/main/_types.generated.js +6 -0
  3. package/build/main/_types.generated.js.map +1 -0
  4. package/build/main/index.d.ts +868 -0
  5. package/build/main/index.js +217 -0
  6. package/build/main/index.js.map +1 -0
  7. package/build/main/tsconfig.main.tsbuildinfo +1 -0
  8. package/build/main/tsconfig.tsbuildinfo +1 -0
  9. package/build/module/_types.generated.d.ts +13431 -0
  10. package/build/module/_types.generated.js +6 -0
  11. package/build/module/_types.generated.js.map +1 -0
  12. package/build/module/index.d.ts +868 -0
  13. package/build/module/index.js +219 -0
  14. package/build/module/index.js.map +1 -0
  15. package/build/module/tsconfig.esm.tsbuildinfo +1 -0
  16. package/package.json +37 -0
  17. package/src/_types.generated.ts +13432 -0
  18. package/src/index.ts +443 -0
package/build/module/index.d.ts ADDED
@@ -0,0 +1,868 @@
1
+ import type { components, operations, paths } from './_types.generated';
2
+ export type HyperlineEntities = components['schemas'];
3
+ export type HyperlineEndpoints = paths;
4
+ export declare const webhooks: {
5
+ 'payment_method.created': "hyperline_payment_method_created";
6
+ 'payment_method.errored': "hyperline_payment_method_errored";
7
+ 'payment_method.deleted': "hyperline_payment_method_deleted";
8
+ 'subscription.activated': "hyperline_subscription_status_changed";
9
+ 'subscription.reactivated': "hyperline_subscription_status_changed";
10
+ 'subscription.cancelled': "hyperline_subscription_status_changed";
11
+ 'subscription.cancellation_scheduled': "hyperline_subscription_cancellation_scheduled";
12
+ 'subscription.errored': "hyperline_subscription_status_changed";
13
+ 'subscription.paused': "hyperline_subscription_status_changed";
14
+ 'subscription.voided': "hyperline_subscription_status_changed";
15
+ 'customer.created': "hyperline_customer_created";
16
+ 'customer.updated': "hyperline_customer_updated";
17
+ };
18
+ export type HyperlineWebhook = keyof typeof webhooks;
19
+ export type HyperlineEvent<T extends HyperlineWebhook> = (typeof webhooks)[T];
20
+ export type HyperlinePayload<T extends HyperlineWebhook> = {
21
+ event_type: T;
22
+ data: Record<string, any>;
23
+ };
24
+ export type BillableEvent = {
25
+ record: {
26
+ id: '202408_cus_w_Q7M9bXcHMKB6';
27
+ amount: 26;
28
+ };
29
+ timestamp: '2024-08-07T07:35:20.307Z';
30
+ event_type: 'api_call';
31
+ customer_id: 'cus_w_Q7M9bXcHMKB6';
32
+ };
33
+ export type BillableEvents = {
34
+ events_created: BillableEvent[];
35
+ };
36
+ export type CreateBillableEvent = {
37
+ customer_id: string;
38
+ event_type: 'api_call';
39
+ timestamp: string;
40
+ record: {
41
+ id?: string;
42
+ durationInMs?: number;
43
+ isVerified?: true;
44
+ amount?: number;
45
+ amountGl?: number;
46
+ amountNonGl?: number;
47
+ };
48
+ };
49
+ type Logger = {
50
+ error(message?: any, ...optionalParams: any[]): void;
51
+ };
52
+ export declare class HyperlineAPI {
53
+ constructor(token: string, logger?: Logger);
54
+ private headers;
55
+ private logger;
56
+ private fetchBasic;
57
+ private fetch;
58
+ private fetchIngest;
59
+ getCustomer(id?: string): Promise<({
60
+ id: string;
61
+ name: string;
62
+ type: "corporate" | "person" | "automatically_created" | null;
63
+ status: "active" | "archived";
64
+ currency: components["schemas"]["Currency"] & (string | null);
65
+ country: components["schemas"]["Country"];
66
+ vat_number: string | null;
67
+ vat_number_valid: boolean;
68
+ vat_rate_custom: number | null;
69
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
70
+ timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "America/Adak" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "America/Anchorage" | "Pacific/Gambier" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Phoenix" | "America/Whitehorse" | "America/Belize" | "America/Chicago" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Matamoros" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "America/Winnipeg" | "Pacific/Galapagos" | "America/Rio_Branco" | "America/Bogota" | "America/Havana" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Grand_Turk" | "America/Cayman" | "America/Jamaica" | "America/Nassau" | "America/New_York" | "America/Panama" | "America/Port-au-Prince" | "America/Toronto" | "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/Halifax" | "Atlantic/Bermuda" | "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/Thule" | "America/Curacao" | "America/La_Paz" | "America/Guyana" | "America/Caracas" | "America/St_Johns" | "America/Argentina/Buenos_Aires" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Miquelon" | "America/Paramaribo" | "America/Montevideo" | "America/Scoresbysund" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Nuuk" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Europe/London" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Sao_Tome" | "Africa/Banjul" | "Antarctica/Troll" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Algiers" | "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" | "Africa/Tunis" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "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" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kaliningrad" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Africa/Tripoli" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/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/Darwin" | "Australia/Brisbane" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Adelaide" | "Australia/Sydney" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Australia/Lord_Howe" | "Pacific/Noumea" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Norfolk" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Apia" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Chatham" | "Pacific/Kiritimati" | null;
71
+ external_id: string | null;
72
+ properties: {
73
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
74
+ } | null;
75
+ custom_properties: {
76
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
77
+ } | null;
78
+ billing_address: components["schemas"]["Address"];
79
+ billing_email: string | null;
80
+ invoice_emails: string[];
81
+ invoicing_entity_id: string;
82
+ invoice_reminders_enabled: boolean | ("true" | "false");
83
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
84
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
85
+ current_payment_method_id: string | null;
86
+ custom_payment_delay: number | null;
87
+ subscriptions: {
88
+ id: string;
89
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
90
+ current_period_started_at: string | null;
91
+ current_period_ends_at: string | null;
92
+ plan_id: string | null;
93
+ checkout_session_id: string | null;
94
+ }[];
95
+ created_at: components["schemas"]["DateTime"] & string;
96
+ updated_at: components["schemas"]["DateTime"] & string;
97
+ deleted_at: components["schemas"]["DateTime"] & unknown;
98
+ } & {
99
+ providers: {
100
+ gocardless?: string;
101
+ mollie?: string;
102
+ stripe?: string;
103
+ hubspot?: string;
104
+ salesforce?: string;
105
+ };
106
+ current_payment_method: components["schemas"]["PaymentMethod"] & unknown;
107
+ bank_account: components["schemas"]["BankAccount"];
108
+ organisation_id: string | null;
109
+ organisation_invoicing: "none" | "every_invoice" | "concat" | null;
110
+ }) | null>;
111
+ getCustomers(skip?: number, take?: number): Promise<{
112
+ meta: {
113
+ total: number;
114
+ taken: number;
115
+ skipped: number;
116
+ };
117
+ data: components["schemas"]["Customer"][];
118
+ } | null>;
119
+ getAllCustomers(items?: paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']): Promise<paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']>;
120
+ createCustomer(data: NonNullable<paths['/v1/customers']['post']['requestBody']>['content']['application/json']): Promise<({
121
+ id: string;
122
+ name: string;
123
+ type: "corporate" | "person" | "automatically_created" | null;
124
+ status: "active" | "archived";
125
+ currency: components["schemas"]["Currency"] & (string | null);
126
+ country: components["schemas"]["Country"];
127
+ vat_number: string | null;
128
+ vat_number_valid: boolean;
129
+ vat_rate_custom: number | null;
130
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
131
+ timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "America/Adak" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "America/Anchorage" | "Pacific/Gambier" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Phoenix" | "America/Whitehorse" | "America/Belize" | "America/Chicago" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Matamoros" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "America/Winnipeg" | "Pacific/Galapagos" | "America/Rio_Branco" | "America/Bogota" | "America/Havana" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Grand_Turk" | "America/Cayman" | "America/Jamaica" | "America/Nassau" | "America/New_York" | "America/Panama" | "America/Port-au-Prince" | "America/Toronto" | "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/Halifax" | "Atlantic/Bermuda" | "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/Thule" | "America/Curacao" | "America/La_Paz" | "America/Guyana" | "America/Caracas" | "America/St_Johns" | "America/Argentina/Buenos_Aires" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Miquelon" | "America/Paramaribo" | "America/Montevideo" | "America/Scoresbysund" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Nuuk" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Europe/London" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Sao_Tome" | "Africa/Banjul" | "Antarctica/Troll" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Algiers" | "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" | "Africa/Tunis" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "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" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kaliningrad" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Africa/Tripoli" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/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/Darwin" | "Australia/Brisbane" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Adelaide" | "Australia/Sydney" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Australia/Lord_Howe" | "Pacific/Noumea" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Norfolk" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Apia" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Chatham" | "Pacific/Kiritimati" | null;
132
+ external_id: string | null;
133
+ properties: {
134
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
135
+ } | null;
136
+ custom_properties: {
137
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
138
+ } | null;
139
+ billing_address: components["schemas"]["Address"];
140
+ billing_email: string | null;
141
+ invoice_emails: string[];
142
+ invoicing_entity_id: string;
143
+ invoice_reminders_enabled: boolean | ("true" | "false");
144
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
145
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
146
+ current_payment_method_id: string | null;
147
+ custom_payment_delay: number | null;
148
+ subscriptions: {
149
+ id: string;
150
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
151
+ current_period_started_at: string | null;
152
+ current_period_ends_at: string | null;
153
+ plan_id: string | null;
154
+ checkout_session_id: string | null;
155
+ }[];
156
+ created_at: components["schemas"]["DateTime"] & string;
157
+ updated_at: components["schemas"]["DateTime"] & string;
158
+ deleted_at: components["schemas"]["DateTime"] & unknown;
159
+ } & {
160
+ providers: {
161
+ gocardless?: string;
162
+ mollie?: string;
163
+ stripe?: string;
164
+ hubspot?: string;
165
+ salesforce?: string;
166
+ };
167
+ current_payment_method: components["schemas"]["PaymentMethod"] & unknown;
168
+ bank_account: components["schemas"]["BankAccount"];
169
+ organisation_id: string | null;
170
+ organisation_invoicing: "none" | "every_invoice" | "concat" | null;
171
+ }) | null>;
172
+ updateCustomer(id: string, data: NonNullable<paths['/v1/customers/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
173
+ id: string;
174
+ name: string;
175
+ type: "corporate" | "person" | "automatically_created" | null;
176
+ status: "active" | "archived";
177
+ currency: components["schemas"]["Currency"] & (string | null);
178
+ country: components["schemas"]["Country"];
179
+ vat_number: string | null;
180
+ vat_number_valid: boolean;
181
+ vat_rate_custom: number | null;
182
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
183
+ timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "America/Adak" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "America/Anchorage" | "Pacific/Gambier" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Phoenix" | "America/Whitehorse" | "America/Belize" | "America/Chicago" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Matamoros" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "America/Winnipeg" | "Pacific/Galapagos" | "America/Rio_Branco" | "America/Bogota" | "America/Havana" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Grand_Turk" | "America/Cayman" | "America/Jamaica" | "America/Nassau" | "America/New_York" | "America/Panama" | "America/Port-au-Prince" | "America/Toronto" | "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/Halifax" | "Atlantic/Bermuda" | "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/Thule" | "America/Curacao" | "America/La_Paz" | "America/Guyana" | "America/Caracas" | "America/St_Johns" | "America/Argentina/Buenos_Aires" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Miquelon" | "America/Paramaribo" | "America/Montevideo" | "America/Scoresbysund" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Nuuk" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Europe/London" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Sao_Tome" | "Africa/Banjul" | "Antarctica/Troll" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Algiers" | "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" | "Africa/Tunis" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "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" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kaliningrad" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Africa/Tripoli" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/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/Darwin" | "Australia/Brisbane" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Adelaide" | "Australia/Sydney" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Australia/Lord_Howe" | "Pacific/Noumea" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Norfolk" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Apia" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Chatham" | "Pacific/Kiritimati" | null;
184
+ external_id: string | null;
185
+ properties: {
186
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
187
+ } | null;
188
+ custom_properties: {
189
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
190
+ } | null;
191
+ billing_address: components["schemas"]["Address"];
192
+ billing_email: string | null;
193
+ invoice_emails: string[];
194
+ invoicing_entity_id: string;
195
+ invoice_reminders_enabled: boolean | ("true" | "false");
196
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
197
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
198
+ current_payment_method_id: string | null;
199
+ custom_payment_delay: number | null;
200
+ subscriptions: {
201
+ id: string;
202
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
203
+ current_period_started_at: string | null;
204
+ current_period_ends_at: string | null;
205
+ plan_id: string | null;
206
+ checkout_session_id: string | null;
207
+ }[];
208
+ created_at: components["schemas"]["DateTime"] & string;
209
+ updated_at: components["schemas"]["DateTime"] & string;
210
+ deleted_at: components["schemas"]["DateTime"] & unknown;
211
+ } & {
212
+ providers: {
213
+ gocardless?: string;
214
+ mollie?: string;
215
+ stripe?: string;
216
+ hubspot?: string;
217
+ salesforce?: string;
218
+ };
219
+ current_payment_method: components["schemas"]["PaymentMethod"] & unknown;
220
+ bank_account: components["schemas"]["BankAccount"];
221
+ organisation_id: string | null;
222
+ organisation_invoicing: "none" | "every_invoice" | "concat" | null;
223
+ }) | null>;
224
+ deleteCustomer(id: string): Promise<null | undefined>;
225
+ archiveCustomer(id: string): Promise<{
226
+ id: string;
227
+ name: string;
228
+ type: "corporate" | "person" | "automatically_created" | null;
229
+ status: "active" | "archived";
230
+ currency: components["schemas"]["Currency"] & (string | null);
231
+ country: components["schemas"]["Country"];
232
+ vat_number: string | null;
233
+ vat_number_valid: boolean;
234
+ vat_rate_custom: number | null;
235
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
236
+ timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "America/Adak" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "America/Anchorage" | "Pacific/Gambier" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Phoenix" | "America/Whitehorse" | "America/Belize" | "America/Chicago" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Matamoros" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "America/Winnipeg" | "Pacific/Galapagos" | "America/Rio_Branco" | "America/Bogota" | "America/Havana" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Grand_Turk" | "America/Cayman" | "America/Jamaica" | "America/Nassau" | "America/New_York" | "America/Panama" | "America/Port-au-Prince" | "America/Toronto" | "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/Halifax" | "Atlantic/Bermuda" | "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/Thule" | "America/Curacao" | "America/La_Paz" | "America/Guyana" | "America/Caracas" | "America/St_Johns" | "America/Argentina/Buenos_Aires" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Miquelon" | "America/Paramaribo" | "America/Montevideo" | "America/Scoresbysund" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Nuuk" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Europe/London" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Sao_Tome" | "Africa/Banjul" | "Antarctica/Troll" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Algiers" | "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" | "Africa/Tunis" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "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" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kaliningrad" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Africa/Tripoli" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/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/Darwin" | "Australia/Brisbane" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Adelaide" | "Australia/Sydney" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Australia/Lord_Howe" | "Pacific/Noumea" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Norfolk" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Apia" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Chatham" | "Pacific/Kiritimati" | null;
237
+ external_id: string | null;
238
+ properties: {
239
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
240
+ } | null;
241
+ custom_properties: {
242
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
243
+ } | null;
244
+ billing_address: components["schemas"]["Address"];
245
+ billing_email: string | null;
246
+ invoice_emails: string[];
247
+ invoicing_entity_id: string;
248
+ invoice_reminders_enabled: boolean | ("true" | "false");
249
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
250
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
251
+ current_payment_method_id: string | null;
252
+ custom_payment_delay: number | null;
253
+ subscriptions: {
254
+ id: string;
255
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
256
+ current_period_started_at: string | null;
257
+ current_period_ends_at: string | null;
258
+ plan_id: string | null;
259
+ checkout_session_id: string | null;
260
+ }[];
261
+ created_at: components["schemas"]["DateTime"] & string;
262
+ updated_at: components["schemas"]["DateTime"] & string;
263
+ deleted_at: components["schemas"]["DateTime"] & unknown;
264
+ } | null>;
265
+ unarchiveCustomer(id: string): Promise<{
266
+ id: string;
267
+ name: string;
268
+ type: "corporate" | "person" | "automatically_created" | null;
269
+ status: "active" | "archived";
270
+ currency: components["schemas"]["Currency"] & (string | null);
271
+ country: components["schemas"]["Country"];
272
+ vat_number: string | null;
273
+ vat_number_valid: boolean;
274
+ vat_rate_custom: number | null;
275
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
276
+ timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "America/Adak" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "America/Anchorage" | "Pacific/Gambier" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Phoenix" | "America/Whitehorse" | "America/Belize" | "America/Chicago" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Matamoros" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "America/Winnipeg" | "Pacific/Galapagos" | "America/Rio_Branco" | "America/Bogota" | "America/Havana" | "Pacific/Easter" | "America/Atikokan" | "America/Cancun" | "America/Grand_Turk" | "America/Cayman" | "America/Jamaica" | "America/Nassau" | "America/New_York" | "America/Panama" | "America/Port-au-Prince" | "America/Toronto" | "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/Halifax" | "Atlantic/Bermuda" | "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/Thule" | "America/Curacao" | "America/La_Paz" | "America/Guyana" | "America/Caracas" | "America/St_Johns" | "America/Argentina/Buenos_Aires" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "America/Santiago" | "Atlantic/Stanley" | "America/Cayenne" | "America/Asuncion" | "America/Miquelon" | "America/Paramaribo" | "America/Montevideo" | "America/Scoresbysund" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Nuuk" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Europe/London" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Sao_Tome" | "Africa/Banjul" | "Antarctica/Troll" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Algiers" | "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" | "Africa/Tunis" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "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" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kaliningrad" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Africa/Tripoli" | "Europe/Vilnius" | "Asia/Jerusalem" | "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/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/Darwin" | "Australia/Brisbane" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Adelaide" | "Australia/Sydney" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Australia/Lord_Howe" | "Pacific/Noumea" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Norfolk" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Apia" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Chatham" | "Pacific/Kiritimati" | null;
277
+ external_id: string | null;
278
+ properties: {
279
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
280
+ } | null;
281
+ custom_properties: {
282
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
283
+ } | null;
284
+ billing_address: components["schemas"]["Address"];
285
+ billing_email: string | null;
286
+ invoice_emails: string[];
287
+ invoicing_entity_id: string;
288
+ invoice_reminders_enabled: boolean | ("true" | "false");
289
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
290
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
291
+ current_payment_method_id: string | null;
292
+ custom_payment_delay: number | null;
293
+ subscriptions: {
294
+ id: string;
295
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
296
+ current_period_started_at: string | null;
297
+ current_period_ends_at: string | null;
298
+ plan_id: string | null;
299
+ checkout_session_id: string | null;
300
+ }[];
301
+ created_at: components["schemas"]["DateTime"] & string;
302
+ updated_at: components["schemas"]["DateTime"] & string;
303
+ deleted_at: components["schemas"]["DateTime"] & unknown;
304
+ } | null>;
305
+ getCustomerPortal(id: string): Promise<{
306
+ url: string;
307
+ } | null>;
308
+ getSubscription(id: string): Promise<({
309
+ id: string;
310
+ currency: components["schemas"]["Currency"];
311
+ status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
312
+ purchase_order: string | null;
313
+ customer_id: string;
314
+ plan_id: string | null;
315
+ invoicing_entity_id: string;
316
+ checkout_session_id: string | null;
317
+ crm_opportunity_id: string | null;
318
+ minimum_invoice_fee: number | null;
319
+ commitment_interval: {
320
+ period: "days" | "weeks" | "months" | "years";
321
+ count: number;
322
+ } | null;
323
+ renew_automatically: boolean;
324
+ renew_for: {
325
+ period: "days" | "weeks" | "months" | "years";
326
+ count: number;
327
+ } | null;
328
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
329
+ starts_at: components["schemas"]["DateTime"] & string;
330
+ contract_start: components["schemas"]["DateTime"] & string;
331
+ contract_end: components["schemas"]["DateTime"] & unknown;
332
+ initial_billing_at: components["schemas"]["DateTime"] & unknown;
333
+ paused_at: components["schemas"]["DateTime"] & unknown;
334
+ reactivate_at: components["schemas"]["DateTime"] & unknown;
335
+ cancel_at: components["schemas"]["DateTime"] & unknown;
336
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
337
+ cancellation_amount: components["schemas"]["Amount"] & (number | null);
338
+ estimated_arr: components["schemas"]["Amount"] & (number | null);
339
+ current_period_started_at: components["schemas"]["DateTime"] & unknown;
340
+ current_period_ends_at: components["schemas"]["DateTime"] & unknown;
341
+ next_payment_at: components["schemas"]["DateTime"] & unknown;
342
+ next_payment_amount: components["schemas"]["Amount"] & (number | null);
343
+ renews_at: components["schemas"]["DateTime"] & unknown;
344
+ current_phase_id: string | null;
345
+ trial_ends_at: components["schemas"]["DateTime"] & unknown;
346
+ properties: {
347
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
348
+ } | null;
349
+ custom_properties: {
350
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
351
+ } | null;
352
+ created_at: components["schemas"]["DateTime"] & string;
353
+ updated_at: components["schemas"]["DateTime"] & string;
354
+ } & {
355
+ products: (components["schemas"]["SubscriptionProductFee"] | components["schemas"]["SubscriptionProductCredit"] | components["schemas"]["SubscriptionProductSeat"] | components["schemas"]["SubscriptionProductDynamic"])[];
356
+ coupons: (({
357
+ description: string | null;
358
+ created_at: components["schemas"]["DateTime"] & string;
359
+ type: "amount";
360
+ discount_amount: components["schemas"]["Amount"] & unknown;
361
+ currency: components["schemas"]["Currency"] & (string | null);
362
+ } | {
363
+ description: string | null;
364
+ created_at: components["schemas"]["DateTime"] & string;
365
+ type: "percent";
366
+ discount_percent: number;
367
+ }) & {
368
+ id: string | null;
369
+ name: string | null;
370
+ subscription_coupon_id: string;
371
+ repeat: "once" | "forever" | "custom";
372
+ product_ids: string[];
373
+ apply_at: components["schemas"]["DateTime"] & unknown;
374
+ expires_at: components["schemas"]["DateTime"] & unknown;
375
+ })[];
376
+ quote: {
377
+ id: string;
378
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
379
+ } | null;
380
+ plan: {
381
+ id: string;
382
+ name: string;
383
+ } | null;
384
+ checkout_session: components["schemas"]["CheckoutSession"];
385
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
386
+ payment_method: components["schemas"]["PaymentMethod"] & unknown;
387
+ generate_draft_invoices: boolean;
388
+ } & {
389
+ live_billing?: components["schemas"]["LiveBilling"];
390
+ }) | null>;
391
+ getSubscriptions(skip?: number, take?: number, query?: operations['getSubscriptions']['parameters']['query']): Promise<{
392
+ meta: {
393
+ total: number;
394
+ taken: number;
395
+ skipped: number;
396
+ };
397
+ data: components["schemas"]["Subscription"][];
398
+ } | null>;
399
+ 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']>;
400
+ createSubscription(data: NonNullable<paths['/v2/subscriptions']['post']['requestBody']>['content']['application/json']): Promise<({
401
+ id: string;
402
+ currency: components["schemas"]["Currency"];
403
+ status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
404
+ purchase_order: string | null;
405
+ customer_id: string;
406
+ plan_id: string | null;
407
+ invoicing_entity_id: string;
408
+ checkout_session_id: string | null;
409
+ crm_opportunity_id: string | null;
410
+ minimum_invoice_fee: number | null;
411
+ commitment_interval: {
412
+ period: "days" | "weeks" | "months" | "years";
413
+ count: number;
414
+ } | null;
415
+ renew_automatically: boolean;
416
+ renew_for: {
417
+ period: "days" | "weeks" | "months" | "years";
418
+ count: number;
419
+ } | null;
420
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
421
+ starts_at: components["schemas"]["DateTime"] & string;
422
+ contract_start: components["schemas"]["DateTime"] & string;
423
+ contract_end: components["schemas"]["DateTime"] & unknown;
424
+ initial_billing_at: components["schemas"]["DateTime"] & unknown;
425
+ paused_at: components["schemas"]["DateTime"] & unknown;
426
+ reactivate_at: components["schemas"]["DateTime"] & unknown;
427
+ cancel_at: components["schemas"]["DateTime"] & unknown;
428
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
429
+ cancellation_amount: components["schemas"]["Amount"] & (number | null);
430
+ estimated_arr: components["schemas"]["Amount"] & (number | null);
431
+ current_period_started_at: components["schemas"]["DateTime"] & unknown;
432
+ current_period_ends_at: components["schemas"]["DateTime"] & unknown;
433
+ next_payment_at: components["schemas"]["DateTime"] & unknown;
434
+ next_payment_amount: components["schemas"]["Amount"] & (number | null);
435
+ renews_at: components["schemas"]["DateTime"] & unknown;
436
+ current_phase_id: string | null;
437
+ trial_ends_at: components["schemas"]["DateTime"] & unknown;
438
+ properties: {
439
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
440
+ } | null;
441
+ custom_properties: {
442
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
443
+ } | null;
444
+ created_at: components["schemas"]["DateTime"] & string;
445
+ updated_at: components["schemas"]["DateTime"] & string;
446
+ } & {
447
+ products: (components["schemas"]["SubscriptionProductFee"] | components["schemas"]["SubscriptionProductCredit"] | components["schemas"]["SubscriptionProductSeat"] | components["schemas"]["SubscriptionProductDynamic"])[];
448
+ coupons: (({
449
+ description: string | null;
450
+ created_at: components["schemas"]["DateTime"] & string;
451
+ type: "amount";
452
+ discount_amount: components["schemas"]["Amount"] & unknown;
453
+ currency: components["schemas"]["Currency"] & (string | null);
454
+ } | {
455
+ description: string | null;
456
+ created_at: components["schemas"]["DateTime"] & string;
457
+ type: "percent";
458
+ discount_percent: number;
459
+ }) & {
460
+ id: string | null;
461
+ name: string | null;
462
+ subscription_coupon_id: string;
463
+ repeat: "once" | "forever" | "custom";
464
+ product_ids: string[];
465
+ apply_at: components["schemas"]["DateTime"] & unknown;
466
+ expires_at: components["schemas"]["DateTime"] & unknown;
467
+ })[];
468
+ quote: {
469
+ id: string;
470
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
471
+ } | null;
472
+ plan: {
473
+ id: string;
474
+ name: string;
475
+ } | null;
476
+ checkout_session: components["schemas"]["CheckoutSession"];
477
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
478
+ payment_method: components["schemas"]["PaymentMethod"] & unknown;
479
+ generate_draft_invoices: boolean;
480
+ }) | null>;
481
+ updateSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update']['post']['requestBody']>['content']['application/json']): Promise<{
482
+ id: string;
483
+ } | null>;
484
+ cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
485
+ id: string;
486
+ currency: components["schemas"]["Currency"];
487
+ status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
488
+ purchase_order: string | null;
489
+ customer_id: string;
490
+ plan_id: string | null;
491
+ invoicing_entity_id: string;
492
+ checkout_session_id: string | null;
493
+ crm_opportunity_id: string | null;
494
+ minimum_invoice_fee: number | null;
495
+ commitment_interval: {
496
+ period: "days" | "weeks" | "months" | "years";
497
+ count: number;
498
+ } | null;
499
+ renew_automatically: boolean;
500
+ renew_for: {
501
+ period: "days" | "weeks" | "months" | "years";
502
+ count: number;
503
+ } | null;
504
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
505
+ starts_at: components["schemas"]["DateTime"] & string;
506
+ contract_start: components["schemas"]["DateTime"] & string;
507
+ contract_end: components["schemas"]["DateTime"] & unknown;
508
+ initial_billing_at: components["schemas"]["DateTime"] & unknown;
509
+ paused_at: components["schemas"]["DateTime"] & unknown;
510
+ reactivate_at: components["schemas"]["DateTime"] & unknown;
511
+ cancel_at: components["schemas"]["DateTime"] & unknown;
512
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
513
+ cancellation_amount: components["schemas"]["Amount"] & (number | null);
514
+ estimated_arr: components["schemas"]["Amount"] & (number | null);
515
+ current_period_started_at: components["schemas"]["DateTime"] & unknown;
516
+ current_period_ends_at: components["schemas"]["DateTime"] & unknown;
517
+ next_payment_at: components["schemas"]["DateTime"] & unknown;
518
+ next_payment_amount: components["schemas"]["Amount"] & (number | null);
519
+ renews_at: components["schemas"]["DateTime"] & unknown;
520
+ current_phase_id: string | null;
521
+ trial_ends_at: components["schemas"]["DateTime"] & unknown;
522
+ properties: {
523
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
524
+ } | null;
525
+ custom_properties: {
526
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
527
+ } | null;
528
+ created_at: components["schemas"]["DateTime"] & string;
529
+ updated_at: components["schemas"]["DateTime"] & string;
530
+ } & {
531
+ products: (components["schemas"]["SubscriptionProductFee"] | components["schemas"]["SubscriptionProductCredit"] | components["schemas"]["SubscriptionProductSeat"] | components["schemas"]["SubscriptionProductDynamic"])[];
532
+ coupons: (({
533
+ description: string | null;
534
+ created_at: components["schemas"]["DateTime"] & string;
535
+ type: "amount";
536
+ discount_amount: components["schemas"]["Amount"] & unknown;
537
+ currency: components["schemas"]["Currency"] & (string | null);
538
+ } | {
539
+ description: string | null;
540
+ created_at: components["schemas"]["DateTime"] & string;
541
+ type: "percent";
542
+ discount_percent: number;
543
+ }) & {
544
+ id: string | null;
545
+ name: string | null;
546
+ subscription_coupon_id: string;
547
+ repeat: "once" | "forever" | "custom";
548
+ product_ids: string[];
549
+ apply_at: components["schemas"]["DateTime"] & unknown;
550
+ expires_at: components["schemas"]["DateTime"] & unknown;
551
+ })[];
552
+ quote: {
553
+ id: string;
554
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
555
+ } | null;
556
+ plan: {
557
+ id: string;
558
+ name: string;
559
+ } | null;
560
+ checkout_session: components["schemas"]["CheckoutSession"];
561
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
562
+ payment_method: components["schemas"]["PaymentMethod"] & unknown;
563
+ generate_draft_invoices: boolean;
564
+ }) | null>;
565
+ reinstateSubscription(id: string): Promise<({
566
+ id: string;
567
+ currency: components["schemas"]["Currency"];
568
+ status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
569
+ purchase_order: string | null;
570
+ customer_id: string;
571
+ plan_id: string | null;
572
+ invoicing_entity_id: string;
573
+ checkout_session_id: string | null;
574
+ crm_opportunity_id: string | null;
575
+ minimum_invoice_fee: number | null;
576
+ commitment_interval: {
577
+ period: "days" | "weeks" | "months" | "years";
578
+ count: number;
579
+ } | null;
580
+ renew_automatically: boolean;
581
+ renew_for: {
582
+ period: "days" | "weeks" | "months" | "years";
583
+ count: number;
584
+ } | null;
585
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
586
+ starts_at: components["schemas"]["DateTime"] & string;
587
+ contract_start: components["schemas"]["DateTime"] & string;
588
+ contract_end: components["schemas"]["DateTime"] & unknown;
589
+ initial_billing_at: components["schemas"]["DateTime"] & unknown;
590
+ paused_at: components["schemas"]["DateTime"] & unknown;
591
+ reactivate_at: components["schemas"]["DateTime"] & unknown;
592
+ cancel_at: components["schemas"]["DateTime"] & unknown;
593
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
594
+ cancellation_amount: components["schemas"]["Amount"] & (number | null);
595
+ estimated_arr: components["schemas"]["Amount"] & (number | null);
596
+ current_period_started_at: components["schemas"]["DateTime"] & unknown;
597
+ current_period_ends_at: components["schemas"]["DateTime"] & unknown;
598
+ next_payment_at: components["schemas"]["DateTime"] & unknown;
599
+ next_payment_amount: components["schemas"]["Amount"] & (number | null);
600
+ renews_at: components["schemas"]["DateTime"] & unknown;
601
+ current_phase_id: string | null;
602
+ trial_ends_at: components["schemas"]["DateTime"] & unknown;
603
+ properties: {
604
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
605
+ } | null;
606
+ custom_properties: {
607
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
608
+ } | null;
609
+ created_at: components["schemas"]["DateTime"] & string;
610
+ updated_at: components["schemas"]["DateTime"] & string;
611
+ } & {
612
+ products: (components["schemas"]["SubscriptionProductFee"] | components["schemas"]["SubscriptionProductCredit"] | components["schemas"]["SubscriptionProductSeat"] | components["schemas"]["SubscriptionProductDynamic"])[];
613
+ coupons: (({
614
+ description: string | null;
615
+ created_at: components["schemas"]["DateTime"] & string;
616
+ type: "amount";
617
+ discount_amount: components["schemas"]["Amount"] & unknown;
618
+ currency: components["schemas"]["Currency"] & (string | null);
619
+ } | {
620
+ description: string | null;
621
+ created_at: components["schemas"]["DateTime"] & string;
622
+ type: "percent";
623
+ discount_percent: number;
624
+ }) & {
625
+ id: string | null;
626
+ name: string | null;
627
+ subscription_coupon_id: string;
628
+ repeat: "once" | "forever" | "custom";
629
+ product_ids: string[];
630
+ apply_at: components["schemas"]["DateTime"] & unknown;
631
+ expires_at: components["schemas"]["DateTime"] & unknown;
632
+ })[];
633
+ quote: {
634
+ id: string;
635
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
636
+ } | null;
637
+ plan: {
638
+ id: string;
639
+ name: string;
640
+ } | null;
641
+ checkout_session: components["schemas"]["CheckoutSession"];
642
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
643
+ payment_method: components["schemas"]["PaymentMethod"] & unknown;
644
+ generate_draft_invoices: boolean;
645
+ }) | null>;
646
+ getPlan(id: string): Promise<{
647
+ id: string;
648
+ name: string;
649
+ description: string | null;
650
+ commitment_interval: {
651
+ period: "days" | "weeks" | "months" | "years";
652
+ count: number;
653
+ } | null;
654
+ contract_start_strategy: "start_date" | "immediately" | "manual" | "manual_with_latest" | "quote_signature" | "checkout";
655
+ contract_start: components["schemas"]["DateTime"] & unknown;
656
+ contract_end_strategy: "duration" | "manual" | "end_date";
657
+ contract_end: components["schemas"]["DateTime"] & unknown;
658
+ contract_duration: {
659
+ period: "days" | "weeks" | "months" | "years" | "forever";
660
+ count: number | null;
661
+ } | null;
662
+ renew_automatically: boolean;
663
+ renew_for: {
664
+ period: "days" | "weeks" | "months" | "years";
665
+ count: number | null;
666
+ } | null;
667
+ trial_interval: {
668
+ period: "days" | "weeks" | "months" | "years";
669
+ count: number;
670
+ } | null;
671
+ products: ({
672
+ id: string;
673
+ name: string;
674
+ description: string | null;
675
+ description_display_interval_dates: boolean;
676
+ payment_interval: {
677
+ period: "once";
678
+ } | {
679
+ period: "days" | "weeks" | "months" | "years";
680
+ count: number;
681
+ } | null;
682
+ payment_schedule: "start" | "end" | null;
683
+ type: "flat_fee";
684
+ prices: components["schemas"]["PriceFee"][];
685
+ } | {
686
+ id: string;
687
+ name: string;
688
+ description: string | null;
689
+ description_display_interval_dates: boolean;
690
+ payment_interval: {
691
+ period: "once";
692
+ } | {
693
+ period: "days" | "weeks" | "months" | "years";
694
+ count: number;
695
+ } | null;
696
+ payment_schedule: "start" | "end" | null;
697
+ type: "seat";
698
+ unit_name: string | null;
699
+ prices: (components["schemas"]["PriceVolume"] | components["schemas"]["PricePackaged"] | components["schemas"]["PriceBulk"])[];
700
+ } | {
701
+ id: string;
702
+ name: string;
703
+ description: string | null;
704
+ description_display_interval_dates: boolean;
705
+ payment_interval: {
706
+ period: "once";
707
+ } | {
708
+ period: "days" | "weeks" | "months" | "years";
709
+ count: number;
710
+ } | null;
711
+ payment_schedule: "start" | "end" | null;
712
+ type: "dynamic";
713
+ unit_name: string | null;
714
+ min_committed_count: number | null;
715
+ min_amount: number | null;
716
+ max_amount: number | null;
717
+ metering_interval_type: "subscription_commitment" | "payment_interval" | "full_database" | "phase_duration" | null;
718
+ bill_usage_difference: boolean;
719
+ prices: ((components["schemas"]["PriceVolume"] | components["schemas"]["PricePackaged"] | components["schemas"]["PriceBulk"] | components["schemas"]["PriceBps"]) & {
720
+ metering_filter: components["schemas"]["MeteringFilter"];
721
+ })[];
722
+ } | {
723
+ id: string;
724
+ name: string;
725
+ description: string | null;
726
+ description_display_interval_dates: boolean;
727
+ payment_interval: {
728
+ period: "once";
729
+ } | {
730
+ period: "days" | "weeks" | "months" | "years";
731
+ count: number;
732
+ } | null;
733
+ payment_schedule: "start" | "end" | null;
734
+ type: "credit";
735
+ unit_name: string | null;
736
+ count: number;
737
+ prices: components["schemas"]["PriceFee"][];
738
+ })[];
739
+ custom_properties: {
740
+ [key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
741
+ } | null;
742
+ } | null>;
743
+ getPlans(skip?: number, take?: number): Promise<{
744
+ meta: {
745
+ total: number;
746
+ taken: number;
747
+ skipped: number;
748
+ };
749
+ data: components["schemas"]["PlanSimple"][];
750
+ } | null>;
751
+ getInvoice(id: string): Promise<({
752
+ id: string;
753
+ number: string;
754
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
755
+ document_name: string | null;
756
+ status: "draft" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "late" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat";
757
+ reference: string | null;
758
+ purchase_order: string | null;
759
+ original_invoice_id: string | null;
760
+ original_invoice_number: string | null;
761
+ currency: components["schemas"]["Currency"];
762
+ total_amount: components["schemas"]["Amount"];
763
+ amount_due: components["schemas"]["Amount"] & unknown;
764
+ amount_paid: components["schemas"]["Amount"] & unknown;
765
+ amount_fixed: components["schemas"]["Amount"] & unknown;
766
+ amount_excluding_tax: components["schemas"]["Amount"] & unknown;
767
+ tax_rate: number;
768
+ tax_amount: components["schemas"]["Amount"] & unknown;
769
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
770
+ discount_amount: components["schemas"]["Amount"] & unknown;
771
+ conversion_rate: number | null;
772
+ converted_amount: components["schemas"]["Amount"] & (number | null);
773
+ converted_at: components["schemas"]["DateTime"];
774
+ payment_method_id: string | null;
775
+ attempt_count: number;
776
+ custom_note: string | null;
777
+ customer: {
778
+ id: string;
779
+ name: string;
780
+ email: string | null;
781
+ external_id: string | null;
782
+ vat_number: string | null;
783
+ address: components["schemas"]["Address"];
784
+ };
785
+ seller: {
786
+ id: string;
787
+ name: string;
788
+ tax_id: string | null;
789
+ address: components["schemas"]["Address"] & unknown;
790
+ };
791
+ subscription_id: string | null;
792
+ period_starts_at: components["schemas"]["DateTime"] & unknown;
793
+ period_ends_at: components["schemas"]["DateTime"] & unknown;
794
+ emitted_at: components["schemas"]["DateTime"] & string;
795
+ due_at: components["schemas"]["DateTime"] & string;
796
+ refunded_at: components["schemas"]["DateTime"] & unknown;
797
+ grace_period_ended_at: components["schemas"]["DateTime"] & unknown;
798
+ settled_at: components["schemas"]["DateTime"] & unknown;
799
+ updated_at: components["schemas"]["DateTime"] & unknown;
800
+ line_items: components["schemas"]["InvoiceLineItem"][];
801
+ } & {
802
+ transactions: ({
803
+ id: string;
804
+ type: "subscription" | "one_time" | "refund";
805
+ amount: components["schemas"]["Amount"] & unknown;
806
+ currency: components["schemas"]["Currency"] & unknown;
807
+ customer_id: string;
808
+ provider_id: string | null;
809
+ process_at: components["schemas"]["DateTime"] & string;
810
+ refunded_at: components["schemas"]["DateTime"] & unknown;
811
+ last_refreshed_at: components["schemas"]["DateTime"] & unknown;
812
+ } & ({
813
+ payment_method_type: "card" | "transfer" | "transfer_automated" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "external";
814
+ payment_method: components["schemas"]["PaymentMethod"];
815
+ } | {
816
+ payment_method_type: "wallet";
817
+ wallet_id: string;
818
+ }) & ({
819
+ status: "to_process" | "pending" | "settled" | "cancelled" | "scheduled";
820
+ } | {
821
+ status: "failed";
822
+ error_type: "authentication_required" | "declined" | "fraud" | "payment_method_authorization_error" | "payment_method_declined" | "payment_method_expired" | "payment_method_invalid" | "payment_method_not_supported" | "processing_error" | "provider_error" | "unknown" | null;
823
+ error_message: string | null;
824
+ }))[];
825
+ coupons: {
826
+ id: string | null;
827
+ name: string | null;
828
+ discount_amount: components["schemas"]["Amount"] & (number | null);
829
+ discount_percent: number | null;
830
+ line_item_ids: string[];
831
+ }[];
832
+ }) | null>;
833
+ getInvoices(skip?: number, take?: number, query?: operations['getInvoices']['parameters']['query']): Promise<{
834
+ meta: {
835
+ total: number;
836
+ taken: number;
837
+ skipped: number;
838
+ };
839
+ data: components["schemas"]["Invoice"][];
840
+ } | null>;
841
+ getInvoicesByCustomerId(id: string): Promise<{
842
+ meta: {
843
+ total: number;
844
+ taken: number;
845
+ skipped: number;
846
+ };
847
+ data: components["schemas"]["Invoice"][];
848
+ } | null>;
849
+ getInvoiceDownload(id: string): Promise<string | null>;
850
+ getAllInvoices(items?: paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']): Promise<paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']>;
851
+ createBillableEvent(data: CreateBillableEvent[]): Promise<BillableEvents | null>;
852
+ getComponentToken(data: {
853
+ customer_id: string;
854
+ }): Promise<{
855
+ token: string;
856
+ token_type: "bearer";
857
+ } | null>;
858
+ }
859
+ export declare function useHyperline(env: {
860
+ PRODUCTION_HYPERLINE_API_KEY: string;
861
+ DEV_HYPERLINE_API_KEY: string;
862
+ }, environment: 'production' | 'development', logger: Logger): {
863
+ hyperline: HyperlineAPI;
864
+ token: string;
865
+ isProduction: boolean;
866
+ };
867
+ export declare function useHyperlineByToken(token: string, logger?: Logger): HyperlineAPI;
868
+ export {};