@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
package/src/_types.generated.ts
CHANGED
|
@@ -1903,12 +1903,13 @@ export interface components {
|
|
|
1903
1903
|
tax_rate: number;
|
|
1904
1904
|
tax_amount: components["schemas"]["Amount"] & unknown;
|
|
1905
1905
|
/**
|
|
1906
|
-
* @description
|
|
1907
|
-
*
|
|
1906
|
+
* @description Tax scheme of the invoice.
|
|
1907
|
+
*
|
|
1908
|
+
* - `standard`: Tax rate is resolved depending on local tax regulations.
|
|
1908
1909
|
* - `exempt`: No tax rate applied because the customer country doesn't require it.
|
|
1909
1910
|
* - `reverse_charge`: No tax rate applied because the customer is eligible to EU reverse charge.
|
|
1910
1911
|
* - `manual`: Tax rate has been manually specified when creating the invoice.
|
|
1911
|
-
* - `not_eligible`:
|
|
1912
|
+
* - `not_eligible`: Tax collection is disabled for the invoice.
|
|
1912
1913
|
*
|
|
1913
1914
|
* @example standard
|
|
1914
1915
|
* @enum {string}
|
|
@@ -2367,18 +2368,6 @@ export interface components {
|
|
|
2367
2368
|
*/
|
|
2368
2369
|
customer_id: string;
|
|
2369
2370
|
currency?: components["schemas"]["Currency"] & unknown;
|
|
2370
|
-
/**
|
|
2371
|
-
* @description ID of the invoicing entity attached to the invoice.
|
|
2372
|
-
* @example ive_47484fjdhy5
|
|
2373
|
-
*/
|
|
2374
|
-
invoicing_entity_id?: string;
|
|
2375
|
-
/**
|
|
2376
|
-
* @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.
|
|
2377
|
-
* @example INV-35
|
|
2378
|
-
*/
|
|
2379
|
-
number?: string;
|
|
2380
|
-
/** @enum {string} */
|
|
2381
|
-
type?: "invoice" | "credit_note" | "document";
|
|
2382
2371
|
/**
|
|
2383
2372
|
* @description Current invoice status.
|
|
2384
2373
|
*
|
|
@@ -2400,6 +2389,29 @@ export interface components {
|
|
|
2400
2389
|
* @enum {string}
|
|
2401
2390
|
*/
|
|
2402
2391
|
status: "to_pay" | "paid" | "draft";
|
|
2392
|
+
/**
|
|
2393
|
+
* @description ID of the invoicing entity attached to the invoice.
|
|
2394
|
+
* @example ive_47484fjdhy5
|
|
2395
|
+
*/
|
|
2396
|
+
invoicing_entity_id?: string;
|
|
2397
|
+
/**
|
|
2398
|
+
* @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.
|
|
2399
|
+
* @example INV-35
|
|
2400
|
+
*/
|
|
2401
|
+
number?: string;
|
|
2402
|
+
/**
|
|
2403
|
+
* @description Type of the invoice.
|
|
2404
|
+
*
|
|
2405
|
+
* - `invoice`: Legal invoice to be paid by your customer.
|
|
2406
|
+
* - `credit_note`: Legal credit note cancelling an invoice and refunding your customer.
|
|
2407
|
+
* - `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.
|
|
2408
|
+
*
|
|
2409
|
+
* @example invoice
|
|
2410
|
+
* @enum {string}
|
|
2411
|
+
*/
|
|
2412
|
+
type?: "invoice" | "credit_note" | "document";
|
|
2413
|
+
/** @description If the invoice is of type `document` you can give it a custom name (displayed on the final PDF). */
|
|
2414
|
+
document_name?: string;
|
|
2403
2415
|
/**
|
|
2404
2416
|
* @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.
|
|
2405
2417
|
* @example V0KAHOU6J3
|
|
@@ -2410,11 +2422,27 @@ export interface components {
|
|
|
2410
2422
|
* @example PO-12345
|
|
2411
2423
|
*/
|
|
2412
2424
|
purchase_order?: string;
|
|
2425
|
+
/**
|
|
2426
|
+
* @description Custom note added to the invoice.
|
|
2427
|
+
* @example Thank you for your purchase!
|
|
2428
|
+
*/
|
|
2429
|
+
custom_note?: string;
|
|
2413
2430
|
/**
|
|
2414
2431
|
* @description Tax rate of the invoice.
|
|
2415
2432
|
* @example 20
|
|
2416
2433
|
*/
|
|
2417
2434
|
tax_rate?: number;
|
|
2435
|
+
/**
|
|
2436
|
+
* @description Tax scheme of the invoice.
|
|
2437
|
+
*
|
|
2438
|
+
* - `auto`: Tax is automatically computed and applied.
|
|
2439
|
+
* - `not_eligible`: Tax collection is disabled for the invoice.
|
|
2440
|
+
*
|
|
2441
|
+
* @default auto
|
|
2442
|
+
* @example auto
|
|
2443
|
+
* @enum {string}
|
|
2444
|
+
*/
|
|
2445
|
+
tax_scheme: "auto" | "not_eligible";
|
|
2418
2446
|
/**
|
|
2419
2447
|
* @description
|
|
2420
2448
|
* Payment method strategy used to charge the invoice. Only applies to `to_pay` status.
|
|
@@ -2435,13 +2463,21 @@ export interface components {
|
|
|
2435
2463
|
due_at?: components["schemas"]["DateTime"] & string;
|
|
2436
2464
|
settled_at?: components["schemas"]["DateTime"] & string;
|
|
2437
2465
|
line_items: components["schemas"]["CreateInvoiceLineItem"][];
|
|
2438
|
-
/**
|
|
2439
|
-
* @description Custom note added to the invoice.
|
|
2440
|
-
* @example Thank you for your purchase!
|
|
2441
|
-
*/
|
|
2442
|
-
custom_note?: string;
|
|
2443
2466
|
};
|
|
2444
2467
|
UpdateInvoice: {
|
|
2468
|
+
/**
|
|
2469
|
+
* @description Type of the invoice.
|
|
2470
|
+
*
|
|
2471
|
+
* - `invoice`: Legal invoice to be paid by your customer.
|
|
2472
|
+
* - `credit_note`: Legal credit note cancelling an invoice and refunding your customer.
|
|
2473
|
+
* - `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.
|
|
2474
|
+
*
|
|
2475
|
+
* @example invoice
|
|
2476
|
+
* @enum {string}
|
|
2477
|
+
*/
|
|
2478
|
+
type?: "invoice" | "credit_note" | "document";
|
|
2479
|
+
/** @description If the invoice is of type `document` you can give it a custom name (displayed on the final PDF). */
|
|
2480
|
+
document_name?: string | null;
|
|
2445
2481
|
/**
|
|
2446
2482
|
* @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.
|
|
2447
2483
|
* @example V0KAHOU6J3
|
|
@@ -2457,6 +2493,18 @@ export interface components {
|
|
|
2457
2493
|
* @example Thank you for your purchase!
|
|
2458
2494
|
*/
|
|
2459
2495
|
custom_note?: string | null;
|
|
2496
|
+
/**
|
|
2497
|
+
* @description Tax scheme of the invoice.
|
|
2498
|
+
*
|
|
2499
|
+
* - `auto`: Tax is automatically computed and applied.
|
|
2500
|
+
* - `not_eligible`: Tax collection is disabled for the invoice.
|
|
2501
|
+
*
|
|
2502
|
+
* @default auto
|
|
2503
|
+
* @example auto
|
|
2504
|
+
* @enum {string}
|
|
2505
|
+
*/
|
|
2506
|
+
tax_scheme: "auto" | "not_eligible";
|
|
2507
|
+
line_items?: components["schemas"]["CreateInvoiceLineItem"][];
|
|
2460
2508
|
};
|
|
2461
2509
|
/** @description A file in binary format. Accepted MIME types: application/pdf. Max size: 5000000 bytes. */
|
|
2462
2510
|
File: unknown;
|
|
@@ -2929,7 +2977,7 @@ export interface components {
|
|
|
2929
2977
|
* @example Europe/Paris
|
|
2930
2978
|
* @enum {string|null}
|
|
2931
2979
|
*/
|
|
2932
|
-
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" | "
|
|
2980
|
+
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;
|
|
2933
2981
|
/** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */
|
|
2934
2982
|
external_id: string | null;
|
|
2935
2983
|
/** @description Key/value pairs to store any information you find useful. */
|
|
@@ -3167,7 +3215,7 @@ export interface components {
|
|
|
3167
3215
|
* @example Europe/Paris
|
|
3168
3216
|
* @enum {string}
|
|
3169
3217
|
*/
|
|
3170
|
-
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" | "
|
|
3218
|
+
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";
|
|
3171
3219
|
/**
|
|
3172
3220
|
* @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.
|
|
3173
3221
|
* @example [
|
|
@@ -3269,7 +3317,7 @@ export interface components {
|
|
|
3269
3317
|
* @example Europe/Paris
|
|
3270
3318
|
* @enum {string}
|
|
3271
3319
|
*/
|
|
3272
|
-
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" | "
|
|
3320
|
+
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";
|
|
3273
3321
|
/**
|
|
3274
3322
|
* @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.
|
|
3275
3323
|
* @example [
|
|
@@ -5147,18 +5195,6 @@ export interface components {
|
|
|
5147
5195
|
period: "days" | "weeks" | "months" | "years";
|
|
5148
5196
|
count: number | null;
|
|
5149
5197
|
} | null;
|
|
5150
|
-
/**
|
|
5151
|
-
* @description Interval used to represent the trial period of the plan.
|
|
5152
|
-
* @example {
|
|
5153
|
-
* "period": "months",
|
|
5154
|
-
* "count": 1
|
|
5155
|
-
* }
|
|
5156
|
-
*/
|
|
5157
|
-
trial_interval: {
|
|
5158
|
-
/** @enum {string} */
|
|
5159
|
-
period: "days" | "weeks" | "months" | "years";
|
|
5160
|
-
count: number;
|
|
5161
|
-
} | null;
|
|
5162
5198
|
};
|
|
5163
5199
|
PaginatedPlan: {
|
|
5164
5200
|
meta: {
|
|
@@ -5252,18 +5288,6 @@ export interface components {
|
|
|
5252
5288
|
period: "days" | "weeks" | "months" | "years";
|
|
5253
5289
|
count: number | null;
|
|
5254
5290
|
} | null;
|
|
5255
|
-
/**
|
|
5256
|
-
* @description Interval used to represent the trial period of the plan.
|
|
5257
|
-
* @example {
|
|
5258
|
-
* "period": "months",
|
|
5259
|
-
* "count": 1
|
|
5260
|
-
* }
|
|
5261
|
-
*/
|
|
5262
|
-
trial_interval: {
|
|
5263
|
-
/** @enum {string} */
|
|
5264
|
-
period: "days" | "weeks" | "months" | "years";
|
|
5265
|
-
count: number;
|
|
5266
|
-
} | null;
|
|
5267
5291
|
products: ({
|
|
5268
5292
|
/**
|
|
5269
5293
|
* @description Product ID.
|
|
@@ -6182,6 +6206,8 @@ export interface components {
|
|
|
6182
6206
|
expires_at?: components["schemas"]["DateTime"] & string;
|
|
6183
6207
|
/** @description Subscription configuration constituting the quote. */
|
|
6184
6208
|
subscription?: {
|
|
6209
|
+
/** @description Subscription custom name. */
|
|
6210
|
+
name?: string;
|
|
6185
6211
|
/** @description Reference to the purchase order. */
|
|
6186
6212
|
purchase_order?: string;
|
|
6187
6213
|
/**
|
|
@@ -6234,12 +6260,6 @@ export interface components {
|
|
|
6234
6260
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
6235
6261
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
6236
6262
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
6237
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
6238
|
-
/**
|
|
6239
|
-
* @description Delay first invoice to the end of the trial period.
|
|
6240
|
-
* @default false
|
|
6241
|
-
*/
|
|
6242
|
-
trial_delay_first_invoice: boolean | ("true" | "false");
|
|
6243
6263
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
6244
6264
|
/**
|
|
6245
6265
|
* @description
|
|
@@ -6264,6 +6284,26 @@ export interface components {
|
|
|
6264
6284
|
custom_properties?: {
|
|
6265
6285
|
[key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
|
|
6266
6286
|
};
|
|
6287
|
+
} & {
|
|
6288
|
+
/** @description Create a free trial phase based on the plan configuration. */
|
|
6289
|
+
trial?: {
|
|
6290
|
+
/**
|
|
6291
|
+
* @description Defines how the free trial will end.
|
|
6292
|
+
* @enum {string}
|
|
6293
|
+
*/
|
|
6294
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
6295
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
6296
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
6297
|
+
duration?: {
|
|
6298
|
+
/**
|
|
6299
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
6300
|
+
* @enum {string}
|
|
6301
|
+
*/
|
|
6302
|
+
period: "days" | "weeks" | "months" | "years";
|
|
6303
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
6304
|
+
count: number;
|
|
6305
|
+
};
|
|
6306
|
+
};
|
|
6267
6307
|
} & ({
|
|
6268
6308
|
phases: ({
|
|
6269
6309
|
/** @enum {string} */
|
|
@@ -6646,6 +6686,8 @@ export interface components {
|
|
|
6646
6686
|
expires_at: components["schemas"]["DateTime"] & string;
|
|
6647
6687
|
/** @description Subscription configuration constituting the quote. */
|
|
6648
6688
|
subscription: {
|
|
6689
|
+
/** @description Subscription custom name. */
|
|
6690
|
+
name?: string;
|
|
6649
6691
|
/** @description Reference to the purchase order. */
|
|
6650
6692
|
purchase_order?: string;
|
|
6651
6693
|
/**
|
|
@@ -6698,12 +6740,6 @@ export interface components {
|
|
|
6698
6740
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
6699
6741
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
6700
6742
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
6701
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
6702
|
-
/**
|
|
6703
|
-
* @description Delay first invoice to the end of the trial period.
|
|
6704
|
-
* @default false
|
|
6705
|
-
*/
|
|
6706
|
-
trial_delay_first_invoice: boolean | ("true" | "false");
|
|
6707
6743
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
6708
6744
|
/**
|
|
6709
6745
|
* @description
|
|
@@ -6728,6 +6764,26 @@ export interface components {
|
|
|
6728
6764
|
custom_properties?: {
|
|
6729
6765
|
[key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
|
|
6730
6766
|
};
|
|
6767
|
+
} & {
|
|
6768
|
+
/** @description Create a free trial phase based on the plan configuration. */
|
|
6769
|
+
trial?: {
|
|
6770
|
+
/**
|
|
6771
|
+
* @description Defines how the free trial will end.
|
|
6772
|
+
* @enum {string}
|
|
6773
|
+
*/
|
|
6774
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
6775
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
6776
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
6777
|
+
duration?: {
|
|
6778
|
+
/**
|
|
6779
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
6780
|
+
* @enum {string}
|
|
6781
|
+
*/
|
|
6782
|
+
period: "days" | "weeks" | "months" | "years";
|
|
6783
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
6784
|
+
count: number;
|
|
6785
|
+
};
|
|
6786
|
+
};
|
|
6731
6787
|
} & ({
|
|
6732
6788
|
phases: ({
|
|
6733
6789
|
/** @enum {string} */
|
|
@@ -7810,7 +7866,6 @@ export interface components {
|
|
|
7810
7866
|
renews_at: components["schemas"]["DateTime"] & unknown;
|
|
7811
7867
|
/** @description ID of the current subscription phase. */
|
|
7812
7868
|
current_phase_id: string | null;
|
|
7813
|
-
trial_ends_at: components["schemas"]["DateTime"] & unknown;
|
|
7814
7869
|
/** @description Key/value pairs to store any information you find useful. */
|
|
7815
7870
|
properties: {
|
|
7816
7871
|
[key: string]: string | number | boolean | null | (string | number | boolean | null)[];
|
|
@@ -8427,6 +8482,8 @@ export interface components {
|
|
|
8427
8482
|
pro_rata?: boolean;
|
|
8428
8483
|
};
|
|
8429
8484
|
CreateSubscription: {
|
|
8485
|
+
/** @description Subscription custom name. */
|
|
8486
|
+
name?: string;
|
|
8430
8487
|
/** @description Reference to the purchase order. */
|
|
8431
8488
|
purchase_order?: string;
|
|
8432
8489
|
/**
|
|
@@ -8479,12 +8536,6 @@ export interface components {
|
|
|
8479
8536
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
8480
8537
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
8481
8538
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
8482
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
8483
|
-
/**
|
|
8484
|
-
* @description Delay first invoice to the end of the trial period.
|
|
8485
|
-
* @default false
|
|
8486
|
-
*/
|
|
8487
|
-
trial_delay_first_invoice: boolean | ("true" | "false");
|
|
8488
8539
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
8489
8540
|
/**
|
|
8490
8541
|
* @description
|
|
@@ -8942,6 +8993,36 @@ export interface components {
|
|
|
8942
8993
|
*/
|
|
8943
8994
|
redirect_url?: string;
|
|
8944
8995
|
};
|
|
8996
|
+
/** @description Create a free trial phase based on the plan configuration. Only applies if a `plan_id` is provided. */
|
|
8997
|
+
trial?: {
|
|
8998
|
+
/**
|
|
8999
|
+
* @description Defines how the free trial will end.
|
|
9000
|
+
* @enum {string}
|
|
9001
|
+
*/
|
|
9002
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
9003
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
9004
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
9005
|
+
duration?: {
|
|
9006
|
+
/**
|
|
9007
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
9008
|
+
* @enum {string}
|
|
9009
|
+
*/
|
|
9010
|
+
period: "days" | "weeks" | "months" | "years";
|
|
9011
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
9012
|
+
count: number;
|
|
9013
|
+
};
|
|
9014
|
+
};
|
|
9015
|
+
/**
|
|
9016
|
+
* @description
|
|
9017
|
+
* Alignment of product billing cycles. Only applies when creating a subscription from a plan.
|
|
9018
|
+
*
|
|
9019
|
+
* - `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.
|
|
9020
|
+
* - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.
|
|
9021
|
+
*
|
|
9022
|
+
* @default anniversary
|
|
9023
|
+
* @enum {string}
|
|
9024
|
+
*/
|
|
9025
|
+
billing_cycle_alignment: "calendar_period" | "anniversary";
|
|
8945
9026
|
};
|
|
8946
9027
|
PaginatedSubscription: {
|
|
8947
9028
|
meta: {
|
|
@@ -9716,6 +9797,14 @@ export interface operations {
|
|
|
9716
9797
|
settledAt__lte?: string;
|
|
9717
9798
|
settledAt__gt?: string;
|
|
9718
9799
|
settledAt__gte?: string;
|
|
9800
|
+
originalQuoteId?: string;
|
|
9801
|
+
originalQuoteId__not?: string;
|
|
9802
|
+
originalQuoteId__isNull?: string;
|
|
9803
|
+
originalQuoteId__isNotNull?: string;
|
|
9804
|
+
originalQuoteId__equals?: string;
|
|
9805
|
+
originalQuoteId__contains?: string;
|
|
9806
|
+
originalQuoteId__startsWith?: string;
|
|
9807
|
+
originalQuoteId__endWith?: string;
|
|
9719
9808
|
subscriptionId?: string;
|
|
9720
9809
|
subscriptionId__not?: string;
|
|
9721
9810
|
subscriptionId__isNull?: string;
|
|
@@ -11183,7 +11272,7 @@ export interface operations {
|
|
|
11183
11272
|
* @description Provider name.
|
|
11184
11273
|
* @enum {string}
|
|
11185
11274
|
*/
|
|
11186
|
-
provider_name: "mollie" | "stripe" | "gocardless" | "airwallex" | "hubspot" | "salesforce";
|
|
11275
|
+
provider_name: "mollie" | "stripe" | "gocardless" | "airwallex" | "hubspot" | "salesforce" | "xero" | "exact-online" | "pennylane";
|
|
11187
11276
|
/** @description Provider ID. Required if multiple instances of the same provider are connected in Hyperline. */
|
|
11188
11277
|
provider_id?: string;
|
|
11189
11278
|
/** @description ID of the customer on the provider side. Using a null value will reset the previously saved ID. */
|
|
@@ -13024,6 +13113,8 @@ export interface operations {
|
|
|
13024
13113
|
expires_at?: components["schemas"]["DateTime"] & string;
|
|
13025
13114
|
/** @description Subscription configuration constituting the quote. */
|
|
13026
13115
|
subscription?: {
|
|
13116
|
+
/** @description Subscription custom name. */
|
|
13117
|
+
name?: string;
|
|
13027
13118
|
/** @description Reference to the purchase order. */
|
|
13028
13119
|
purchase_order?: string;
|
|
13029
13120
|
/**
|
|
@@ -13076,12 +13167,6 @@ export interface operations {
|
|
|
13076
13167
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
13077
13168
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
13078
13169
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
13079
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
13080
|
-
/**
|
|
13081
|
-
* @description Delay first invoice to the end of the trial period.
|
|
13082
|
-
* @default false
|
|
13083
|
-
*/
|
|
13084
|
-
trial_delay_first_invoice?: boolean | ("true" | "false");
|
|
13085
13170
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
13086
13171
|
/**
|
|
13087
13172
|
* @description
|
|
@@ -13106,6 +13191,26 @@ export interface operations {
|
|
|
13106
13191
|
custom_properties?: {
|
|
13107
13192
|
[key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
|
|
13108
13193
|
};
|
|
13194
|
+
} & {
|
|
13195
|
+
/** @description Create a free trial phase based on the plan configuration. */
|
|
13196
|
+
trial?: {
|
|
13197
|
+
/**
|
|
13198
|
+
* @description Defines how the free trial will end.
|
|
13199
|
+
* @enum {string}
|
|
13200
|
+
*/
|
|
13201
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
13202
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
13203
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
13204
|
+
duration?: {
|
|
13205
|
+
/**
|
|
13206
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
13207
|
+
* @enum {string}
|
|
13208
|
+
*/
|
|
13209
|
+
period: "days" | "weeks" | "months" | "years";
|
|
13210
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
13211
|
+
count: number;
|
|
13212
|
+
};
|
|
13213
|
+
};
|
|
13109
13214
|
} & ({
|
|
13110
13215
|
phases: ({
|
|
13111
13216
|
/** @enum {string} */
|
|
@@ -13488,6 +13593,8 @@ export interface operations {
|
|
|
13488
13593
|
expires_at: components["schemas"]["DateTime"] & string;
|
|
13489
13594
|
/** @description Subscription configuration constituting the quote. */
|
|
13490
13595
|
subscription: {
|
|
13596
|
+
/** @description Subscription custom name. */
|
|
13597
|
+
name?: string;
|
|
13491
13598
|
/** @description Reference to the purchase order. */
|
|
13492
13599
|
purchase_order?: string;
|
|
13493
13600
|
/**
|
|
@@ -13540,12 +13647,6 @@ export interface operations {
|
|
|
13540
13647
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
13541
13648
|
contract_end?: components["schemas"]["DateTime"] & string;
|
|
13542
13649
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
13543
|
-
trial_ends_at?: components["schemas"]["DateTime"] & string;
|
|
13544
|
-
/**
|
|
13545
|
-
* @description Delay first invoice to the end of the trial period.
|
|
13546
|
-
* @default false
|
|
13547
|
-
*/
|
|
13548
|
-
trial_delay_first_invoice?: boolean | ("true" | "false");
|
|
13549
13650
|
cancel_at?: components["schemas"]["DateTime"] & string;
|
|
13550
13651
|
/**
|
|
13551
13652
|
* @description
|
|
@@ -13570,6 +13671,26 @@ export interface operations {
|
|
|
13570
13671
|
custom_properties?: {
|
|
13571
13672
|
[key: string]: string | number | boolean | (components["schemas"]["DateTime"] & string) | null;
|
|
13572
13673
|
};
|
|
13674
|
+
} & {
|
|
13675
|
+
/** @description Create a free trial phase based on the plan configuration. */
|
|
13676
|
+
trial?: {
|
|
13677
|
+
/**
|
|
13678
|
+
* @description Defines how the free trial will end.
|
|
13679
|
+
* @enum {string}
|
|
13680
|
+
*/
|
|
13681
|
+
end_strategy: "manual" | "end_date" | "duration";
|
|
13682
|
+
starts_at?: components["schemas"]["DateTime"] & string;
|
|
13683
|
+
ends_at?: components["schemas"]["DateTime"] & string;
|
|
13684
|
+
duration?: {
|
|
13685
|
+
/**
|
|
13686
|
+
* @description Free trial duration period. Only applies if the end strategy is `duration`.
|
|
13687
|
+
* @enum {string}
|
|
13688
|
+
*/
|
|
13689
|
+
period: "days" | "weeks" | "months" | "years";
|
|
13690
|
+
/** @description Free trial duration count. Only applies if the end strategy is `duration`. */
|
|
13691
|
+
count: number;
|
|
13692
|
+
};
|
|
13693
|
+
};
|
|
13573
13694
|
} & ({
|
|
13574
13695
|
phases: ({
|
|
13575
13696
|
/** @enum {string} */
|
|
@@ -14821,6 +14942,8 @@ export interface operations {
|
|
|
14821
14942
|
requestBody?: {
|
|
14822
14943
|
content: {
|
|
14823
14944
|
"application/json": {
|
|
14945
|
+
/** @description Subscription custom name. */
|
|
14946
|
+
name?: string | null;
|
|
14824
14947
|
/** @description Reference to the purchase order. */
|
|
14825
14948
|
purchase_order?: string | null;
|
|
14826
14949
|
/** @description Minimum fee applied to each invoice outside of one time payments. */
|
|
@@ -14841,7 +14964,6 @@ export interface operations {
|
|
|
14841
14964
|
contract_start?: components["schemas"]["DateTime"] & string;
|
|
14842
14965
|
contract_end?: components["schemas"]["DateTime"] & unknown;
|
|
14843
14966
|
initial_billing_at?: components["schemas"]["DateTime"] & string;
|
|
14844
|
-
trial_ends_at?: components["schemas"]["DateTime"] & unknown;
|
|
14845
14967
|
cancel_at?: components["schemas"]["DateTime"] & unknown;
|
|
14846
14968
|
/** @description Key/value pairs to store any information you find useful. */
|
|
14847
14969
|
properties?: {
|