lago_ruby 0.48.0.pre.beta → 0.51.0.pre.beta

data/docs/CustomersApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.getlago.com/api/v1*
 | [**create_customer**](CustomersApi.md#create_customer) | **POST** /customers | Create a customer |
 | [**delete_applied_coupon**](CustomersApi.md#delete_applied_coupon) | **DELETE** /customers/{external_customer_id}/applied_coupons/{applied_coupon_id} | Delete an applied coupon |
 | [**destroy_customer**](CustomersApi.md#destroy_customer) | **DELETE** /customers/{external_id} | Delete a customer |
+| [**find_all_customer_past_usage**](CustomersApi.md#find_all_customer_past_usage) | **GET** /customers/{external_customer_id}/past_usage | Retrieve customer past usage |
 | [**find_all_customers**](CustomersApi.md#find_all_customers) | **GET** /customers | List all customers |
 | [**find_customer**](CustomersApi.md#find_customer) | **GET** /customers/{external_id} | Retrieve a customer |
 | [**find_customer_current_usage**](CustomersApi.md#find_customer_current_usage) | **GET** /customers/{external_customer_id}/current_usage | Retrieve customer current usage |
@@ -222,6 +223,87 @@ end
 - **Accept**: application/json
 
 
+## find_all_customer_past_usage
+
+> <CustomerPastUsage> find_all_customer_past_usage(external_customer_id, external_subscription_id, opts)
+
+Retrieve customer past usage
+
+This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::CustomersApi.new
+external_customer_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | The customer external unique identifier (provided by your own application).
+external_subscription_id = 'sub_1234567890' # String | The unique identifier of the subscription within your application.
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20, # Integer | Number of records per page.
+  billable_metric_code: 'cpu', # String | Billable metric code filter to apply to the charge usage
+  periods_count: 5 # Integer | Number of past billing period to returns in the result
+}
+
+begin
+  # Retrieve customer past usage
+  result = api_instance.find_all_customer_past_usage(external_customer_id, external_subscription_id, opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->find_all_customer_past_usage: #{e}"
+end
+```
+
+#### Using the find_all_customer_past_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerPastUsage>, Integer, Hash)> find_all_customer_past_usage_with_http_info(external_customer_id, external_subscription_id, opts)
+
+```ruby
+begin
+  # Retrieve customer past usage
+  data, status_code, headers = api_instance.find_all_customer_past_usage_with_http_info(external_customer_id, external_subscription_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerPastUsage>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CustomersApi->find_all_customer_past_usage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). |  |
+| **external_subscription_id** | **String** | The unique identifier of the subscription within your application. |  |
+| **page** | **Integer** | Page number. | [optional] |
+| **per_page** | **Integer** | Number of records per page. | [optional] |
+| **billable_metric_code** | **String** | Billable metric code filter to apply to the charge usage | [optional] |
+| **periods_count** | **Integer** | Number of past billing period to returns in the result | [optional] |
+
+### Return type
+
+[**CustomerPastUsage**](CustomerPastUsage.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## find_all_customers
 
 > <CustomersPaginated> find_all_customers(opts)

data/docs/EventsApi.md

@@ -80,7 +80,7 @@ nil (empty response body)
 
 ## create_event
 
-> create_event(event_input)
+> <Event> create_event(event_input)
 
 Send usage events
 
@@ -102,7 +102,8 @@ event_input = LagoAPI::EventInput.new({event: LagoAPI::EventInputEvent.new({tran
 
 begin
   # Send usage events
-  api_instance.create_event(event_input)
+  result = api_instance.create_event(event_input)
+  p result
 rescue LagoAPI::ApiError => e
   puts "Error when calling EventsApi->create_event: #{e}"
 end
@@ -110,9 +111,9 @@ end
 
 #### Using the create_event_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> create_event_with_http_info(event_input)
+> <Array(<Event>, Integer, Hash)> create_event_with_http_info(event_input)
 
 ```ruby
 begin
@@ -120,7 +121,7 @@ begin
   data, status_code, headers = api_instance.create_event_with_http_info(event_input)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <Event>
 rescue LagoAPI::ApiError => e
   puts "Error when calling EventsApi->create_event_with_http_info: #{e}"
 end
@@ -134,7 +135,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**Event**](Event.md)
 
 ### Authorization
 

data/docs/FeeObject.md

@@ -13,11 +13,13 @@
 | **lago_customer_id** | **String** | Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
 | **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
 | **external_subscription_id** | **String** | Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
 | **amount_cents** | **Integer** | The cost of this specific fee, excluding any applicable taxes. |  |
 | **amount_currency** | [**Currency**](Currency.md) |  |  |
 | **taxes_amount_cents** | **Integer** | The cost of the tax associated with this specific fee. |  |
 | **taxes_rate** | **Float** | The tax rate associated with this specific fee. |  |
 | **units** | **String** | The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer. |  |
+| **precise_unit_amount** | **String** | The unit amount of the fee per unit, with precision. |  |
 | **total_amount_cents** | **Integer** | The cost of this specific fee, including any applicable taxes. |  |
 | **total_amount_currency** | [**Currency**](Currency.md) |  |  |
 | **events_count** | **Integer** | The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process. | [optional] |
@@ -49,11 +51,13 @@ instance = LagoAPI::FeeObject.new(
   lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   external_customer_id: external_id,
   external_subscription_id: external_id,
+  invoice_display_name: Setup Fee (SF1),
   amount_cents: 100,
   amount_currency: null,
   taxes_amount_cents: 20,
   taxes_rate: 20,
   units: 0.32,
+  precise_unit_amount: 312.5,
   total_amount_cents: 120,
   total_amount_currency: null,
   events_count: 23,

data/docs/FeeObjectItem.md

@@ -7,6 +7,8 @@
 | **type** | **String** | The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`. |  |
 | **code** | **String** | The code of the fee item. It can be the code of the `add-o`n, the code of the `charge`, the code of the `credit` or the code of the `subscription`. |  |
 | **name** | **String** | The name of the fee item. It can be the name of the `add-on`, the name of the `charge`, the name of the `credit` or the name of the `subscription`. |  |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
+| **group_invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
 | **lago_item_id** | **String** | Unique identifier of the fee item, created by Lago. It can be the identifier of the `add-on`, the identifier of the `charge`, the identifier of the `credit` or the identifier of the `subscription`. |  |
 | **item_type** | **String** | The type of the fee item. Possible values are `AddOn`, `BillableMetric`, `WalletTransaction` or `Subscription`. |  |
 
@@ -19,6 +21,8 @@ instance = LagoAPI::FeeObjectItem.new(
   type: subscription,
   code: startup,
   name: Startup,
+  invoice_display_name: Setup Fee (SF1),
+  group_invoice_display_name: Transactions - ACH,
   lago_item_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   item_type: Subscription
 )

data/docs/GroupPropertiesObject.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **group_id** | **String** | Unique identifier of a billable metric group, created by Lago. |  |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual group will be used as the default display name. | [optional] |
 | **values** | [**GroupPropertiesObjectValues**](GroupPropertiesObjectValues.md) |  |  |
 
 ## Example
@@ -14,6 +15,7 @@ require 'lago_ruby'
 
 instance = LagoAPI::GroupPropertiesObject.new(
   group_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  invoice_display_name: AWS,
   values: null
 )
 ```

data/docs/InvoiceOneOffCreateInputInvoiceFeesInner.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **add_on_code** | **String** | The code of the add-on used as invoice item. |  |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
 | **unit_amount_cents** | **Integer** | The amount of the fee per unit, expressed in cents. By default, the amount of the add-on is used. | [optional] |
 | **units** | **String** | The quantity of units associated with the fee. By default, only 1 unit is added to the invoice. | [optional] |
 | **description** | **String** | This is a description | [optional] |
@@ -17,6 +18,7 @@ require 'lago_ruby'
 
 instance = LagoAPI::InvoiceOneOffCreateInputInvoiceFeesInner.new(
   add_on_code: setup_fee,
+  invoice_display_name: Setup Fee (SF1),
   unit_amount_cents: 12000,
   units: 2.5,
   description: The description of the fee line item in the invoice. By default, the description of the add-on is used.,

data/docs/PlanCreateInputPlan.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the plan. | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name. | [optional] |
 | **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. | [optional] |
 | **interval** | **String** | 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`. | [optional] |
 | **description** | **String** | The description on the plan. | [optional] |
@@ -23,6 +24,7 @@ require 'lago_ruby'
 
 instance = LagoAPI::PlanCreateInputPlan.new(
   name: Startup,
+  invoice_display_name: Startup plan,
   code: startup,
   interval: monthly,
   description: Plan for early stage startups.,
@@ -32,7 +34,7 @@ instance = LagoAPI::PlanCreateInputPlan.new(
   pay_in_advance: true,
   bill_charges_monthly: null,
   tax_codes: ["french_standard_vat"],
-  charges: [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"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,"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,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"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,"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":[]}]
+  charges: [{"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":[]}]
 )
 ```
 

data/docs/PlanCreateInputPlanChargesInner.md

@@ -8,6 +8,7 @@
 | **charge_model** | **String** | Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`. | [optional] |
 | **pay_in_advance** | **Boolean** | This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period. | [optional] |
 | **invoiceable** | **Boolean** | This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`. | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
 | **prorated** | **Boolean** | Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.  - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`. | [optional] |
 | **min_amount_cents** | **Integer** | The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. | [optional] |
 | **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) |  | [optional] |
@@ -24,6 +25,7 @@ instance = LagoAPI::PlanCreateInputPlanChargesInner.new(
   charge_model: standard,
   pay_in_advance: false,
   invoiceable: true,
+  invoice_display_name: Setup,
   prorated: false,
   min_amount_cents: 0,
   properties: null,

data/docs/PlanObject.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **lago_id** | **String** | Unique identifier of the plan created by Lago. |  |
 | **name** | **String** | The name of the plan. |  |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name. | [optional] |
 | **created_at** | **Time** | The date and time when the plan 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 plan was initially created. |  |
 | **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. |  |
 | **interval** | **String** | 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`. |  |
@@ -28,6 +29,7 @@ require 'lago_ruby'
 instance = LagoAPI::PlanObject.new(
   lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   name: Startup,
+  invoice_display_name: Startup plan,
   created_at: 2023-06-27T19:43:42Z,
   code: startup,
   interval: monthly,
@@ -39,7 +41,7 @@ instance = LagoAPI::PlanObject.new(
   bill_charges_monthly: null,
   active_subscriptions_count: 0,
   draft_invoices_count: 0,
-  charges: [{"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,"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,"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,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","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,"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,"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":[]}],
+  charges: [{"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":[]}],
   taxes: null
 )
 ```

data/docs/PlanOverridesObject.md

@@ -0,0 +1,32 @@
+# LagoAPI::PlanOverridesObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_cents** | **Integer** | The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **description** | **String** | The description on the plan. | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name. | [optional] |
+| **name** | **String** | The name of the plan. | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+| **trial_period** | **Float** | The duration in days during which the base cost of the plan is offered for free. | [optional] |
+| **charges** | [**Array<PlanOverridesObjectChargesInner>**](PlanOverridesObjectChargesInner.md) | Additional usage-based charges for this plan. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanOverridesObject.new(
+  amount_cents: 10000,
+  amount_currency: null,
+  description: Plan for early stage startups.,
+  invoice_display_name: Startup plan,
+  name: Startup,
+  tax_codes: ["french_standard_vat"],
+  trial_period: 5,
+  charges: null
+)
+```
+

data/docs/PlanOverridesObjectChargesInner.md

@@ -0,0 +1,28 @@
+# LagoAPI::PlanOverridesObjectChargesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier of the charge created by Lago. | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
+| **min_amount_cents** | **Integer** | The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. | [optional] |
+| **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) |  | [optional] |
+| **group_properties** | [**Array<PlanCreateInputPlanChargesInnerGroupPropertiesInner>**](PlanCreateInputPlanChargesInnerGroupPropertiesInner.md) | All charge information, sorted by groups. | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanOverridesObjectChargesInner.new(
+  id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  invoice_display_name: Setup,
+  min_amount_cents: 0,
+  properties: null,
+  group_properties: null,
+  tax_codes: ["french_standard_vat"]
+)
+```
+

data/docs/PlanUpdateInputPlan.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the plan. | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name. | [optional] |
 | **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. | [optional] |
 | **interval** | **String** | 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`. | [optional] |
 | **description** | **String** | The description on the plan. | [optional] |
@@ -23,6 +24,7 @@ require 'lago_ruby'
 
 instance = LagoAPI::PlanUpdateInputPlan.new(
   name: Startup,
+  invoice_display_name: Startup plan,
   code: startup,
   interval: monthly,
   description: Plan for early stage startups.,
@@ -32,7 +34,7 @@ instance = LagoAPI::PlanUpdateInputPlan.new(
   pay_in_advance: true,
   bill_charges_monthly: null,
   tax_codes: ["french_standard_vat"],
-  charges: [{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","charge_model":"package","invoiceable":true,"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,"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,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","charge_model":"volume","invoiceable":true,"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,"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":[]}]
+  charges: [{"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":[]}]
 )
 ```
 

data/docs/PlanUpdateInputPlanChargesInner.md

@@ -9,6 +9,7 @@
 | **charge_model** | **String** | Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`. | [optional] |
 | **pay_in_advance** | **Boolean** | This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period. | [optional] |
 | **invoiceable** | **Boolean** | This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`. | [optional] |
+| **invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
 | **prorated** | **Boolean** | Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.  - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`. | [optional] |
 | **min_amount_cents** | **Integer** | The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. | [optional] |
 | **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) |  | [optional] |
@@ -26,6 +27,7 @@ instance = LagoAPI::PlanUpdateInputPlanChargesInner.new(
   charge_model: standard,
   pay_in_advance: false,
   invoiceable: true,
+  invoice_display_name: Setup,
   prorated: false,
   min_amount_cents: 0,
   properties: null,

data/docs/Subscription.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **subscription** | [**SubscriptionObject**](SubscriptionObject.md) |  |  |
+| **subscription** | [**SubscriptionObjectExtended**](SubscriptionObjectExtended.md) |  |  |
 
 ## Example
 

data/docs/SubscriptionCreateInputSubscription.md

@@ -11,6 +11,7 @@
 | **billing_time** | **String** | The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration). | [optional] |
 | **ending_at** | **Time** | The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC). | [optional] |
 | **subscription_at** | **Time** | The start date for the subscription, allowing for the creation of subscriptions that can begin in the past or future. Please note that it cannot be used to update the start date of a pending subscription or schedule an upgrade/downgrade. The start_date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
+| **plan_overrides** | [**PlanOverridesObject**](PlanOverridesObject.md) |  | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = LagoAPI::SubscriptionCreateInputSubscription.new(
   external_id: my_sub_1234567890,
   billing_time: anniversary,
   ending_at: 2022-10-08T00:00Z,
-  subscription_at: 2022-08-08T00:00Z
+  subscription_at: 2022-08-08T00:00Z,
+  plan_overrides: null
 )
 ```
 

data/docs/SubscriptionObjectExtended.md

@@ -0,0 +1,52 @@
+# LagoAPI::SubscriptionObjectExtended
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription’s record within the Lago system |  |
+| **external_id** | **String** | The subscription external unique identifier (provided by your own application). |  |
+| **lago_customer_id** | **String** | Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system |  |
+| **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). |  |
+| **billing_time** | **String** | The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration). |  |
+| **name** | **String** | The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan. | [optional] |
+| **plan_code** | **String** | The unique code representing the plan to be attached to the customer. This code must correspond to the `code` property of one of the active plans. |  |
+| **status** | **String** | The status of the subscription, which can have the following values: - `pending`: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period. - `active`: the subscription is currently active and applied to the customer. - `terminated`: the subscription is no longer active. - `canceled`: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer or when a subscription with a pending status is terminated. |  |
+| **created_at** | **Time** | The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created. |  |
+| **canceled_at** | **Time** | The cancellation date of the subscription. This field is not null when the subscription is `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
+| **started_at** | **Time** | The effective start date of the subscription. This field can be null if the subscription is `pending` or `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). | [optional] |
+| **ending_at** | **Time** | The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC). | [optional] |
+| **subscription_at** | **Time** | The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). |  |
+| **terminated_at** | **Time** | The termination date of the subscription. This field is not null when the subscription is `terminated`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC) | [optional] |
+| **previous_plan_code** | **String** | The code identifying the previous plan associated with this subscription. | [optional] |
+| **next_plan_code** | **String** | The code identifying the next plan in the case of a downgrade. | [optional] |
+| **downgrade_plan_date** | **Time** | The date when the plan will be downgraded, represented in ISO 8601 date format. | [optional] |
+| **plan** | [**PlanObject**](PlanObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::SubscriptionObjectExtended.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  billing_time: anniversary,
+  name: Repository A,
+  plan_code: premium,
+  status: active,
+  created_at: 2022-08-08T00:00Z,
+  canceled_at: 2022-09-14T16:35:31Z,
+  started_at: 2022-08-08T00:00Z,
+  ending_at: 2022-10-08T00:00Z,
+  subscription_at: 2022-08-08T00:00Z,
+  terminated_at: 2022-09-14T16:35:31Z,
+  previous_plan_code: null,
+  next_plan_code: null,
+  downgrade_plan_date: null,
+  plan: null
+)
+```
+

data/docs/SubscriptionUpdateInputSubscription.md

@@ -7,6 +7,7 @@
 | **name** | **String** | The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan. | [optional] |
 | **ending_at** | **Time** | The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC). | [optional] |
 | **subscription_at** | **Time** | 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). | [optional] |
+| **plan_overrides** | [**PlanOverridesObject**](PlanOverridesObject.md) |  | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'lago_ruby'
 instance = LagoAPI::SubscriptionUpdateInputSubscription.new(
   name: Repository B,
   ending_at: 2022-10-08T00:00Z,
-  subscription_at: 2022-08-08T00:00Z
+  subscription_at: 2022-08-08T00:00Z,
+  plan_overrides: null
 )
 ```