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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5738b2715145b3c82ebcd9bb48424256348c7758b1c2f814472bfa977e4aac1
-  data.tar.gz: 2a40ead695be008af06dbb38628ba5581995845b4ce9990924363e2ae4dc7d3e
+  metadata.gz: 8ee5d8ada117e17d202e6d6387b05da9fd389b8af53af0421f884badbcd7b252
+  data.tar.gz: ddd36fe3358d8ebc558e6b63bc59cfe5a7f98dee008fdb2487adcc309e1cf151
 SHA512:
-  metadata.gz: aca1397ab9360755c7caca7cf53d7f694944708efebfc67a1bff17a1a3efca70ef2a10b22f85e41a27d14b4e7379732961569e432b1e68da0e99fbfa998d765b
-  data.tar.gz: 735d0d793eb29856d91e763758dda5316a0d337aacb0df78f98b2563b57f096314f4790cf0045c569b762f517722b16d3df966c8abc08a63631c6b6d5c05d140
+  metadata.gz: ab5f789b2fde9cc7db29c750862486a78af93fe5e8d1eff22dfb4bec076daa1b29b9e73c7b8679a3c932b81c51fb799cd45641b5a8a356b8f7540aafaf260842
+  data.tar.gz: ad643f65be23fa1f37d4b89561cad644d3443fc9e88e07e7d114f6b339c7b03edb88c7cd78d4b3c82f2cd545a870d43bb618c6eea1afbf0f84af78aa7037fb10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lago_ruby (0.48.0.pre.beta)
+    lago_ruby (0.51.0.pre.beta)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -13,7 +13,7 @@ GEM
     diff-lcs (1.5.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     jaro_winkler (1.5.6)
     method_source (1.0.0)
     parallel (1.23.0)

data/README.md

@@ -6,8 +6,8 @@ Lago API allows your application to push customer information and metrics (event
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.48.0-beta
-- Package version: 0.48.0-beta
+- API version: 0.51.0-beta
+- Package version: 0.51.0-beta
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 [![Gem Version](https://badge.fury.io/rb/lago-ruby.svg)](https://badge.fury.io/rb/lago-ruby)
@@ -26,16 +26,16 @@ gem build lago_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./lago_ruby-0.48.0-beta.gem
+gem install ./lago_ruby-0.51.0-beta.gem
 ```
 
-(for development, run `gem install --dev ./lago_ruby-0.48.0-beta.gem` to install the development dependencies)
+(for development, run `gem install --dev ./lago_ruby-0.51.0-beta.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'lago_ruby', '~> 0.48.0-beta'
+    gem 'lago_ruby', '~> 0.51.0-beta'
 
 ### Install from Git
 
@@ -109,6 +109,7 @@ Class | Method | HTTP request | Description
 *LagoAPI::CouponsApi* | [**update_coupon**](docs/CouponsApi.md#update_coupon) | **PUT** /coupons/{code} | Update a coupon
 *LagoAPI::CreditNotesApi* | [**create_credit_note**](docs/CreditNotesApi.md#create_credit_note) | **POST** /credit_notes | Create a credit note
 *LagoAPI::CreditNotesApi* | [**download_credit_note**](docs/CreditNotesApi.md#download_credit_note) | **POST** /credit_notes/{lago_id}/download | Download a credit note PDF
+*LagoAPI::CreditNotesApi* | [**estimate_credit_note**](docs/CreditNotesApi.md#estimate_credit_note) | **POST** /credit_notes/estimate | Estimate amounts for a new credit note
 *LagoAPI::CreditNotesApi* | [**find_all_credit_notes**](docs/CreditNotesApi.md#find_all_credit_notes) | **GET** /credit_notes | List all credit notes
 *LagoAPI::CreditNotesApi* | [**find_credit_note**](docs/CreditNotesApi.md#find_credit_note) | **GET** /credit_notes/{lago_id} | Retrieve a credit note
 *LagoAPI::CreditNotesApi* | [**update_credit_note**](docs/CreditNotesApi.md#update_credit_note) | **PUT** /credit_notes/{lago_id} | Update a credit note
@@ -116,6 +117,7 @@ Class | Method | HTTP request | Description
 *LagoAPI::CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /customers | Create a customer
 *LagoAPI::CustomersApi* | [**delete_applied_coupon**](docs/CustomersApi.md#delete_applied_coupon) | **DELETE** /customers/{external_customer_id}/applied_coupons/{applied_coupon_id} | Delete an applied coupon
 *LagoAPI::CustomersApi* | [**destroy_customer**](docs/CustomersApi.md#destroy_customer) | **DELETE** /customers/{external_id} | Delete a customer
+*LagoAPI::CustomersApi* | [**find_all_customer_past_usage**](docs/CustomersApi.md#find_all_customer_past_usage) | **GET** /customers/{external_customer_id}/past_usage | Retrieve customer past usage
 *LagoAPI::CustomersApi* | [**find_all_customers**](docs/CustomersApi.md#find_all_customers) | **GET** /customers | List all customers
 *LagoAPI::CustomersApi* | [**find_customer**](docs/CustomersApi.md#find_customer) | **GET** /customers/{external_id} | Retrieve a customer
 *LagoAPI::CustomersApi* | [**find_customer_current_usage**](docs/CustomersApi.md#find_customer_current_usage) | **GET** /customers/{external_customer_id}/current_usage | Retrieve customer current usage
@@ -144,6 +146,7 @@ Class | Method | HTTP request | Description
 *LagoAPI::SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Assign a plan to a customer
 *LagoAPI::SubscriptionsApi* | [**destroy_subscription**](docs/SubscriptionsApi.md#destroy_subscription) | **DELETE** /subscriptions/{external_id} | Terminate a subscription
 *LagoAPI::SubscriptionsApi* | [**find_all_subscriptions**](docs/SubscriptionsApi.md#find_all_subscriptions) | **GET** /subscriptions | List all subscriptions
+*LagoAPI::SubscriptionsApi* | [**find_subscription**](docs/SubscriptionsApi.md#find_subscription) | **GET** /subscriptions/{external_id} | Retrieve a subscription
 *LagoAPI::SubscriptionsApi* | [**update_subscription**](docs/SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions/{external_id} | Update a subscription
 *LagoAPI::TaxesApi* | [**create_tax**](docs/TaxesApi.md#create_tax) | **POST** /taxes | Create a tax
 *LagoAPI::TaxesApi* | [**destroy_tax**](docs/TaxesApi.md#destroy_tax) | **DELETE** /taxes/{code} | Delete a tax
@@ -216,7 +219,13 @@ Class | Method | HTTP request | Description
  - [LagoAPI::CreditNoteAppliedTaxObject](docs/CreditNoteAppliedTaxObject.md)
  - [LagoAPI::CreditNoteCreateInput](docs/CreditNoteCreateInput.md)
  - [LagoAPI::CreditNoteCreateInputCreditNote](docs/CreditNoteCreateInputCreditNote.md)
- - [LagoAPI::CreditNoteCreateInputCreditNoteItemsInner](docs/CreditNoteCreateInputCreditNoteItemsInner.md)
+ - [LagoAPI::CreditNoteEstimateInput](docs/CreditNoteEstimateInput.md)
+ - [LagoAPI::CreditNoteEstimateInputCreditNote](docs/CreditNoteEstimateInputCreditNote.md)
+ - [LagoAPI::CreditNoteEstimateInputCreditNoteItemsInner](docs/CreditNoteEstimateInputCreditNoteItemsInner.md)
+ - [LagoAPI::CreditNoteEstimated](docs/CreditNoteEstimated.md)
+ - [LagoAPI::CreditNoteEstimatedEstimatedCreditNote](docs/CreditNoteEstimatedEstimatedCreditNote.md)
+ - [LagoAPI::CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner](docs/CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md)
+ - [LagoAPI::CreditNoteEstimatedEstimatedCreditNoteItemsInner](docs/CreditNoteEstimatedEstimatedCreditNoteItemsInner.md)
  - [LagoAPI::CreditNoteItemObject](docs/CreditNoteItemObject.md)
  - [LagoAPI::CreditNoteItemObjectFee](docs/CreditNoteItemObjectFee.md)
  - [LagoAPI::CreditNoteObject](docs/CreditNoteObject.md)
@@ -239,6 +248,7 @@ Class | Method | HTTP request | Description
  - [LagoAPI::CustomerMetadata](docs/CustomerMetadata.md)
  - [LagoAPI::CustomerObject](docs/CustomerObject.md)
  - [LagoAPI::CustomerObjectExtended](docs/CustomerObjectExtended.md)
+ - [LagoAPI::CustomerPastUsage](docs/CustomerPastUsage.md)
  - [LagoAPI::CustomerUsage](docs/CustomerUsage.md)
  - [LagoAPI::CustomerUsageObject](docs/CustomerUsageObject.md)
  - [LagoAPI::CustomersPaginated](docs/CustomersPaginated.md)
@@ -292,6 +302,8 @@ Class | Method | HTTP request | Description
  - [LagoAPI::PlanCreateInputPlanChargesInner](docs/PlanCreateInputPlanChargesInner.md)
  - [LagoAPI::PlanCreateInputPlanChargesInnerGroupPropertiesInner](docs/PlanCreateInputPlanChargesInnerGroupPropertiesInner.md)
  - [LagoAPI::PlanObject](docs/PlanObject.md)
+ - [LagoAPI::PlanOverridesObject](docs/PlanOverridesObject.md)
+ - [LagoAPI::PlanOverridesObjectChargesInner](docs/PlanOverridesObjectChargesInner.md)
  - [LagoAPI::PlanUpdateInput](docs/PlanUpdateInput.md)
  - [LagoAPI::PlanUpdateInputPlan](docs/PlanUpdateInputPlan.md)
  - [LagoAPI::PlanUpdateInputPlanChargesInner](docs/PlanUpdateInputPlanChargesInner.md)
@@ -300,6 +312,7 @@ Class | Method | HTTP request | Description
  - [LagoAPI::SubscriptionCreateInput](docs/SubscriptionCreateInput.md)
  - [LagoAPI::SubscriptionCreateInputSubscription](docs/SubscriptionCreateInputSubscription.md)
  - [LagoAPI::SubscriptionObject](docs/SubscriptionObject.md)
+ - [LagoAPI::SubscriptionObjectExtended](docs/SubscriptionObjectExtended.md)
  - [LagoAPI::SubscriptionUpdateInput](docs/SubscriptionUpdateInput.md)
  - [LagoAPI::SubscriptionUpdateInputSubscription](docs/SubscriptionUpdateInputSubscription.md)
  - [LagoAPI::SubscriptionsPaginated](docs/SubscriptionsPaginated.md)

data/docs/AddOnBaseInput.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the add-on. | [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] |
 | **code** | **String** | Unique code used to identify the add-on. | [optional] |
 | **amount_cents** | **Integer** | The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value. | [optional] |
 | **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
@@ -18,6 +19,7 @@ require 'lago_ruby'
 
 instance = LagoAPI::AddOnBaseInput.new(
   name: Setup Fee,
+  invoice_display_name: Setup Fee (SF1),
   code: setup_fee,
   amount_cents: 50000,
   amount_currency: null,

data/docs/AddOnCreateInputAddOn.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the add-on. |  |
+| **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] |
 | **code** | **String** | Unique code used to identify the add-on. |  |
 | **amount_cents** | **Integer** | The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value. |  |
 | **amount_currency** | [**Currency**](Currency.md) |  |  |
@@ -18,6 +19,7 @@ require 'lago_ruby'
 
 instance = LagoAPI::AddOnCreateInputAddOn.new(
   name: Setup Fee,
+  invoice_display_name: Setup Fee (SF1),
   code: setup_fee,
   amount_cents: 50000,
   amount_currency: null,

data/docs/AddOnObject.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **lago_id** | **String** | Unique identifier of the add-on, created by Lago. |  |
 | **name** | **String** | The name of the add-on. |  |
+| **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] |
 | **code** | **String** | Unique code used to identify the add-on. |  |
 | **amount_cents** | **Integer** | The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value. |  |
 | **amount_currency** | [**Currency**](Currency.md) |  |  |
@@ -21,6 +22,7 @@ require 'lago_ruby'
 instance = LagoAPI::AddOnObject.new(
   lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   name: Setup Fee,
+  invoice_display_name: Setup Fee (SF1),
   code: setup_fee,
   amount_cents: 50000,
   amount_currency: null,

data/docs/BillableMetricBaseInput.md

@@ -9,7 +9,7 @@
 | **description** | **String** | Internal description of the billable metric. | [optional] |
 | **recurring** | **Boolean** | Defines if the billable metric is persisted billing period over billing period.  - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period. - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period. - If not defined in the request, default value is `false`. | [optional] |
 | **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
-| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. | [optional] |
+| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. | [optional] |
 | **weighted_interval** | **String** | Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`. | [optional] |
 | **group** | [**BillableMetricGroup**](BillableMetricGroup.md) |  | [optional] |
 

data/docs/BillableMetricCreateInputBillableMetric.md

@@ -9,7 +9,7 @@
 | **description** | **String** | Internal description of the billable metric. | [optional] |
 | **recurring** | **Boolean** | Defines if the billable metric is persisted billing period over billing period.  - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period. - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period. - If not defined in the request, default value is `false`. | [optional] |
 | **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
-| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. |  |
+| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. |  |
 | **weighted_interval** | **String** | Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`. | [optional] |
 | **group** | [**BillableMetricGroup**](BillableMetricGroup.md) |  | [optional] |
 

data/docs/BillableMetricObject.md

@@ -11,7 +11,7 @@
 | **recurring** | **Boolean** | Defines if the billable metric is persisted billing period over billing period.  - If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period. - If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period. - If not defined in the request, default value is `false`. |  |
 | **created_at** | **Time** | Creation date of the billable metric. |  |
 | **field_name** | **String** | Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`. | [optional] |
-| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. Possible values are `count_agg`, `sum_agg`, `max_agg` or `unique_count_agg`. |  |
+| **aggregation_type** | **String** | Aggregation method used to compute usage for this billable metric. |  |
 | **weighted_interval** | **String** | Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`. | [optional] |
 | **group** | [**BillableMetricGroup**](BillableMetricGroup.md) |  | [optional] |
 | **active_subscriptions_count** | **Integer** | Number of active subscriptions using this billable metric. |  |

data/docs/ChargeObject.md

@@ -7,6 +7,7 @@
 | **lago_id** | **String** | Unique identifier of charge, created by Lago. |  |
 | **lago_billable_metric_id** | **String** | Unique identifier of the billable metric created by Lago. |  |
 | **billable_metric_code** | **String** | Unique code identifying a billable metric. |  |
+| **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] |
 | **created_at** | **Time** | The date and time when the charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard. |  |
 | **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`. |  |
 | **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] |
@@ -26,6 +27,7 @@ instance = LagoAPI::ChargeObject.new(
   lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   lago_billable_metric_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   billable_metric_code: requests,
+  invoice_display_name: Setup,
   created_at: 2022-09-14T16:35:31Z,
   charge_model: null,
   pay_in_advance: true,

data/docs/CreditNoteCreateInputCreditNote.md

@@ -9,7 +9,7 @@
 | **description** | **String** | The description of the credit note. | [optional] |
 | **credit_amount_cents** | **Integer** | The total amount to be credited on the customer balance. | [optional] |
 | **refund_amount_cents** | **Integer** | The total amount to be refunded to the customer. | [optional] |
-| **items** | [**Array<CreditNoteCreateInputCreditNoteItemsInner>**](CreditNoteCreateInputCreditNoteItemsInner.md) | The list of credit note’s items. |  |
+| **items** | [**Array<CreditNoteEstimateInputCreditNoteItemsInner>**](CreditNoteEstimateInputCreditNoteItemsInner.md) | The list of credit note’s items. |  |
 
 ## Example
 

data/docs/CreditNoteEstimateInput.md

@@ -0,0 +1,18 @@
+# LagoAPI::CreditNoteEstimateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_note** | [**CreditNoteEstimateInputCreditNote**](CreditNoteEstimateInputCreditNote.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimateInput.new(
+  credit_note: null
+)
+```
+

data/docs/CreditNoteEstimateInputCreditNote.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreditNoteEstimateInputCreditNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** | The invoice unique identifier, created by Lago. |  |
+| **items** | [**Array<CreditNoteEstimateInputCreditNoteItemsInner>**](CreditNoteEstimateInputCreditNoteItemsInner.md) | The list of credit note’s items. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimateInputCreditNote.new(
+  invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  items: [{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","amount_cents":10},{"fee_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","amount_cents":5}]
+)
+```
+

data/docs/CreditNoteEstimateInputCreditNoteItemsInner.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreditNoteEstimateInputCreditNoteItemsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fee_id** | **String** | The fee unique identifier, created by Lago. |  |
+| **amount_cents** | **Integer** | The amount of the credit note item, expressed in cents. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimateInputCreditNoteItemsInner.new(
+  fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  amount_cents: 10
+)
+```
+

data/docs/CreditNoteEstimated.md

@@ -0,0 +1,18 @@
+# LagoAPI::CreditNoteEstimated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **estimated_credit_note** | [**CreditNoteEstimatedEstimatedCreditNote**](CreditNoteEstimatedEstimatedCreditNote.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimated.new(
+  estimated_credit_note: null
+)
+```
+

data/docs/CreditNoteEstimatedEstimatedCreditNote.md

@@ -0,0 +1,38 @@
+# LagoAPI::CreditNoteEstimatedEstimatedCreditNote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_invoice_id** | **String** | Unique identifier assigned to the invoice that the credit note belongs to |  |
+| **invoice_number** | **String** | The invoice unique number, related to the credit note. |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **taxes_amount_cents** | **Integer** | The tax amount of the credit note, expressed in cents. |  |
+| **taxes_rate** | **Float** | The tax rate associated with this specific credit note. |  |
+| **sub_total_excluding_taxes_amount_cents** | **Integer** | The subtotal of the credit note excluding any applicable taxes, expressed in cents. |  |
+| **max_creditable_amount_cents** | **Integer** | The credited amount of the credit note, expressed in cents. |  |
+| **max_refundable_amount_cents** | **Integer** | The refunded amount of the credit note, expressed in cents. |  |
+| **coupons_adjustment_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. |  |
+| **items** | [**Array<CreditNoteEstimatedEstimatedCreditNoteItemsInner>**](CreditNoteEstimatedEstimatedCreditNoteItemsInner.md) | Array of credit note’s items. |  |
+| **applied_taxes** | [**Array<CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner>**](CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNote.new(
+  lago_invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  invoice_number: LAG-1234,
+  currency: null,
+  taxes_amount_cents: 20,
+  taxes_rate: 20,
+  sub_total_excluding_taxes_amount_cents: 100,
+  max_creditable_amount_cents: 100,
+  max_refundable_amount_cents: 0,
+  coupons_adjustment_amount_cents: 20,
+  items: null,
+  applied_taxes: null
+)
+```
+

data/docs/CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md

@@ -0,0 +1,32 @@
+# LagoAPI::CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_tax_id** | **String** | Unique identifier of the tax, created by Lago. | [optional] |
+| **tax_name** | **String** | Name of the tax. | [optional] |
+| **tax_code** | **String** | Unique code used to identify the tax associated with the API request. | [optional] |
+| **tax_rate** | **Float** | The percentage rate of the tax | [optional] |
+| **tax_description** | **String** | Internal description of the taxe | [optional] |
+| **base_amount_cents** | **Integer** |  | [optional] |
+| **amount_cents** | **Integer** | Amount of the tax | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.new(
+  lago_tax_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  tax_name: TVA,
+  tax_code: french_standard_vat,
+  tax_rate: 20,
+  tax_description: French standard VAT,
+  base_amount_cents: 100,
+  amount_cents: 2000,
+  amount_currency: null
+)
+```
+

data/docs/CreditNoteEstimatedEstimatedCreditNoteItemsInner.md

@@ -0,0 +1,20 @@
+# LagoAPI::CreditNoteEstimatedEstimatedCreditNoteItemsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_cents** | **Integer** | The credit note’s item amount, expressed in cents. |  |
+| **lago_fee_id** | **String** | Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee’s record within the Lago system. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CreditNoteEstimatedEstimatedCreditNoteItemsInner.new(
+  amount_cents: 100,
+  lago_fee_id: 1a901a90-1a90-1a90-1a90-1a901a901a90
+)
+```
+

data/docs/CreditNoteItemObjectFee.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::CreditNoteItemObjectFee.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/CreditNoteObject.md

@@ -22,7 +22,7 @@
 | **balance_amount_cents** | **Integer** | The remaining credit note amount, expressed in cents. |  |
 | **credit_amount_cents** | **Integer** | The credited amount of the credit note, expressed in cents. |  |
 | **refund_amount_cents** | **Integer** | The refunded amount of the credit note, expressed in cents. |  |
-| **coupons_adjustement_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. |  |
+| **coupons_adjustment_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. |  |
 | **created_at** | **Time** | The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC). |  |
 | **updated_at** | **Time** | The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC). |  |
 | **file_url** | **String** | The PDF file of the credit note. | [optional] |
@@ -53,7 +53,7 @@ instance = LagoAPI::CreditNoteObject.new(
   balance_amount_cents: 100,
   credit_amount_cents: 100,
   refund_amount_cents: 0,
-  coupons_adjustement_amount_cents: 20,
+  coupons_adjustment_amount_cents: 20,
   created_at: 2022-09-14T16:35:31Z,
   updated_at: 2022-09-14T16:35:31Z,
   file_url: https://getlago.com/credit_note/file,

data/docs/CreditNotesApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://api.getlago.com/api/v1*
 | ------ | ------------ | ----------- |
 | [**create_credit_note**](CreditNotesApi.md#create_credit_note) | **POST** /credit_notes | Create a credit note |
 | [**download_credit_note**](CreditNotesApi.md#download_credit_note) | **POST** /credit_notes/{lago_id}/download | Download a credit note PDF |
+| [**estimate_credit_note**](CreditNotesApi.md#estimate_credit_note) | **POST** /credit_notes/estimate | Estimate amounts for a new credit note |
 | [**find_all_credit_notes**](CreditNotesApi.md#find_all_credit_notes) | **GET** /credit_notes | List all credit notes |
 | [**find_credit_note**](CreditNotesApi.md#find_credit_note) | **GET** /credit_notes/{lago_id} | Retrieve a credit note |
 | [**update_credit_note**](CreditNotesApi.md#update_credit_note) | **PUT** /credit_notes/{lago_id} | Update a credit note |
@@ -150,6 +151,77 @@ end
 - **Accept**: application/json
 
 
+## estimate_credit_note
+
+> <CreditNoteEstimated> estimate_credit_note(opts)
+
+Estimate amounts for a new credit note
+
+This endpoint allows you to retrieve amounts for a new credit note creation.
+
+### 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::CreditNotesApi.new
+opts = {
+  credit_note_estimate_input: LagoAPI::CreditNoteEstimateInput.new({credit_note: LagoAPI::CreditNoteEstimateInputCreditNote.new({invoice_id: '1a901a90-1a90-1a90-1a90-1a901a901a90', items: [{"fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90", "amount_cents": 10}, {"fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a91", "amount_cents": 5}]})}) # CreditNoteEstimateInput | Credit note estimate payload
+}
+
+begin
+  # Estimate amounts for a new credit note
+  result = api_instance.estimate_credit_note(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->estimate_credit_note: #{e}"
+end
+```
+
+#### Using the estimate_credit_note_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditNoteEstimated>, Integer, Hash)> estimate_credit_note_with_http_info(opts)
+
+```ruby
+begin
+  # Estimate amounts for a new credit note
+  data, status_code, headers = api_instance.estimate_credit_note_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditNoteEstimated>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling CreditNotesApi->estimate_credit_note_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_note_estimate_input** | [**CreditNoteEstimateInput**](CreditNoteEstimateInput.md) | Credit note estimate payload | [optional] |
+
+### Return type
+
+[**CreditNoteEstimated**](CreditNoteEstimated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## find_all_credit_notes
 
 > <CreditNotes> find_all_credit_notes(opts)

data/docs/CustomerChargeUsageObject.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **units** | **String** | The number of units consumed by the customer for a specific charge item. |  |
+| **events_count** | **Integer** | The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts. |  |
 | **amount_cents** | **Integer** | The amount in cents, tax excluded, consumed by the customer for a specific charge item. |  |
 | **amount_currency** | [**Currency**](Currency.md) |  |  |
 | **charge** | [**CustomerChargeUsageObjectCharge**](CustomerChargeUsageObjectCharge.md) |  |  |
@@ -18,6 +19,7 @@ require 'lago_ruby'
 
 instance = LagoAPI::CustomerChargeUsageObject.new(
   units: 1.0,
+  events_count: 10,
   amount_cents: 123,
   amount_currency: null,
   charge: null,

data/docs/CustomerChargeUsageObjectGroupsInner.md

@@ -8,6 +8,7 @@
 | **key** | **String** | The group key, only returned for groups with two dimensions. | [optional] |
 | **value** | **String** | The group value. | [optional] |
 | **units** | **String** | The number of units consumed for a specific group related to a charge item. | [optional] |
+| **events_count** | **Integer** | The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts. | [optional] |
 | **amount_cents** | **Integer** | The amount in cents, tax excluded, consumed for a specific group related to a charge item. | [optional] |
 
 ## Example
@@ -20,6 +21,7 @@ instance = LagoAPI::CustomerChargeUsageObjectGroupsInner.new(
   key: null,
   value: europe,
   units: 0.9,
+  events_count: 10,
   amount_cents: 1000
 )
 ```

data/docs/CustomerPastUsage.md

@@ -0,0 +1,20 @@
+# LagoAPI::CustomerPastUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usage_periods** | [**Array<CustomerUsage>**](CustomerUsage.md) |  |  |
+| **meta** | [**PaginationMeta**](PaginationMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::CustomerPastUsage.new(
+  usage_periods: null,
+  meta: null
+)
+```
+

data/docs/CustomerUsageObject.md

@@ -7,6 +7,7 @@
 | **from_datetime** | **Time** | The lower bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC). |  |
 | **to_datetime** | **Time** | The upper bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC). |  |
 | **issuing_date** | **Time** | The date of creation of the invoice. |  |
+| **lago_invoice_id** | **String** | A unique identifier associated with the invoice related to this particular usage record. | [optional] |
 | **currency** | [**Currency**](Currency.md) |  | [optional] |
 | **amount_cents** | **Integer** | The amount in cents, tax excluded. |  |
 | **taxes_amount_cents** | **Integer** | The tax amount in cents. |  |
@@ -22,6 +23,7 @@ instance = LagoAPI::CustomerUsageObject.new(
   from_datetime: 2022-07-01T00:00Z,
   to_datetime: 2022-07-31T23:59:59Z,
   issuing_date: 2022-08-01T23:59:59Z,
+  lago_invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   currency: null,
   amount_cents: 123,
   taxes_amount_cents: 200,