@vrplatform/hyperline-client 1.0.9 → 1.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/main/_types.generated.d.ts +202 -80
- package/build/main/_types.generated.js.map +1 -1
- package/build/main/client.d.ts +7 -15
- package/build/main/client.js +2 -2
- package/build/main/client.js.map +1 -1
- package/build/main/const.d.ts +4 -0
- package/build/main/const.js +4 -0
- package/build/main/const.js.map +1 -1
- package/build/module/_types.generated.d.ts +202 -80
- package/build/module/_types.generated.js.map +1 -1
- package/build/module/client.d.ts +7 -15
- package/build/module/client.js +2 -2
- package/build/module/client.js.map +1 -1
- package/build/module/const.d.ts +4 -0
- package/build/module/const.js +4 -0
- package/build/module/const.js.map +1 -1
- package/package.json +1 -1
- package/src/_types.generated.ts +202 -80
- package/src/client.ts +4 -2
- package/src/const.ts +5 -0
|
@@ -1902,12 +1902,13 @@ export interface components {
|
|
|
1902
1902
|
tax_rate: number;
|
|
1903
1903
|
tax_amount: components["schemas"]["Amount"] & unknown;
|
|
1904
1904
|
/**
|
|
1905
|
-
* @description
|
|
1906
|
-
*
|
|
1905
|
+
* @description Tax scheme of the invoice.
|
|
1906
|
+
*
|
|
1907
|
+
* - `standard`: Tax rate is resolved depending on local tax regulations.
|
|
1907
1908
|
* - `exempt`: No tax rate applied because the customer country doesn't require it.
|
|
1908
1909
|
* - `reverse_charge`: No tax rate applied because the customer is eligible to EU reverse charge.
|
|
1909
1910
|
* - `manual`: Tax rate has been manually specified when creating the invoice.
|
|
1910
|
-
* - `not_eligible`:
|
|
1911
|
+
* - `not_eligible`: Tax collection is disabled for the invoice.
|
|
1911
1912
|
*
|
|
1912
1913
|
* @example standard
|
|
1913
1914
|
* @enum {string}
|
|
@@ -2366,18 +2367,6 @@ export interface components {
|
|
|
2366
2367
|
*/
|
|
2367
2368
|
customer_id: string;
|
|
2368
2369
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
2369
|
-
/**
|
|
2370
|
-
* @description ID of the invoicing entity attached to the invoice.
|
|
2371
|
-
* @example ive_47484fjdhy5
|
|
2372
|
-
*/
|
|
2373
|
-
invoicing_entity_id?: string;
|
|
2374
|
-
/**
|
|
2375
|
-
* @description Invoice number. If specified, the invoice will be considered as imported from an external source and the number will not be generated by Hyperline. You are responsible for avoiding duplicates and ensuring it does not impact the numbering sequence in Hyperline.
|
|
2376
|
-
* @example INV-35
|
|
2377
|
-
*/
|
|
2378
|
-
number?: string;
|
|
2379
|
-
/** @enum {string} */
|
|
2380
|
-
type?: "invoice" | "credit_note" | "document";
|
|
2381
2370
|
/**
|
|
2382
2371
|
* @description Current invoice status.
|
|
2383
2372
|
*
|
|
@@ -2399,6 +2388,29 @@ export interface components {
|
|
|
2399
2388
|
* @enum {string}
|
|
2400
2389
|
*/
|
|
2401
2390
|
status: "to_pay" | "paid" | "draft";
|
|
2391
|
+
/**
|
|
2392
|
+
* @description ID of the invoicing entity attached to the invoice.
|
|
2393
|
+
* @example ive_47484fjdhy5
|
|
2394
|
+
*/
|
|
2395
|
+
invoicing_entity_id?: string;
|
|
2396
|
+
/**
|
|
2397
|
+
* @description Invoice number. If specified, the invoice will be considered as imported from an external source and the number will not be generated by Hyperline. You are responsible for avoiding duplicates and ensuring it does not impact the numbering sequence in Hyperline.
|
|
2398
|
+
* @example INV-35
|
|
2399
|
+
*/
|
|
2400
|
+
number?: string;
|
|
2401
|
+
/**
|
|
2402
|
+
* @description Type of the invoice.
|
|
2403
|
+
*
|
|
2404
|
+
* - `invoice`: Legal invoice to be paid by your customer.
|
|
2405
|
+
* - `credit_note`: Legal credit note cancelling an invoice and refunding your customer.
|
|
2406
|
+
* - `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.
|
|
2407
|
+
*
|
|
2408
|
+
* @example invoice
|
|
2409
|
+
* @enum {string}
|
|
2410
|
+
*/
|
|
2411
|
+
type?: "invoice" | "credit_note" | "document";
|
|
2412
|
+
/** @description If the invoice is of type `document` you can give it a custom name (displayed on the final PDF). */
|
|
2413
|
+
document_name?: string;
|
|
2402
2414
|
/**
|
|
2403
2415
|
* @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.
|
|
2404
2416
|
* @example V0KAHOU6J3
|
|
@@ -2409,11 +2421,27 @@ export interface components {
|
|
|
2409
2421
|
* @example PO-12345
|
|
2410
2422
|
*/
|
|
2411
2423
|
purchase_order?: string;
|
|
2424
|
+
/**
|
|
2425
|
+
* @description Custom note added to the invoice.
|
|
2426
|
+
* @example Thank you for your purchase!
|
|
2427
|
+
*/
|
|
2428
|
+
custom_note?: string;
|
|
2412
2429
|
/**
|
|
2413
2430
|
* @description Tax rate of the invoice.
|
|
2414
2431
|
* @example 20
|
|
2415
2432
|
*/
|
|
2416
2433
|
tax_rate?: number;
|
|
2434
|
+
/**
|
|
2435
|
+
* @description Tax scheme of the invoice.
|
|
2436
|
+
*
|
|
2437
|
+
* - `auto`: Tax is automatically computed and applied.
|
|
2438
|
+
* - `not_eligible`: Tax collection is disabled for the invoice.
|
|
2439
|
+
*
|
|
2440
|
+
* @default auto
|
|
2441
|
+
* @example auto
|
|
2442
|
+
* @enum {string}
|
|
2443
|
+
*/
|
|
2444
|
+
tax_scheme: "auto" | "not_eligible";
|
|
2417
2445
|
/**
|
|
2418
2446
|
* @description
|
|
2419
2447
|
* Payment method strategy used to charge the invoice. Only applies to `to_pay` status.
|
|
@@ -2434,13 +2462,21 @@ export interface components {
|
|
|
2434
2462
|
due_at?: components["schemas"]["DateTime"] & string;
|
|
2435
2463
|
settled_at?: components["schemas"]["DateTime"] & string;
|
|
2436
2464
|
line_items: components["schemas"]["CreateInvoiceLineItem"][];
|
|
2437
|
-
/**
|
|
2438
|
-
* @description Custom note added to the invoice.
|
|
2439
|
-
* @example Thank you for your purchase!
|
|
2440
|
-
*/
|
|
2441
|
-
custom_note?: string;
|
|
2442
2465
|
};
|
|
2443
2466
|
UpdateInvoice: {
|
|
2467
|
+
/**
|
|
2468
|
+
* @description Type of the invoice.
|
|
2469
|
+
*
|
|
2470
|
+
* - `invoice`: Legal invoice to be paid by your customer.
|
|
2471
|
+
* - `credit_note`: Legal credit note cancelling an invoice and refunding your customer.
|
|
2472
|
+
* - `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.
|
|
2473
|
+
*
|
|
2474
|
+
* @example invoice
|
|
2475
|
+
* @enum {string}
|
|
2476
|
+
*/
|
|
2477
|
+
type?: "invoice" | "credit_note" | "document";
|
|
2478
|
+
/** @description If the invoice is of type `document` you can give it a custom name (displayed on the final PDF). */
|
|
2479
|
+
document_name?: string | null;
|
|
2444
2480
|
/**
|
|
2445
2481
|
* @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.
|
|
2446
2482
|
* @example V0KAHOU6J3
|
|
@@ -2456,6 +2492,18 @@ export interface components {
|
|
|
2456
2492
|
* @example Thank you for your purchase!
|
|
2457
2493
|
*/
|
|
2458
2494
|
custom_note?: string | null;
|
|
2495
|
+
/**
|
|
2496
|
+
* @description Tax scheme of the invoice.
|
|
2497
|
+
*
|
|
2498
|
+
* - `auto`: Tax is automatically computed and applied.
|
|
2499
|
+
* - `not_eligible`: Tax collection is disabled for the invoice.
|
|
2500
|
+
*
|
|
2501
|
+
* @default auto
|
|
2502
|
+
* @example auto
|
|
2503
|
+
* @enum {string}
|
|
2504
|
+
*/
|
|
2505
|
+
tax_scheme: "auto" | "not_eligible";
|
|
2506
|
+
line_items?: components["schemas"]["CreateInvoiceLineItem"][];
|
|
2459
2507
|
};
|
|
2460
2508
|
/** @description A file in binary format. Accepted MIME types: application/pdf. Max size: 5000000 bytes. */
|
|
2461
2509
|
File: unknown;
|
|
@@ -2928,7 +2976,7 @@ export interface components {
|
|
|
2928
2976
|
* @example Europe/Paris
|
|
2929
2977
|
* @enum {string|null}
|
|
2930
2978
|
*/
|
|
2931
|
-
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "
|
|
2979
|
+
timezone: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati" | null;
|
|
2932
2980
|
/** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */
|
|
2933
2981
|
external_id: string | null;
|
|
2934
2982
|
/** @description Key/value pairs to store any information you find useful. */
|
|
@@ -3166,7 +3214,7 @@ export interface components {
|
|
|
3166
3214
|
* @example Europe/Paris
|
|
3167
3215
|
* @enum {string}
|
|
3168
3216
|
*/
|
|
3169
|
-
timezone?: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "
|
|
3217
|
+
timezone?: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati";
|
|
3170
3218
|
/**
|
|
3171
3219
|
* @description List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.
|
|
3172
3220
|
* @example [
|
|
@@ -3268,7 +3316,7 @@ export interface components {
|
|
|
3268
3316
|
* @example Europe/Paris
|
|
3269
3317
|
* @enum {string}
|
|
3270
3318
|
*/
|
|
3271
|
-
timezone?: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "
|
|
3319
|
+
timezone?: "Pacific/Niue" | "Pacific/Midway" | "Pacific/Pago_Pago" | "Pacific/Rarotonga" | "Pacific/Honolulu" | "Pacific/Tahiti" | "Pacific/Marquesas" | "Pacific/Gambier" | "America/Adak" | "America/Anchorage" | "Pacific/Pitcairn" | "America/Hermosillo" | "America/Phoenix" | "America/Los_Angeles" | "America/Tijuana" | "America/Vancouver" | "America/Whitehorse" | "America/Belize" | "America/Guatemala" | "America/Managua" | "America/Mexico_City" | "America/Costa_Rica" | "America/El_Salvador" | "America/Regina" | "America/Tegucigalpa" | "Pacific/Easter" | "Pacific/Galapagos" | "America/Edmonton" | "America/Ciudad_Juarez" | "America/Denver" | "America/Rio_Branco" | "America/Chicago" | "America/Matamoros" | "America/Winnipeg" | "America/Bogota" | "America/Atikokan" | "America/Cancun" | "America/Cayman" | "America/Jamaica" | "America/Panama" | "America/Guayaquil" | "America/Lima" | "America/Manaus" | "America/St_Kitts" | "America/Blanc-Sablon" | "America/Montserrat" | "America/Barbados" | "America/St_Lucia" | "America/Port_of_Spain" | "America/Martinique" | "America/St_Barthelemy" | "America/St_Vincent" | "America/Kralendijk" | "America/Guadeloupe" | "America/Marigot" | "America/Aruba" | "America/Lower_Princes" | "America/Tortola" | "America/Dominica" | "America/St_Thomas" | "America/Grenada" | "America/Antigua" | "America/Puerto_Rico" | "America/Santo_Domingo" | "America/Anguilla" | "America/Curacao" | "America/La_Paz" | "America/Santiago" | "America/Havana" | "America/Grand_Turk" | "America/Nassau" | "America/New_York" | "America/Port-au-Prince" | "America/Toronto" | "America/Guyana" | "America/Asuncion" | "America/Caracas" | "America/Argentina/Buenos_Aires" | "America/Halifax" | "Atlantic/Bermuda" | "America/Thule" | "America/Sao_Paulo" | "Antarctica/Palmer" | "America/Punta_Arenas" | "Atlantic/Stanley" | "America/Cayenne" | "America/Paramaribo" | "America/Montevideo" | "America/St_Johns" | "America/Noronha" | "Atlantic/South_Georgia" | "America/Miquelon" | "Atlantic/Cape_Verde" | "America/Scoresbysund" | "America/Nuuk" | "Atlantic/Azores" | "Etc/UTC" | "Africa/Abidjan" | "Africa/Bamako" | "Africa/Bissau" | "Africa/Conakry" | "Africa/Dakar" | "America/Danmarkshavn" | "Africa/Freetown" | "Atlantic/St_Helena" | "Africa/Accra" | "Africa/Lome" | "Africa/Monrovia" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Atlantic/Reykjavik" | "Africa/Sao_Tome" | "Africa/Banjul" | "Africa/Algiers" | "Africa/Tunis" | "Europe/Isle_of_Man" | "Europe/Dublin" | "Europe/London" | "Europe/Jersey" | "Europe/Guernsey" | "Africa/Bangui" | "Africa/Malabo" | "Africa/Brazzaville" | "Africa/Porto-Novo" | "Africa/Douala" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Luanda" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Casablanca" | "Africa/El_Aaiun" | "Atlantic/Canary" | "Europe/Lisbon" | "Atlantic/Faroe" | "Africa/Bujumbura" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Juba" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Blantyre" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Maputo" | "Africa/Windhoek" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Gibraltar" | "Europe/Ljubljana" | "Arctic/Longyearbyen" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Monaco" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Rome" | "Europe/San_Marino" | "Europe/Malta" | "Europe/Sarajevo" | "Europe/Skopje" | "Europe/Stockholm" | "Europe/Tirane" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Europe/Kaliningrad" | "Africa/Tripoli" | "Antarctica/Troll" | "Africa/Johannesburg" | "Africa/Mbabane" | "Africa/Maseru" | "Asia/Kuwait" | "Asia/Bahrain" | "Asia/Baghdad" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Aden" | "Asia/Amman" | "Asia/Damascus" | "Africa/Addis_Ababa" | "Indian/Antananarivo" | "Africa/Asmara" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Kampala" | "Indian/Mayotte" | "Africa/Mogadishu" | "Indian/Comoro" | "Africa/Nairobi" | "Europe/Athens" | "Asia/Beirut" | "Europe/Bucharest" | "Africa/Cairo" | "Europe/Chisinau" | "Asia/Hebron" | "Europe/Helsinki" | "Europe/Kyiv" | "Europe/Mariehamn" | "Asia/Nicosia" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Asia/Jerusalem" | "Europe/Minsk" | "Europe/Moscow" | "Europe/Simferopol" | "Antarctica/Syowa" | "Europe/Istanbul" | "Asia/Tehran" | "Asia/Yerevan" | "Asia/Baku" | "Asia/Tbilisi" | "Asia/Dubai" | "Asia/Muscat" | "Indian/Mauritius" | "Indian/Reunion" | "Europe/Samara" | "Indian/Mahe" | "Asia/Kabul" | "Asia/Almaty" | "Indian/Kerguelen" | "Indian/Maldives" | "Antarctica/Mawson" | "Asia/Karachi" | "Asia/Dushanbe" | "Asia/Ashgabat" | "Asia/Tashkent" | "Antarctica/Vostok" | "Asia/Aqtobe" | "Asia/Yekaterinburg" | "Asia/Colombo" | "Asia/Kolkata" | "Asia/Kathmandu" | "Asia/Dhaka" | "Asia/Thimphu" | "Asia/Urumqi" | "Indian/Chagos" | "Asia/Bishkek" | "Asia/Omsk" | "Indian/Cocos" | "Asia/Yangon" | "Indian/Christmas" | "Antarctica/Davis" | "Asia/Hovd" | "Asia/Bangkok" | "Asia/Ho_Chi_Minh" | "Asia/Phnom_Penh" | "Asia/Vientiane" | "Asia/Novosibirsk" | "Asia/Jakarta" | "Australia/Perth" | "Asia/Brunei" | "Antarctica/Casey" | "Asia/Makassar" | "Asia/Macau" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Irkutsk" | "Asia/Kuala_Lumpur" | "Asia/Manila" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Eucla" | "Asia/Dili" | "Asia/Jayapura" | "Asia/Tokyo" | "Asia/Pyongyang" | "Asia/Seoul" | "Pacific/Palau" | "Asia/Chita" | "Australia/Adelaide" | "Australia/Darwin" | "Australia/Brisbane" | "Australia/Sydney" | "Pacific/Guam" | "Pacific/Saipan" | "Pacific/Chuuk" | "Antarctica/DumontDUrville" | "Pacific/Port_Moresby" | "Asia/Vladivostok" | "Australia/Lord_Howe" | "Pacific/Bougainville" | "Pacific/Kosrae" | "Pacific/Noumea" | "Pacific/Norfolk" | "Asia/Sakhalin" | "Pacific/Guadalcanal" | "Pacific/Efate" | "Pacific/Fiji" | "Pacific/Tarawa" | "Pacific/Majuro" | "Pacific/Nauru" | "Pacific/Auckland" | "Antarctica/McMurdo" | "Asia/Kamchatka" | "Pacific/Funafuti" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Chatham" | "Pacific/Apia" | "Pacific/Kanton" | "Pacific/Fakaofo" | "Pacific/Tongatapu" | "Pacific/Kiritimati";
|
|
3272
3320
|
/**
|
|
3273
3321
|
* @description List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.
|
|
3274
3322
|
* @example [
|
|
@@ -5146,18 +5194,6 @@ export interface components {
|
|
|
5146
5194
|
period: "days" | "weeks" | "months" | "years";
|
|
5147
5195
|
count: number | null;
|
|
5148
5196
|
} | null;
|
|
5149
|
-
/**
|
|
5150
|
-
* @description Interval used to represent the trial period of the plan.
|
|
5151
|
-
* @example {
|
|
5152
|
-
* "period": "months",
|
|
5153
|
-
* "count": 1
|
|
5154
|
-
* }
|
|
5155
|
-
*/
|
|
5156
|
-
trial_interval: {
|
|
5157
|
-
/** @enum {string} */
|
|
5158
|
-
period: "days" | "weeks" | "months" | "years";
|
|
5159
|
-
count: number;
|
|
5160
|
-
} | null;
|
|
5161
5197
|
};
|
|
5162
5198
|
PaginatedPlan: {
|
|
5163
5199
|
meta: {
|
|
@@ -5251,18 +5287,6 @@ export interface components {
|
|
|
5251
5287
|
period: "days" | "weeks" | "months" | "years";
|
|
5252
5288
|
count: number | null;
|
|
5253
5289
|
} | null;
|
|
5254
|
-
/**
|
|
5255
|
-
* @description Interval used to represent the trial period of the plan.
|
|
5256
|
-
* @example {
|
|
5257
|
-
* "period": "months",
|
|
5258
|
-
* "count": 1
|
|
5259
|
-
* }
|
|
5260
|
-
*/
|
|
5261
|
-
trial_interval: {
|
|
5262
|
-
/** @enum {string} */
|
|
5263
|
-
period: "days" | "weeks" | "months" | "years";
|
|
5264
|
-
count: number;
|
|
5265
|
-
} | null;
|
|
5266
5290
|
products: ({
|
|
5267
5291
|
/**
|
|
5268
5292
|
* @description Product ID.
|
|
@@ -6181,6 +6205,8 @@ export interface components {
|
|
|
6181
6205
|
expires_at?: components["schemas"]["DateTime"] & string;
|
|
6182
6206
|
/** @description Subscription configuration constituting the quote. */
|
|
6183
6207
|
subscription?: {
|
|
6208
|
+
/** @description Subscription custom name. */
|
|
6209
|
+
name?: string;
|
|
6184
6210
|
/** @description Reference to the purchase order. */
|
|
6185
6211
|
purchase_order?: string;
|
|
6186
6212
|
/**
|
|
@@ -6233,12 +6259,6 @@ export interface components {
|
|
|
6233
6259
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
6234
6260
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
6235
6261
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
6236
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
6237
|
-
/**
|
|
6238
|
-
* @description Delay first invoice to the end of the trial period.
|
|
6239
|
-
* @default false
|
|
6240
|
-
*/
|
|
6241
|
-
trial_delay_first_invoice: boolean | ("true" | "false");
|
|
6242
6262
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
6243
6263
|
/**
|
|
6244
6264
|
* @description
|
|
@@ -6263,6 +6283,26 @@ export interface components {
|
|
|
6263
6283
|
custom_properties?: {
|
|
6264
6284
|
[key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
|
|
6265
6285
|
};
|
|
6286
|
+
} & {
|
|
6287
|
+
/** @description Create a free trial phase based on the plan configuration. */
|
|
6288
|
+
trial?: {
|
|
6289
|
+
/**
|
|
6290
|
+
* @description Defines how the free trial will end.
|
|
6291
|
+
* @enum {string}
|
|
6292
|
+
*/
|
|
6293
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
6294
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
6295
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
6296
|
+
duration?: {
|
|
6297
|
+
/**
|
|
6298
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
6299
|
+
* @enum {string}
|
|
6300
|
+
*/
|
|
6301
|
+
period: "days" | "weeks" | "months" | "years";
|
|
6302
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
6303
|
+
count: number;
|
|
6304
|
+
};
|
|
6305
|
+
};
|
|
6266
6306
|
} & ({
|
|
6267
6307
|
phases: ({
|
|
6268
6308
|
/** @enum {string} */
|
|
@@ -6645,6 +6685,8 @@ export interface components {
|
|
|
6645
6685
|
expires_at: components["schemas"]["DateTime"] & string;
|
|
6646
6686
|
/** @description Subscription configuration constituting the quote. */
|
|
6647
6687
|
subscription: {
|
|
6688
|
+
/** @description Subscription custom name. */
|
|
6689
|
+
name?: string;
|
|
6648
6690
|
/** @description Reference to the purchase order. */
|
|
6649
6691
|
purchase_order?: string;
|
|
6650
6692
|
/**
|
|
@@ -6697,12 +6739,6 @@ export interface components {
|
|
|
6697
6739
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
6698
6740
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
6699
6741
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
6700
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
6701
|
-
/**
|
|
6702
|
-
* @description Delay first invoice to the end of the trial period.
|
|
6703
|
-
* @default false
|
|
6704
|
-
*/
|
|
6705
|
-
trial_delay_first_invoice: boolean | ("true" | "false");
|
|
6706
6742
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
6707
6743
|
/**
|
|
6708
6744
|
* @description
|
|
@@ -6727,6 +6763,26 @@ export interface components {
|
|
|
6727
6763
|
custom_properties?: {
|
|
6728
6764
|
[key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
|
|
6729
6765
|
};
|
|
6766
|
+
} & {
|
|
6767
|
+
/** @description Create a free trial phase based on the plan configuration. */
|
|
6768
|
+
trial?: {
|
|
6769
|
+
/**
|
|
6770
|
+
* @description Defines how the free trial will end.
|
|
6771
|
+
* @enum {string}
|
|
6772
|
+
*/
|
|
6773
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
6774
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
6775
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
6776
|
+
duration?: {
|
|
6777
|
+
/**
|
|
6778
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
6779
|
+
* @enum {string}
|
|
6780
|
+
*/
|
|
6781
|
+
period: "days" | "weeks" | "months" | "years";
|
|
6782
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
6783
|
+
count: number;
|
|
6784
|
+
};
|
|
6785
|
+
};
|
|
6730
6786
|
} & ({
|
|
6731
6787
|
phases: ({
|
|
6732
6788
|
/** @enum {string} */
|
|
@@ -7809,7 +7865,6 @@ export interface components {
|
|
|
7809
7865
|
renews_at: components["schemas"]["DateTime"] & unknown;
|
|
7810
7866
|
/** @description ID of the current subscription phase. */
|
|
7811
7867
|
current_phase_id: string | null;
|
|
7812
|
-
trial_ends_at: components["schemas"]["DateTime"] & unknown;
|
|
7813
7868
|
/** @description Key/value pairs to store any information you find useful. */
|
|
7814
7869
|
properties: {
|
|
7815
7870
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
@@ -8426,6 +8481,8 @@ export interface components {
|
|
|
8426
8481
|
pro_rata?: boolean;
|
|
8427
8482
|
};
|
|
8428
8483
|
CreateSubscription: {
|
|
8484
|
+
/** @description Subscription custom name. */
|
|
8485
|
+
name?: string;
|
|
8429
8486
|
/** @description Reference to the purchase order. */
|
|
8430
8487
|
purchase_order?: string;
|
|
8431
8488
|
/**
|
|
@@ -8478,12 +8535,6 @@ export interface components {
|
|
|
8478
8535
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
8479
8536
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
8480
8537
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
8481
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
8482
|
-
/**
|
|
8483
|
-
* @description Delay first invoice to the end of the trial period.
|
|
8484
|
-
* @default false
|
|
8485
|
-
*/
|
|
8486
|
-
trial_delay_first_invoice: boolean | ("true" | "false");
|
|
8487
8538
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
8488
8539
|
/**
|
|
8489
8540
|
* @description
|
|
@@ -8941,6 +8992,36 @@ export interface components {
|
|
|
8941
8992
|
*/
|
|
8942
8993
|
redirect_url?: string;
|
|
8943
8994
|
};
|
|
8995
|
+
/** @description Create a free trial phase based on the plan configuration. Only applies if a `plan_id` is provided. */
|
|
8996
|
+
trial?: {
|
|
8997
|
+
/**
|
|
8998
|
+
* @description Defines how the free trial will end.
|
|
8999
|
+
* @enum {string}
|
|
9000
|
+
*/
|
|
9001
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
9002
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
9003
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
9004
|
+
duration?: {
|
|
9005
|
+
/**
|
|
9006
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
9007
|
+
* @enum {string}
|
|
9008
|
+
*/
|
|
9009
|
+
period: "days" | "weeks" | "months" | "years";
|
|
9010
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
9011
|
+
count: number;
|
|
9012
|
+
};
|
|
9013
|
+
};
|
|
9014
|
+
/**
|
|
9015
|
+
* @description
|
|
9016
|
+
* Alignment of product billing cycles. Only applies when creating a subscription from a plan.
|
|
9017
|
+
*
|
|
9018
|
+
* - `calendar_period`: The billing cycles of the products will be aligned on the calendar period, after the first period which will be invoiced taking into account the prorata of the first cycle compared to the product periodicity.
|
|
9019
|
+
* - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.
|
|
9020
|
+
*
|
|
9021
|
+
* @default anniversary
|
|
9022
|
+
* @enum {string}
|
|
9023
|
+
*/
|
|
9024
|
+
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
8944
9025
|
};
|
|
8945
9026
|
PaginatedSubscription: {
|
|
8946
9027
|
meta: {
|
|
@@ -9715,6 +9796,14 @@ export interface operations {
|
|
|
9715
9796
|
settledAt__lte?: string;
|
|
9716
9797
|
settledAt__gt?: string;
|
|
9717
9798
|
settledAt__gte?: string;
|
|
9799
|
+
originalQuoteId?: string;
|
|
9800
|
+
originalQuoteId__not?: string;
|
|
9801
|
+
originalQuoteId__isNull?: string;
|
|
9802
|
+
originalQuoteId__isNotNull?: string;
|
|
9803
|
+
originalQuoteId__equals?: string;
|
|
9804
|
+
originalQuoteId__contains?: string;
|
|
9805
|
+
originalQuoteId__startsWith?: string;
|
|
9806
|
+
originalQuoteId__endWith?: string;
|
|
9718
9807
|
subscriptionId?: string;
|
|
9719
9808
|
subscriptionId__not?: string;
|
|
9720
9809
|
subscriptionId__isNull?: string;
|
|
@@ -11182,7 +11271,7 @@ export interface operations {
|
|
|
11182
11271
|
* @description Provider name.
|
|
11183
11272
|
* @enum {string}
|
|
11184
11273
|
*/
|
|
11185
|
-
provider_name: "mollie" | "stripe" | "gocardless" | "airwallex" | "hubspot" | "salesforce";
|
|
11274
|
+
provider_name: "mollie" | "stripe" | "gocardless" | "airwallex" | "hubspot" | "salesforce" | "xero" | "exact-online" | "pennylane";
|
|
11186
11275
|
/** @description Provider ID. Required if multiple instances of the same provider are connected in Hyperline. */
|
|
11187
11276
|
provider_id?: string;
|
|
11188
11277
|
/** @description ID of the customer on the provider side. Using a null value will reset the previously saved ID. */
|
|
@@ -13023,6 +13112,8 @@ export interface operations {
|
|
|
13023
13112
|
expires_at?: components["schemas"]["DateTime"] & string;
|
|
13024
13113
|
/** @description Subscription configuration constituting the quote. */
|
|
13025
13114
|
subscription?: {
|
|
13115
|
+
/** @description Subscription custom name. */
|
|
13116
|
+
name?: string;
|
|
13026
13117
|
/** @description Reference to the purchase order. */
|
|
13027
13118
|
purchase_order?: string;
|
|
13028
13119
|
/**
|
|
@@ -13075,12 +13166,6 @@ export interface operations {
|
|
|
13075
13166
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
13076
13167
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
13077
13168
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
13078
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
13079
|
-
/**
|
|
13080
|
-
* @description Delay first invoice to the end of the trial period.
|
|
13081
|
-
* @default false
|
|
13082
|
-
*/
|
|
13083
|
-
trial_delay_first_invoice?: boolean | ("true" | "false");
|
|
13084
13169
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
13085
13170
|
/**
|
|
13086
13171
|
* @description
|
|
@@ -13105,6 +13190,26 @@ export interface operations {
|
|
|
13105
13190
|
custom_properties?: {
|
|
13106
13191
|
[key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
|
|
13107
13192
|
};
|
|
13193
|
+
} & {
|
|
13194
|
+
/** @description Create a free trial phase based on the plan configuration. */
|
|
13195
|
+
trial?: {
|
|
13196
|
+
/**
|
|
13197
|
+
* @description Defines how the free trial will end.
|
|
13198
|
+
* @enum {string}
|
|
13199
|
+
*/
|
|
13200
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
13201
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
13202
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
13203
|
+
duration?: {
|
|
13204
|
+
/**
|
|
13205
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
13206
|
+
* @enum {string}
|
|
13207
|
+
*/
|
|
13208
|
+
period: "days" | "weeks" | "months" | "years";
|
|
13209
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
13210
|
+
count: number;
|
|
13211
|
+
};
|
|
13212
|
+
};
|
|
13108
13213
|
} & ({
|
|
13109
13214
|
phases: ({
|
|
13110
13215
|
/** @enum {string} */
|
|
@@ -13487,6 +13592,8 @@ export interface operations {
|
|
|
13487
13592
|
expires_at: components["schemas"]["DateTime"] & string;
|
|
13488
13593
|
/** @description Subscription configuration constituting the quote. */
|
|
13489
13594
|
subscription: {
|
|
13595
|
+
/** @description Subscription custom name. */
|
|
13596
|
+
name?: string;
|
|
13490
13597
|
/** @description Reference to the purchase order. */
|
|
13491
13598
|
purchase_order?: string;
|
|
13492
13599
|
/**
|
|
@@ -13539,12 +13646,6 @@ export interface operations {
|
|
|
13539
13646
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
13540
13647
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
13541
13648
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
13542
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
13543
|
-
/**
|
|
13544
|
-
* @description Delay first invoice to the end of the trial period.
|
|
13545
|
-
* @default false
|
|
13546
|
-
*/
|
|
13547
|
-
trial_delay_first_invoice?: boolean | ("true" | "false");
|
|
13548
13649
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
13549
13650
|
/**
|
|
13550
13651
|
* @description
|
|
@@ -13569,6 +13670,26 @@ export interface operations {
|
|
|
13569
13670
|
custom_properties?: {
|
|
13570
13671
|
[key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
|
|
13571
13672
|
};
|
|
13673
|
+
} & {
|
|
13674
|
+
/** @description Create a free trial phase based on the plan configuration. */
|
|
13675
|
+
trial?: {
|
|
13676
|
+
/**
|
|
13677
|
+
* @description Defines how the free trial will end.
|
|
13678
|
+
* @enum {string}
|
|
13679
|
+
*/
|
|
13680
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
13681
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
13682
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
13683
|
+
duration?: {
|
|
13684
|
+
/**
|
|
13685
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
13686
|
+
* @enum {string}
|
|
13687
|
+
*/
|
|
13688
|
+
period: "days" | "weeks" | "months" | "years";
|
|
13689
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
13690
|
+
count: number;
|
|
13691
|
+
};
|
|
13692
|
+
};
|
|
13572
13693
|
} & ({
|
|
13573
13694
|
phases: ({
|
|
13574
13695
|
/** @enum {string} */
|
|
@@ -14820,6 +14941,8 @@ export interface operations {
|
|
|
14820
14941
|
requestBody?: {
|
|
14821
14942
|
content: {
|
|
14822
14943
|
"application/json": {
|
|
14944
|
+
/** @description Subscription custom name. */
|
|
14945
|
+
name?: string | null;
|
|
14823
14946
|
/** @description Reference to the purchase order. */
|
|
14824
14947
|
purchase_order?: string | null;
|
|
14825
14948
|
/** @description Minimum fee applied to each invoice outside of one time payments. */
|
|
@@ -14840,7 +14963,6 @@ export interface operations {
|
|
|
14840
14963
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
14841
14964
|
contract_end?: components["schemas"]["DateTime"] & unknown;
|
|
14842
14965
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
14843
|
-
trial_ends_at?: components["schemas"]["DateTime"] & unknown;
|
|
14844
14966
|
cancel_at?: components["schemas"]["DateTime"] & unknown;
|
|
14845
14967
|
/** @description Key/value pairs to store any information you find useful. */
|
|
14846
14968
|
properties?: {
|