@vrplatform/hyperline-client 1.0.1 → 1.0.3

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