lago-javascript-client 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/openapi/client.d.ts
CHANGED
|
@@ -2380,6 +2380,66 @@ export interface GroupsPaginated {
|
|
|
2380
2380
|
groups: GroupObject[];
|
|
2381
2381
|
meta: PaginationMeta;
|
|
2382
2382
|
}
|
|
2383
|
+
/** Minimum commitment for this plan. */
|
|
2384
|
+
export type MinimumCommitmentInput = {
|
|
2385
|
+
/**
|
|
2386
|
+
* The amount of the minimum commitment in cents.
|
|
2387
|
+
* @example 100000
|
|
2388
|
+
*/
|
|
2389
|
+
amount_cents: number;
|
|
2390
|
+
/**
|
|
2391
|
+
* Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
|
|
2392
|
+
* @example "Minimum Commitment (C1)"
|
|
2393
|
+
*/
|
|
2394
|
+
invoice_display_name?: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* List of unique code used to identify the taxes.
|
|
2397
|
+
* @example ["french_standard_vat"]
|
|
2398
|
+
*/
|
|
2399
|
+
tax_codes?: string[];
|
|
2400
|
+
} | null;
|
|
2401
|
+
export type MinimumCommitmentObject = {
|
|
2402
|
+
/**
|
|
2403
|
+
* Unique identifier of the minimum commitment, created by Lago.
|
|
2404
|
+
* @format uuid
|
|
2405
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
2406
|
+
*/
|
|
2407
|
+
lago_id: string;
|
|
2408
|
+
/**
|
|
2409
|
+
* The unique code representing the plan to be attached to the customer.
|
|
2410
|
+
* @example "premium"
|
|
2411
|
+
*/
|
|
2412
|
+
plan_code?: string;
|
|
2413
|
+
/**
|
|
2414
|
+
* The amount of the minimum commitment in cents.
|
|
2415
|
+
* @example 100000
|
|
2416
|
+
*/
|
|
2417
|
+
amount_cents: number;
|
|
2418
|
+
/**
|
|
2419
|
+
* Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
|
|
2420
|
+
* @example "Minimum Commitment (C1)"
|
|
2421
|
+
*/
|
|
2422
|
+
invoice_display_name?: string;
|
|
2423
|
+
/**
|
|
2424
|
+
* The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `quarterly`, `monthly` or `weekly`.
|
|
2425
|
+
* @example "monthly"
|
|
2426
|
+
*/
|
|
2427
|
+
interval?: "weekly" | "monthly" | "quarterly" | "yearly";
|
|
2428
|
+
/**
|
|
2429
|
+
* The date and time when the minimum commitment was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.
|
|
2430
|
+
* @format date-time
|
|
2431
|
+
* @example "2022-04-29T08:59:51Z"
|
|
2432
|
+
*/
|
|
2433
|
+
created_at: string;
|
|
2434
|
+
/**
|
|
2435
|
+
* The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.
|
|
2436
|
+
* @format date-time
|
|
2437
|
+
* @example "2022-04-29T08:59:51Z"
|
|
2438
|
+
*/
|
|
2439
|
+
updated_at?: string;
|
|
2440
|
+
/** All taxes applied to the minimum commitment. */
|
|
2441
|
+
taxes?: TaxObject[];
|
|
2442
|
+
} | null;
|
|
2383
2443
|
export interface MrrObject {
|
|
2384
2444
|
/**
|
|
2385
2445
|
* Identifies the month to analyze MRR.
|
|
@@ -2982,6 +3042,8 @@ export interface PlanCreateInput {
|
|
|
2982
3042
|
* @example ["french_standard_vat"]
|
|
2983
3043
|
*/
|
|
2984
3044
|
tax_codes?: string[];
|
|
3045
|
+
/** Minimum commitment for this plan. */
|
|
3046
|
+
minimum_commitment?: MinimumCommitmentInput;
|
|
2985
3047
|
/**
|
|
2986
3048
|
* Additional usage-based charges for this plan.
|
|
2987
3049
|
* @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
@@ -3081,6 +3143,7 @@ export interface PlanOverridesObject {
|
|
|
3081
3143
|
* @example 5
|
|
3082
3144
|
*/
|
|
3083
3145
|
trial_period?: number;
|
|
3146
|
+
minimum_commitment?: MinimumCommitmentObject;
|
|
3084
3147
|
/** Additional usage-based charges for this plan. */
|
|
3085
3148
|
charges?: {
|
|
3086
3149
|
/**
|
|
@@ -3178,6 +3241,8 @@ export interface PlanUpdateInput {
|
|
|
3178
3241
|
* @example ["french_standard_vat"]
|
|
3179
3242
|
*/
|
|
3180
3243
|
tax_codes?: string[];
|
|
3244
|
+
/** Minimum commitment for this plan. */
|
|
3245
|
+
minimum_commitment?: MinimumCommitmentInput;
|
|
3181
3246
|
/**
|
|
3182
3247
|
* Additional usage-based charges for this plan.
|
|
3183
3248
|
* @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
@@ -3319,6 +3384,7 @@ export interface PlanObject {
|
|
|
3319
3384
|
* @example 0
|
|
3320
3385
|
*/
|
|
3321
3386
|
draft_invoices_count: number;
|
|
3387
|
+
minimum_commitment?: MinimumCommitmentObject;
|
|
3322
3388
|
/**
|
|
3323
3389
|
* Additional usage-based charges for this plan.
|
|
3324
3390
|
* @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
@@ -3394,7 +3460,7 @@ export interface SubscriptionUpdateInput {
|
|
|
3394
3460
|
* @format date-time
|
|
3395
3461
|
* @example "2022-10-08T00:00:00Z"
|
|
3396
3462
|
*/
|
|
3397
|
-
ending_at
|
|
3463
|
+
ending_at: string | null;
|
|
3398
3464
|
/**
|
|
3399
3465
|
* The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
3400
3466
|
* @format date-time
|
|
@@ -4082,7 +4148,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
4082
4148
|
}
|
|
4083
4149
|
/**
|
|
4084
4150
|
* @title Lago API documentation
|
|
4085
|
-
* @version
|
|
4151
|
+
* @version 1.1.0
|
|
4086
4152
|
* @license AGPLv3
|
|
4087
4153
|
* @baseUrl https://api.getlago.com/api/v1
|
|
4088
4154
|
* @externalDocs https://github.com/getlago
|
|
@@ -5111,7 +5177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5111
5177
|
* If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.
|
|
5112
5178
|
* @example ["active","pending"]
|
|
5113
5179
|
*/
|
|
5114
|
-
status?: ("pending" | "canceled" | "terminated" | "active")[];
|
|
5180
|
+
"status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
|
|
5115
5181
|
}, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
|
|
5116
5182
|
/**
|
|
5117
5183
|
* @description This endpoint retrieves a specific subscription.
|
package/esm/openapi/client.js
CHANGED
package/package.json
CHANGED
|
@@ -2380,6 +2380,66 @@ export interface GroupsPaginated {
|
|
|
2380
2380
|
groups: GroupObject[];
|
|
2381
2381
|
meta: PaginationMeta;
|
|
2382
2382
|
}
|
|
2383
|
+
/** Minimum commitment for this plan. */
|
|
2384
|
+
export type MinimumCommitmentInput = {
|
|
2385
|
+
/**
|
|
2386
|
+
* The amount of the minimum commitment in cents.
|
|
2387
|
+
* @example 100000
|
|
2388
|
+
*/
|
|
2389
|
+
amount_cents: number;
|
|
2390
|
+
/**
|
|
2391
|
+
* Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
|
|
2392
|
+
* @example "Minimum Commitment (C1)"
|
|
2393
|
+
*/
|
|
2394
|
+
invoice_display_name?: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* List of unique code used to identify the taxes.
|
|
2397
|
+
* @example ["french_standard_vat"]
|
|
2398
|
+
*/
|
|
2399
|
+
tax_codes?: string[];
|
|
2400
|
+
} | null;
|
|
2401
|
+
export type MinimumCommitmentObject = {
|
|
2402
|
+
/**
|
|
2403
|
+
* Unique identifier of the minimum commitment, created by Lago.
|
|
2404
|
+
* @format uuid
|
|
2405
|
+
* @example "1a901a90-1a90-1a90-1a90-1a901a901a90"
|
|
2406
|
+
*/
|
|
2407
|
+
lago_id: string;
|
|
2408
|
+
/**
|
|
2409
|
+
* The unique code representing the plan to be attached to the customer.
|
|
2410
|
+
* @example "premium"
|
|
2411
|
+
*/
|
|
2412
|
+
plan_code?: string;
|
|
2413
|
+
/**
|
|
2414
|
+
* The amount of the minimum commitment in cents.
|
|
2415
|
+
* @example 100000
|
|
2416
|
+
*/
|
|
2417
|
+
amount_cents: number;
|
|
2418
|
+
/**
|
|
2419
|
+
* Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
|
|
2420
|
+
* @example "Minimum Commitment (C1)"
|
|
2421
|
+
*/
|
|
2422
|
+
invoice_display_name?: string;
|
|
2423
|
+
/**
|
|
2424
|
+
* The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `quarterly`, `monthly` or `weekly`.
|
|
2425
|
+
* @example "monthly"
|
|
2426
|
+
*/
|
|
2427
|
+
interval?: "weekly" | "monthly" | "quarterly" | "yearly";
|
|
2428
|
+
/**
|
|
2429
|
+
* The date and time when the minimum commitment was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.
|
|
2430
|
+
* @format date-time
|
|
2431
|
+
* @example "2022-04-29T08:59:51Z"
|
|
2432
|
+
*/
|
|
2433
|
+
created_at: string;
|
|
2434
|
+
/**
|
|
2435
|
+
* The date and time when the minimum commitment was updated. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the minimum commitment was initially created.
|
|
2436
|
+
* @format date-time
|
|
2437
|
+
* @example "2022-04-29T08:59:51Z"
|
|
2438
|
+
*/
|
|
2439
|
+
updated_at?: string;
|
|
2440
|
+
/** All taxes applied to the minimum commitment. */
|
|
2441
|
+
taxes?: TaxObject[];
|
|
2442
|
+
} | null;
|
|
2383
2443
|
export interface MrrObject {
|
|
2384
2444
|
/**
|
|
2385
2445
|
* Identifies the month to analyze MRR.
|
|
@@ -2982,6 +3042,8 @@ export interface PlanCreateInput {
|
|
|
2982
3042
|
* @example ["french_standard_vat"]
|
|
2983
3043
|
*/
|
|
2984
3044
|
tax_codes?: string[];
|
|
3045
|
+
/** Minimum commitment for this plan. */
|
|
3046
|
+
minimum_commitment?: MinimumCommitmentInput;
|
|
2985
3047
|
/**
|
|
2986
3048
|
* Additional usage-based charges for this plan.
|
|
2987
3049
|
* @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
@@ -3081,6 +3143,7 @@ export interface PlanOverridesObject {
|
|
|
3081
3143
|
* @example 5
|
|
3082
3144
|
*/
|
|
3083
3145
|
trial_period?: number;
|
|
3146
|
+
minimum_commitment?: MinimumCommitmentObject;
|
|
3084
3147
|
/** Additional usage-based charges for this plan. */
|
|
3085
3148
|
charges?: {
|
|
3086
3149
|
/**
|
|
@@ -3178,6 +3241,8 @@ export interface PlanUpdateInput {
|
|
|
3178
3241
|
* @example ["french_standard_vat"]
|
|
3179
3242
|
*/
|
|
3180
3243
|
tax_codes?: string[];
|
|
3244
|
+
/** Minimum commitment for this plan. */
|
|
3245
|
+
minimum_commitment?: MinimumCommitmentInput;
|
|
3181
3246
|
/**
|
|
3182
3247
|
* Additional usage-based charges for this plan.
|
|
3183
3248
|
* @example [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[],"tax_codes":["french_standard_vat"]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"to_value":10,"from_value":0,"flat_amount":"10","per_unit_amount":"0.5"},{"to_value":null,"from_value":11,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
@@ -3319,6 +3384,7 @@ export interface PlanObject {
|
|
|
3319
3384
|
* @example 0
|
|
3320
3385
|
*/
|
|
3321
3386
|
draft_invoices_count: number;
|
|
3387
|
+
minimum_commitment?: MinimumCommitmentObject;
|
|
3322
3388
|
/**
|
|
3323
3389
|
* Additional usage-based charges for this plan.
|
|
3324
3390
|
* @example [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","invoice_display_name":"Europe","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","invoice_display_name":"USA","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","invoice_display_name":"Africa","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"invoice_display_name":"Setup","pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"invoice_display_name":"Setup","pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}]
|
|
@@ -3394,7 +3460,7 @@ export interface SubscriptionUpdateInput {
|
|
|
3394
3460
|
* @format date-time
|
|
3395
3461
|
* @example "2022-10-08T00:00:00Z"
|
|
3396
3462
|
*/
|
|
3397
|
-
ending_at
|
|
3463
|
+
ending_at: string | null;
|
|
3398
3464
|
/**
|
|
3399
3465
|
* The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
|
|
3400
3466
|
* @format date-time
|
|
@@ -4082,7 +4148,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
4082
4148
|
}
|
|
4083
4149
|
/**
|
|
4084
4150
|
* @title Lago API documentation
|
|
4085
|
-
* @version
|
|
4151
|
+
* @version 1.1.0
|
|
4086
4152
|
* @license AGPLv3
|
|
4087
4153
|
* @baseUrl https://api.getlago.com/api/v1
|
|
4088
4154
|
* @externalDocs https://github.com/getlago
|
|
@@ -5111,7 +5177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5111
5177
|
* If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.
|
|
5112
5178
|
* @example ["active","pending"]
|
|
5113
5179
|
*/
|
|
5114
|
-
status?: ("pending" | "canceled" | "terminated" | "active")[];
|
|
5180
|
+
"status[]"?: ("pending" | "canceled" | "terminated" | "active")[];
|
|
5115
5181
|
}, params?: RequestParams) => Promise<HttpResponse<SubscriptionsPaginated, ApiErrorUnauthorized | ApiErrorNotFound>>;
|
|
5116
5182
|
/**
|
|
5117
5183
|
* @description This endpoint retrieves a specific subscription.
|
package/script/openapi/client.js
CHANGED
|
@@ -152,7 +152,7 @@ class HttpClient {
|
|
|
152
152
|
exports.HttpClient = HttpClient;
|
|
153
153
|
/**
|
|
154
154
|
* @title Lago API documentation
|
|
155
|
-
* @version
|
|
155
|
+
* @version 1.1.0
|
|
156
156
|
* @license AGPLv3
|
|
157
157
|
* @baseUrl https://api.getlago.com/api/v1
|
|
158
158
|
* @externalDocs https://github.com/getlago
|