@vrplatform/hyperline-client 1.0.0 → 1.0.2

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 (45) hide show
  1. package/build/main/client.d.ts +812 -0
  2. package/build/main/client.js +187 -0
  3. package/build/main/client.js.map +1 -0
  4. package/build/main/const.d.ts +26 -0
  5. package/build/main/const.js +209 -0
  6. package/build/main/const.js.map +1 -0
  7. package/build/main/hooks.d.ts +10 -0
  8. package/build/main/hooks.js +13 -0
  9. package/build/main/hooks.js.map +1 -0
  10. package/build/main/index.d.ts +4 -868
  11. package/build/main/index.js +4 -216
  12. package/build/main/index.js.map +1 -1
  13. package/build/main/tsconfig.main.tsbuildinfo +1 -1
  14. package/build/main/types.d.ts +35 -0
  15. package/build/main/types.js +2 -0
  16. package/build/main/types.js.map +1 -0
  17. package/build/main/utils.d.ts +1 -0
  18. package/build/main/utils.js +6 -0
  19. package/build/main/utils.js.map +1 -0
  20. package/build/module/client.d.ts +812 -0
  21. package/build/module/client.js +189 -0
  22. package/build/module/client.js.map +1 -0
  23. package/build/module/const.d.ts +26 -0
  24. package/build/module/const.js +209 -0
  25. package/build/module/const.js.map +1 -0
  26. package/build/module/hooks.d.ts +10 -0
  27. package/build/module/hooks.js +13 -0
  28. package/build/module/hooks.js.map +1 -0
  29. package/build/module/index.d.ts +4 -868
  30. package/build/module/index.js +4 -218
  31. package/build/module/index.js.map +1 -1
  32. package/build/module/tsconfig.esm.tsbuildinfo +1 -1
  33. package/build/module/types.d.ts +35 -0
  34. package/build/module/types.js +2 -0
  35. package/build/module/types.js.map +1 -0
  36. package/build/module/utils.d.ts +1 -0
  37. package/build/module/utils.js +6 -0
  38. package/build/module/utils.js.map +1 -0
  39. package/package.json +3 -3
  40. package/src/client.ts +362 -0
  41. package/src/const.ts +220 -0
  42. package/src/hooks.ts +24 -0
  43. package/src/index.ts +4 -443
  44. package/src/types.ts +43 -0
  45. package/src/utils.ts +5 -0
package/build/main/client.d.ts ADDED
@@ -0,0 +1,812 @@
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
+ getCustomer(id?: string): Promise<({
14
+ id: string;
15
+ name: string;
16
+ type: "corporate" | "person" | "automatically_created" | null;
17
+ status: "active" | "archived";
18
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
19
+ country: import("./_types.generated").components["schemas"]["Country"];
20
+ vat_number: string | null;
21
+ vat_number_valid: boolean;
22
+ vat_rate_custom: number | null;
23
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
24
+ 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;
25
+ external_id: string | null;
26
+ properties: {
27
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
28
+ } | null;
29
+ custom_properties: {
30
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
31
+ } | null;
32
+ billing_address: import("./_types.generated").components["schemas"]["Address"];
33
+ billing_email: string | null;
34
+ invoice_emails: string[];
35
+ invoicing_entity_id: string;
36
+ invoice_reminders_enabled: boolean | ("true" | "false");
37
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
38
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
39
+ current_payment_method_id: string | null;
40
+ custom_payment_delay: number | null;
41
+ subscriptions: {
42
+ id: string;
43
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
44
+ current_period_started_at: string | null;
45
+ current_period_ends_at: string | null;
46
+ plan_id: string | null;
47
+ checkout_session_id: string | null;
48
+ }[];
49
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
50
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
51
+ deleted_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
52
+ } & {
53
+ providers: {
54
+ gocardless?: string;
55
+ mollie?: string;
56
+ stripe?: string;
57
+ hubspot?: string;
58
+ salesforce?: string;
59
+ };
60
+ current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
61
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"];
62
+ organisation_id: string | null;
63
+ organisation_invoicing: "none" | "every_invoice" | "concat" | null;
64
+ }) | null>;
65
+ getCustomers(skip?: number, take?: number): Promise<{
66
+ meta: {
67
+ total: number;
68
+ taken: number;
69
+ skipped: number;
70
+ };
71
+ data: import("./_types.generated").components["schemas"]["Customer"][];
72
+ } | null>;
73
+ getAllCustomers(items?: paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']): Promise<paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']>;
74
+ createCustomer(data: NonNullable<paths['/v1/customers']['post']['requestBody']>['content']['application/json']): Promise<({
75
+ id: string;
76
+ name: string;
77
+ type: "corporate" | "person" | "automatically_created" | null;
78
+ status: "active" | "archived";
79
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
80
+ country: import("./_types.generated").components["schemas"]["Country"];
81
+ vat_number: string | null;
82
+ vat_number_valid: boolean;
83
+ vat_rate_custom: number | null;
84
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
85
+ 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;
86
+ external_id: string | null;
87
+ properties: {
88
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
89
+ } | null;
90
+ custom_properties: {
91
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
92
+ } | null;
93
+ billing_address: import("./_types.generated").components["schemas"]["Address"];
94
+ billing_email: string | null;
95
+ invoice_emails: string[];
96
+ invoicing_entity_id: string;
97
+ invoice_reminders_enabled: boolean | ("true" | "false");
98
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
99
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
100
+ current_payment_method_id: string | null;
101
+ custom_payment_delay: number | null;
102
+ subscriptions: {
103
+ id: string;
104
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
105
+ current_period_started_at: string | null;
106
+ current_period_ends_at: string | null;
107
+ plan_id: string | null;
108
+ checkout_session_id: string | null;
109
+ }[];
110
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
111
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
112
+ deleted_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
113
+ } & {
114
+ providers: {
115
+ gocardless?: string;
116
+ mollie?: string;
117
+ stripe?: string;
118
+ hubspot?: string;
119
+ salesforce?: string;
120
+ };
121
+ current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
122
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"];
123
+ organisation_id: string | null;
124
+ organisation_invoicing: "none" | "every_invoice" | "concat" | null;
125
+ }) | null>;
126
+ updateCustomer(id: string, data: NonNullable<paths['/v1/customers/{id}']['put']['requestBody']>['content']['application/json']): Promise<({
127
+ id: string;
128
+ name: string;
129
+ type: "corporate" | "person" | "automatically_created" | null;
130
+ status: "active" | "archived";
131
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
132
+ country: import("./_types.generated").components["schemas"]["Country"];
133
+ vat_number: string | null;
134
+ vat_number_valid: boolean;
135
+ vat_rate_custom: number | null;
136
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
137
+ 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;
138
+ external_id: string | null;
139
+ properties: {
140
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
141
+ } | null;
142
+ custom_properties: {
143
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
144
+ } | null;
145
+ billing_address: import("./_types.generated").components["schemas"]["Address"];
146
+ billing_email: string | null;
147
+ invoice_emails: string[];
148
+ invoicing_entity_id: string;
149
+ invoice_reminders_enabled: boolean | ("true" | "false");
150
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
151
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
152
+ current_payment_method_id: string | null;
153
+ custom_payment_delay: number | null;
154
+ subscriptions: {
155
+ id: string;
156
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
157
+ current_period_started_at: string | null;
158
+ current_period_ends_at: string | null;
159
+ plan_id: string | null;
160
+ checkout_session_id: string | null;
161
+ }[];
162
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
163
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
164
+ deleted_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
165
+ } & {
166
+ providers: {
167
+ gocardless?: string;
168
+ mollie?: string;
169
+ stripe?: string;
170
+ hubspot?: string;
171
+ salesforce?: string;
172
+ };
173
+ current_payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
174
+ bank_account: import("./_types.generated").components["schemas"]["BankAccount"];
175
+ organisation_id: string | null;
176
+ organisation_invoicing: "none" | "every_invoice" | "concat" | null;
177
+ }) | null>;
178
+ deleteCustomer(id: string): Promise<null | undefined>;
179
+ archiveCustomer(id: string): Promise<{
180
+ id: string;
181
+ name: string;
182
+ type: "corporate" | "person" | "automatically_created" | null;
183
+ status: "active" | "archived";
184
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
185
+ country: import("./_types.generated").components["schemas"]["Country"];
186
+ vat_number: string | null;
187
+ vat_number_valid: boolean;
188
+ vat_rate_custom: number | null;
189
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
190
+ 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;
191
+ external_id: string | null;
192
+ properties: {
193
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
194
+ } | null;
195
+ custom_properties: {
196
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
197
+ } | null;
198
+ billing_address: import("./_types.generated").components["schemas"]["Address"];
199
+ billing_email: string | null;
200
+ invoice_emails: string[];
201
+ invoicing_entity_id: string;
202
+ invoice_reminders_enabled: boolean | ("true" | "false");
203
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
204
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
205
+ current_payment_method_id: string | null;
206
+ custom_payment_delay: number | null;
207
+ subscriptions: {
208
+ id: string;
209
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
210
+ current_period_started_at: string | null;
211
+ current_period_ends_at: string | null;
212
+ plan_id: string | null;
213
+ checkout_session_id: string | null;
214
+ }[];
215
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
216
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
217
+ deleted_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
218
+ } | null>;
219
+ unarchiveCustomer(id: string): Promise<{
220
+ id: string;
221
+ name: string;
222
+ type: "corporate" | "person" | "automatically_created" | null;
223
+ status: "active" | "archived";
224
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
225
+ country: import("./_types.generated").components["schemas"]["Country"];
226
+ vat_number: string | null;
227
+ vat_number_valid: boolean;
228
+ vat_rate_custom: number | null;
229
+ language: "fr" | "en" | "de" | "it" | "nl" | "es" | "pt" | "pl" | null;
230
+ 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;
231
+ external_id: string | null;
232
+ properties: {
233
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
234
+ } | null;
235
+ custom_properties: {
236
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
237
+ } | null;
238
+ billing_address: import("./_types.generated").components["schemas"]["Address"];
239
+ billing_email: string | null;
240
+ invoice_emails: string[];
241
+ invoicing_entity_id: string;
242
+ invoice_reminders_enabled: boolean | ("true" | "false");
243
+ available_payment_methods: ("card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated")[];
244
+ current_payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
245
+ current_payment_method_id: string | null;
246
+ custom_payment_delay: number | null;
247
+ subscriptions: {
248
+ id: string;
249
+ status: "draft" | "pending" | "trialing" | "active" | "paused" | "errored" | "cancelled" | "voided" | "archived";
250
+ current_period_started_at: string | null;
251
+ current_period_ends_at: string | null;
252
+ plan_id: string | null;
253
+ checkout_session_id: string | null;
254
+ }[];
255
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
256
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
257
+ deleted_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
258
+ } | null>;
259
+ getCustomerPortal(id: string): Promise<{
260
+ url: string;
261
+ } | null>;
262
+ getSubscription(id: string): Promise<({
263
+ id: string;
264
+ currency: import("./_types.generated").components["schemas"]["Currency"];
265
+ status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
266
+ purchase_order: string | null;
267
+ customer_id: string;
268
+ plan_id: string | null;
269
+ invoicing_entity_id: string;
270
+ checkout_session_id: string | null;
271
+ crm_opportunity_id: string | null;
272
+ minimum_invoice_fee: number | null;
273
+ commitment_interval: {
274
+ period: "days" | "weeks" | "months" | "years";
275
+ count: number;
276
+ } | null;
277
+ renew_automatically: boolean;
278
+ renew_for: {
279
+ period: "days" | "weeks" | "months" | "years";
280
+ count: number;
281
+ } | null;
282
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
283
+ starts_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
284
+ contract_start: import("./_types.generated").components["schemas"]["DateTime"] & string;
285
+ contract_end: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
286
+ initial_billing_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
287
+ paused_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
288
+ reactivate_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
289
+ cancel_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
290
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
291
+ cancellation_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
292
+ estimated_arr: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
293
+ current_period_started_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
294
+ current_period_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
295
+ next_payment_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
296
+ next_payment_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
297
+ renews_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
298
+ current_phase_id: string | null;
299
+ trial_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
300
+ properties: {
301
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
302
+ } | null;
303
+ custom_properties: {
304
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
305
+ } | null;
306
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
307
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
308
+ } & {
309
+ 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"])[];
310
+ coupons: (({
311
+ description: string | null;
312
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
313
+ type: "amount";
314
+ discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
315
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
316
+ } | {
317
+ description: string | null;
318
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
319
+ type: "percent";
320
+ discount_percent: number;
321
+ }) & {
322
+ id: string | null;
323
+ name: string | null;
324
+ subscription_coupon_id: string;
325
+ repeat: "once" | "forever" | "custom";
326
+ product_ids: string[];
327
+ apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
328
+ expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
329
+ })[];
330
+ quote: {
331
+ id: string;
332
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
333
+ } | null;
334
+ plan: {
335
+ id: string;
336
+ name: string;
337
+ } | null;
338
+ checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
339
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
340
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
341
+ generate_draft_invoices: boolean;
342
+ } & {
343
+ live_billing?: import("./_types.generated").components["schemas"]["LiveBilling"];
344
+ }) | null>;
345
+ getSubscriptions(skip?: number, take?: number, query?: operations['getSubscriptions']['parameters']['query']): Promise<{
346
+ meta: {
347
+ total: number;
348
+ taken: number;
349
+ skipped: number;
350
+ };
351
+ data: import("./_types.generated").components["schemas"]["Subscription"][];
352
+ } | null>;
353
+ 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']>;
354
+ createSubscription(data: NonNullable<paths['/v2/subscriptions']['post']['requestBody']>['content']['application/json']): Promise<({
355
+ id: string;
356
+ currency: import("./_types.generated").components["schemas"]["Currency"];
357
+ status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
358
+ purchase_order: string | null;
359
+ customer_id: string;
360
+ plan_id: string | null;
361
+ invoicing_entity_id: string;
362
+ checkout_session_id: string | null;
363
+ crm_opportunity_id: string | null;
364
+ minimum_invoice_fee: number | null;
365
+ commitment_interval: {
366
+ period: "days" | "weeks" | "months" | "years";
367
+ count: number;
368
+ } | null;
369
+ renew_automatically: boolean;
370
+ renew_for: {
371
+ period: "days" | "weeks" | "months" | "years";
372
+ count: number;
373
+ } | null;
374
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
375
+ starts_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
376
+ contract_start: import("./_types.generated").components["schemas"]["DateTime"] & string;
377
+ contract_end: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
378
+ initial_billing_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
379
+ paused_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
380
+ reactivate_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
381
+ cancel_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
382
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
383
+ cancellation_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
384
+ estimated_arr: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
385
+ current_period_started_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
386
+ current_period_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
387
+ next_payment_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
388
+ next_payment_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
389
+ renews_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
390
+ current_phase_id: string | null;
391
+ trial_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
392
+ properties: {
393
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
394
+ } | null;
395
+ custom_properties: {
396
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
397
+ } | null;
398
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
399
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
400
+ } & {
401
+ 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"])[];
402
+ coupons: (({
403
+ description: string | null;
404
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
405
+ type: "amount";
406
+ discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
407
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
408
+ } | {
409
+ description: string | null;
410
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
411
+ type: "percent";
412
+ discount_percent: number;
413
+ }) & {
414
+ id: string | null;
415
+ name: string | null;
416
+ subscription_coupon_id: string;
417
+ repeat: "once" | "forever" | "custom";
418
+ product_ids: string[];
419
+ apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
420
+ expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
421
+ })[];
422
+ quote: {
423
+ id: string;
424
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
425
+ } | null;
426
+ plan: {
427
+ id: string;
428
+ name: string;
429
+ } | null;
430
+ checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
431
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
432
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
433
+ generate_draft_invoices: boolean;
434
+ }) | null>;
435
+ updateSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/update']['post']['requestBody']>['content']['application/json']): Promise<{
436
+ id: string;
437
+ } | null>;
438
+ cancelSubscription(id: string, data: NonNullable<paths['/v1/subscriptions/{id}/cancel']['post']['requestBody']>['content']['application/json']): Promise<({
439
+ id: string;
440
+ currency: import("./_types.generated").components["schemas"]["Currency"];
441
+ status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
442
+ purchase_order: string | null;
443
+ customer_id: string;
444
+ plan_id: string | null;
445
+ invoicing_entity_id: string;
446
+ checkout_session_id: string | null;
447
+ crm_opportunity_id: string | null;
448
+ minimum_invoice_fee: number | null;
449
+ commitment_interval: {
450
+ period: "days" | "weeks" | "months" | "years";
451
+ count: number;
452
+ } | null;
453
+ renew_automatically: boolean;
454
+ renew_for: {
455
+ period: "days" | "weeks" | "months" | "years";
456
+ count: number;
457
+ } | null;
458
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
459
+ starts_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
460
+ contract_start: import("./_types.generated").components["schemas"]["DateTime"] & string;
461
+ contract_end: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
462
+ initial_billing_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
463
+ paused_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
464
+ reactivate_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
465
+ cancel_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
466
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
467
+ cancellation_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
468
+ estimated_arr: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
469
+ current_period_started_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
470
+ current_period_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
471
+ next_payment_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
472
+ next_payment_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
473
+ renews_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
474
+ current_phase_id: string | null;
475
+ trial_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
476
+ properties: {
477
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
478
+ } | null;
479
+ custom_properties: {
480
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
481
+ } | null;
482
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
483
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
484
+ } & {
485
+ 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"])[];
486
+ coupons: (({
487
+ description: string | null;
488
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
489
+ type: "amount";
490
+ discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
491
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
492
+ } | {
493
+ description: string | null;
494
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
495
+ type: "percent";
496
+ discount_percent: number;
497
+ }) & {
498
+ id: string | null;
499
+ name: string | null;
500
+ subscription_coupon_id: string;
501
+ repeat: "once" | "forever" | "custom";
502
+ product_ids: string[];
503
+ apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
504
+ expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
505
+ })[];
506
+ quote: {
507
+ id: string;
508
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
509
+ } | null;
510
+ plan: {
511
+ id: string;
512
+ name: string;
513
+ } | null;
514
+ checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
515
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
516
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
517
+ generate_draft_invoices: boolean;
518
+ }) | null>;
519
+ reinstateSubscription(id: string): Promise<({
520
+ id: string;
521
+ currency: import("./_types.generated").components["schemas"]["Currency"];
522
+ status: "active" | "cancelled" | "draft" | "errored" | "paused" | "pending" | "voided";
523
+ purchase_order: string | null;
524
+ customer_id: string;
525
+ plan_id: string | null;
526
+ invoicing_entity_id: string;
527
+ checkout_session_id: string | null;
528
+ crm_opportunity_id: string | null;
529
+ minimum_invoice_fee: number | null;
530
+ commitment_interval: {
531
+ period: "days" | "weeks" | "months" | "years";
532
+ count: number;
533
+ } | null;
534
+ renew_automatically: boolean;
535
+ renew_for: {
536
+ period: "days" | "weeks" | "months" | "years";
537
+ count: number;
538
+ } | null;
539
+ activation_strategy: "start_date" | "manually" | "checkout" | "quote" | "contract_start_date" | null;
540
+ starts_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
541
+ contract_start: import("./_types.generated").components["schemas"]["DateTime"] & string;
542
+ contract_end: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
543
+ initial_billing_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
544
+ paused_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
545
+ reactivate_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
546
+ cancel_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
547
+ cancellation_strategy: "refund_prorata" | "refund_custom" | "charge_prorata" | "charge_custom" | "end_of_period" | "do_nothing" | null;
548
+ cancellation_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
549
+ estimated_arr: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
550
+ current_period_started_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
551
+ current_period_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
552
+ next_payment_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
553
+ next_payment_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
554
+ renews_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
555
+ current_phase_id: string | null;
556
+ trial_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
557
+ properties: {
558
+ [key: string]: string | number | boolean | null | (string | number | boolean | null)[];
559
+ } | null;
560
+ custom_properties: {
561
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
562
+ } | null;
563
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
564
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
565
+ } & {
566
+ 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"])[];
567
+ coupons: (({
568
+ description: string | null;
569
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
570
+ type: "amount";
571
+ discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
572
+ currency: import("./_types.generated").components["schemas"]["Currency"] & (string | null);
573
+ } | {
574
+ description: string | null;
575
+ created_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
576
+ type: "percent";
577
+ discount_percent: number;
578
+ }) & {
579
+ id: string | null;
580
+ name: string | null;
581
+ subscription_coupon_id: string;
582
+ repeat: "once" | "forever" | "custom";
583
+ product_ids: string[];
584
+ apply_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
585
+ expires_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
586
+ })[];
587
+ quote: {
588
+ id: string;
589
+ status: "draft" | "pending_approval" | "changes_requested" | "approved" | "pending_signature" | "voided" | "signed";
590
+ } | null;
591
+ plan: {
592
+ id: string;
593
+ name: string;
594
+ } | null;
595
+ checkout_session: import("./_types.generated").components["schemas"]["CheckoutSession"];
596
+ payment_method_type: "card" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "transfer" | "transfer_automated" | "external" | null;
597
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"] & unknown;
598
+ generate_draft_invoices: boolean;
599
+ }) | null>;
600
+ getPlan(id: string): Promise<{
601
+ id: string;
602
+ name: string;
603
+ description: string | null;
604
+ commitment_interval: {
605
+ period: "days" | "weeks" | "months" | "years";
606
+ count: number;
607
+ } | null;
608
+ contract_start_strategy: "start_date" | "immediately" | "manual" | "manual_with_latest" | "quote_signature" | "checkout";
609
+ contract_start: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
610
+ contract_end_strategy: "duration" | "manual" | "end_date";
611
+ contract_end: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
612
+ contract_duration: {
613
+ period: "days" | "weeks" | "months" | "years" | "forever";
614
+ count: number | null;
615
+ } | null;
616
+ renew_automatically: boolean;
617
+ renew_for: {
618
+ period: "days" | "weeks" | "months" | "years";
619
+ count: number | null;
620
+ } | null;
621
+ trial_interval: {
622
+ period: "days" | "weeks" | "months" | "years";
623
+ count: number;
624
+ } | null;
625
+ products: ({
626
+ id: string;
627
+ name: string;
628
+ description: string | null;
629
+ description_display_interval_dates: boolean;
630
+ payment_interval: {
631
+ period: "once";
632
+ } | {
633
+ period: "days" | "weeks" | "months" | "years";
634
+ count: number;
635
+ } | null;
636
+ payment_schedule: "start" | "end" | null;
637
+ type: "flat_fee";
638
+ prices: import("./_types.generated").components["schemas"]["PriceFee"][];
639
+ } | {
640
+ id: string;
641
+ name: string;
642
+ description: string | null;
643
+ description_display_interval_dates: boolean;
644
+ payment_interval: {
645
+ period: "once";
646
+ } | {
647
+ period: "days" | "weeks" | "months" | "years";
648
+ count: number;
649
+ } | null;
650
+ payment_schedule: "start" | "end" | null;
651
+ type: "seat";
652
+ unit_name: string | null;
653
+ prices: (import("./_types.generated").components["schemas"]["PriceVolume"] | import("./_types.generated").components["schemas"]["PricePackaged"] | import("./_types.generated").components["schemas"]["PriceBulk"])[];
654
+ } | {
655
+ id: string;
656
+ name: string;
657
+ description: string | null;
658
+ description_display_interval_dates: boolean;
659
+ payment_interval: {
660
+ period: "once";
661
+ } | {
662
+ period: "days" | "weeks" | "months" | "years";
663
+ count: number;
664
+ } | null;
665
+ payment_schedule: "start" | "end" | null;
666
+ type: "dynamic";
667
+ unit_name: string | null;
668
+ min_committed_count: number | null;
669
+ min_amount: number | null;
670
+ max_amount: number | null;
671
+ metering_interval_type: "subscription_commitment" | "payment_interval" | "full_database" | "phase_duration" | null;
672
+ bill_usage_difference: boolean;
673
+ prices: ((import("./_types.generated").components["schemas"]["PriceVolume"] | import("./_types.generated").components["schemas"]["PricePackaged"] | import("./_types.generated").components["schemas"]["PriceBulk"] | import("./_types.generated").components["schemas"]["PriceBps"]) & {
674
+ metering_filter: import("./_types.generated").components["schemas"]["MeteringFilter"];
675
+ })[];
676
+ } | {
677
+ id: string;
678
+ name: string;
679
+ description: string | null;
680
+ description_display_interval_dates: boolean;
681
+ payment_interval: {
682
+ period: "once";
683
+ } | {
684
+ period: "days" | "weeks" | "months" | "years";
685
+ count: number;
686
+ } | null;
687
+ payment_schedule: "start" | "end" | null;
688
+ type: "credit";
689
+ unit_name: string | null;
690
+ count: number;
691
+ prices: import("./_types.generated").components["schemas"]["PriceFee"][];
692
+ })[];
693
+ custom_properties: {
694
+ [key: string]: string | number | boolean | (import("./_types.generated").components["schemas"]["DateTime"] & string) | null;
695
+ } | null;
696
+ } | null>;
697
+ getPlans(skip?: number, take?: number): Promise<{
698
+ meta: {
699
+ total: number;
700
+ taken: number;
701
+ skipped: number;
702
+ };
703
+ data: import("./_types.generated").components["schemas"]["PlanSimple"][];
704
+ } | null>;
705
+ getInvoice(id: string): Promise<({
706
+ id: string;
707
+ number: string;
708
+ type: "invoice" | "credit_note" | "document" | "child_invoice_ref" | "child_creditnote_ref";
709
+ document_name: string | null;
710
+ status: "draft" | "open" | "to_pay" | "grace_period" | "partially_paid" | "paid" | "late" | "voided" | "closed" | "error" | "missing_info" | "archived" | "charged_on_parent" | "pending_parent_concat";
711
+ reference: string | null;
712
+ purchase_order: string | null;
713
+ original_invoice_id: string | null;
714
+ original_invoice_number: string | null;
715
+ currency: import("./_types.generated").components["schemas"]["Currency"];
716
+ total_amount: import("./_types.generated").components["schemas"]["Amount"];
717
+ amount_due: import("./_types.generated").components["schemas"]["Amount"] & unknown;
718
+ amount_paid: import("./_types.generated").components["schemas"]["Amount"] & unknown;
719
+ amount_fixed: import("./_types.generated").components["schemas"]["Amount"] & unknown;
720
+ amount_excluding_tax: import("./_types.generated").components["schemas"]["Amount"] & unknown;
721
+ tax_rate: number;
722
+ tax_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
723
+ tax_scheme: "exempt" | "standard" | "reverse_charge" | "manual" | "not_eligible";
724
+ discount_amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
725
+ conversion_rate: number | null;
726
+ converted_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
727
+ converted_at: import("./_types.generated").components["schemas"]["DateTime"];
728
+ payment_method_id: string | null;
729
+ attempt_count: number;
730
+ custom_note: string | null;
731
+ customer: {
732
+ id: string;
733
+ name: string;
734
+ email: string | null;
735
+ external_id: string | null;
736
+ vat_number: string | null;
737
+ address: import("./_types.generated").components["schemas"]["Address"];
738
+ };
739
+ seller: {
740
+ id: string;
741
+ name: string;
742
+ tax_id: string | null;
743
+ address: import("./_types.generated").components["schemas"]["Address"] & unknown;
744
+ };
745
+ subscription_id: string | null;
746
+ period_starts_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
747
+ period_ends_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
748
+ emitted_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
749
+ due_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
750
+ refunded_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
751
+ grace_period_ended_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
752
+ settled_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
753
+ updated_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
754
+ line_items: import("./_types.generated").components["schemas"]["InvoiceLineItem"][];
755
+ } & {
756
+ transactions: ({
757
+ id: string;
758
+ type: "subscription" | "one_time" | "refund";
759
+ amount: import("./_types.generated").components["schemas"]["Amount"] & unknown;
760
+ currency: import("./_types.generated").components["schemas"]["Currency"] & unknown;
761
+ customer_id: string;
762
+ provider_id: string | null;
763
+ process_at: import("./_types.generated").components["schemas"]["DateTime"] & string;
764
+ refunded_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
765
+ last_refreshed_at: import("./_types.generated").components["schemas"]["DateTime"] & unknown;
766
+ } & ({
767
+ payment_method_type: "card" | "transfer" | "transfer_automated" | "direct_debit" | "direct_debit_ach" | "direct_debit_bacs" | "external";
768
+ payment_method: import("./_types.generated").components["schemas"]["PaymentMethod"];
769
+ } | {
770
+ payment_method_type: "wallet";
771
+ wallet_id: string;
772
+ }) & ({
773
+ status: "to_process" | "pending" | "settled" | "cancelled" | "scheduled";
774
+ } | {
775
+ status: "failed";
776
+ 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;
777
+ error_message: string | null;
778
+ }))[];
779
+ coupons: {
780
+ id: string | null;
781
+ name: string | null;
782
+ discount_amount: import("./_types.generated").components["schemas"]["Amount"] & (number | null);
783
+ discount_percent: number | null;
784
+ line_item_ids: string[];
785
+ }[];
786
+ }) | null>;
787
+ getInvoices(skip?: number, take?: number, query?: operations['getInvoices']['parameters']['query']): Promise<{
788
+ meta: {
789
+ total: number;
790
+ taken: number;
791
+ skipped: number;
792
+ };
793
+ data: import("./_types.generated").components["schemas"]["Invoice"][];
794
+ } | null>;
795
+ getInvoicesByCustomerId(id: string): Promise<{
796
+ meta: {
797
+ total: number;
798
+ taken: number;
799
+ skipped: number;
800
+ };
801
+ data: import("./_types.generated").components["schemas"]["Invoice"][];
802
+ } | null>;
803
+ getInvoiceDownload(id: string): Promise<string | null>;
804
+ getAllInvoices(items?: paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']): Promise<paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']>;
805
+ createBillableEvent(data: CreateBillableEvent[]): Promise<BillableEvents | null>;
806
+ getComponentToken(data: {
807
+ customer_id: string;
808
+ }): Promise<{
809
+ token: string;
810
+ token_type: "bearer";
811
+ } | null>;
812
+ }