lago_ruby 0.46.1.pre.beta → 0.49.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c651739a6a86ad79395baafc83008ecde44521484923eb79e69e88ceec65c72
-  data.tar.gz: d2e50e3a2e4e5eb9370e7eed9f60f8c7e2ba7a566bc5d467482558ac21514055
+  metadata.gz: 23e57e890bfe8c0b19773bcb8eb4923fc46a1aa0abb5787074fda52d7fdd344b
+  data.tar.gz: 3ff0bd599f9260095aa49eacc114b4f2570532142033ab1273213de4fb21aabb
 SHA512:
-  metadata.gz: 8b883b38524192caba38358bbf4a97961305ee8f4d6065f3fab61a5f080bc3a1a84423a73d5cb402f929f51bdcda423a59107e2e317dee3085d81b242d50662f
-  data.tar.gz: b80b9c7e2e39a42b6d6206f168a233850815582b21b4c438addf37d79bf91574e2484df20432d53a09349fa2a63ca78ad89d1e714fa6c43a764256b4cfa7ba3c
+  metadata.gz: c542123cabbf5f5f652526fadeaae108f92c08eca199a1fed15749fcd4d83f75b28bc13ed30b4919dfe84f1376ff74e50221ef2435adef570484c42eb339657b
+  data.tar.gz: e9c14cebd5062a44286c1b8fc94377d729392cd8d9bac89ee18461d5e1477a96603fb380d1f765b45081b6ca406ce755180d980de4e9be53e0c559fea82807fd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lago_ruby (0.46.1.pre.beta)
+    lago_ruby (0.48.0.pre.beta)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

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.46.1-beta
-- Package version: 0.46.1-beta
+- API version: 0.49.0-beta
+- Package version: 0.49.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.46.1-beta.gem
+gem install ./lago_ruby-0.49.0-beta.gem
 ```
 
-(for development, run `gem install --dev ./lago_ruby-0.46.1-beta.gem` to install the development dependencies)
+(for development, run `gem install --dev ./lago_ruby-0.49.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.46.1-beta'
+    gem 'lago_ruby', '~> 0.49.0-beta'
 
 ### Install from Git
 
@@ -116,6 +116,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 +145,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
@@ -212,10 +214,6 @@ Class | Method | HTTP request | Description
  - [LagoAPI::CouponObject](docs/CouponObject.md)
  - [LagoAPI::CouponUpdateInput](docs/CouponUpdateInput.md)
  - [LagoAPI::CouponsPaginated](docs/CouponsPaginated.md)
- - [LagoAPI::CreateWebhookEndpoint200Response](docs/CreateWebhookEndpoint200Response.md)
- - [LagoAPI::CreateWebhookEndpoint200ResponseWebhookEndpoint](docs/CreateWebhookEndpoint200ResponseWebhookEndpoint.md)
- - [LagoAPI::CreateWebhookEndpointRequest](docs/CreateWebhookEndpointRequest.md)
- - [LagoAPI::CreateWebhookEndpointRequestWebhookEndpoint](docs/CreateWebhookEndpointRequestWebhookEndpoint.md)
  - [LagoAPI::CreditNote](docs/CreditNote.md)
  - [LagoAPI::CreditNoteAppliedTaxObject](docs/CreditNoteAppliedTaxObject.md)
  - [LagoAPI::CreditNoteCreateInput](docs/CreditNoteCreateInput.md)
@@ -243,6 +241,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)
@@ -254,6 +253,7 @@ Class | Method | HTTP request | Description
  - [LagoAPI::EventEstimateFeesInputEvent](docs/EventEstimateFeesInputEvent.md)
  - [LagoAPI::EventInput](docs/EventInput.md)
  - [LagoAPI::EventInputEvent](docs/EventInputEvent.md)
+ - [LagoAPI::EventInputEventTimestamp](docs/EventInputEventTimestamp.md)
  - [LagoAPI::EventObject](docs/EventObject.md)
  - [LagoAPI::EventObjectProperties](docs/EventObjectProperties.md)
  - [LagoAPI::Fee](docs/Fee.md)
@@ -264,7 +264,6 @@ Class | Method | HTTP request | Description
  - [LagoAPI::FeeUpdateInputFee](docs/FeeUpdateInputFee.md)
  - [LagoAPI::Fees](docs/Fees.md)
  - [LagoAPI::FeesPaginated](docs/FeesPaginated.md)
- - [LagoAPI::FindAllWebhookEndpoints200Response](docs/FindAllWebhookEndpoints200Response.md)
  - [LagoAPI::GetCustomerPortalUrl200Response](docs/GetCustomerPortalUrl200Response.md)
  - [LagoAPI::GetCustomerPortalUrl200ResponseCustomer](docs/GetCustomerPortalUrl200ResponseCustomer.md)
  - [LagoAPI::GroupObject](docs/GroupObject.md)
@@ -327,6 +326,12 @@ Class | Method | HTTP request | Description
  - [LagoAPI::WalletUpdateInput](docs/WalletUpdateInput.md)
  - [LagoAPI::WalletUpdateInputWallet](docs/WalletUpdateInputWallet.md)
  - [LagoAPI::WalletsPaginated](docs/WalletsPaginated.md)
+ - [LagoAPI::WebhookEndpoint](docs/WebhookEndpoint.md)
+ - [LagoAPI::WebhookEndpointCreateInput](docs/WebhookEndpointCreateInput.md)
+ - [LagoAPI::WebhookEndpointCreateInputWebhookEndpoint](docs/WebhookEndpointCreateInputWebhookEndpoint.md)
+ - [LagoAPI::WebhookEndpointObject](docs/WebhookEndpointObject.md)
+ - [LagoAPI::WebhookEndpointUpdateInput](docs/WebhookEndpointUpdateInput.md)
+ - [LagoAPI::WebhookEndpointsPaginated](docs/WebhookEndpointsPaginated.md)
 
 
 ## Documentation for Authorization

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,8 @@
 | **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] |
 
 ## Example
@@ -24,6 +25,7 @@ instance = LagoAPI::BillableMetricBaseInput.new(
   recurring: false,
   field_name: gb,
   aggregation_type: sum_agg,
+  weighted_interval: seconds,
   group: null
 )
 ```

data/docs/BillableMetricCreateInputBillableMetric.md

@@ -9,7 +9,8 @@
 | **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] |
 
 ## Example
@@ -24,6 +25,7 @@ instance = LagoAPI::BillableMetricCreateInputBillableMetric.new(
   recurring: false,
   field_name: gb,
   aggregation_type: sum_agg,
+  weighted_interval: seconds,
   group: null
 )
 ```

data/docs/BillableMetricObject.md

@@ -11,7 +11,8 @@
 | **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. |  |
 | **draft_invoices_count** | **Integer** | Number of draft invoices for which this billable metric is listed as an invoice item. |  |
@@ -31,6 +32,7 @@ instance = LagoAPI::BillableMetricObject.new(
   created_at: 2022-09-14T16:35:31Z,
   field_name: gb,
   aggregation_type: sum_agg,
+  weighted_interval: seconds,
   group: null,
   active_subscriptions_count: 4,
   draft_invoices_count: 10,

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/CouponObject.md

@@ -22,6 +22,7 @@
 | **expiration** | **String** | Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.  - If set to `time_limit`, the coupon has an expiration based on a specified time limit. - If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely. |  |
 | **expiration_at** | **Time** | The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid. | [optional] |
 | **created_at** | **Time** | The date and time when the coupon 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 coupon was initially created. |  |
+| **terminated_at** | **Time** | This field indicates if the coupon has been terminated and is no longer usable. If it's not null, it won't be removed for existing customers using it, but it prevents the coupon from being applied in the future. | [optional] |
 
 ## Example
 
@@ -46,7 +47,8 @@ instance = LagoAPI::CouponObject.new(
   frequency_duration: 6,
   expiration: time_limit,
   expiration_at: 2022-08-08T23:59:59Z,
-  created_at: 2022-04-29T08:59:51Z
+  created_at: 2022-04-29T08:59:51Z,
+  terminated_at: 2022-08-08T23:59:59Z
 )
 ```
 

data/docs/CreditNoteItemObjectFee.md

@@ -13,6 +13,7 @@
 | **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. |  |
@@ -49,6 +50,7 @@ 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,

data/docs/CreditObjectItem.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **lago_id** | **String** | Unique identifier assigned to the credit item within the Lago application. |  |
+| **lago_item_id** | **String** | Unique identifier assigned to the credit item within the Lago application. |  |
 | **type** | **String** | The type of credit applied. Possible values are `coupon` or `credit_note`. |  |
 | **code** | **String** | The code of the credit applied. It can be the code of the coupon attached to the credit or the credit note's number. |  |
 | **name** | **String** | The name of the credit applied. It can be the name of the coupon attached to the credit or the initial invoice's number linked to the credit note. |  |
@@ -15,7 +15,7 @@
 require 'lago_ruby'
 
 instance = LagoAPI::CreditObjectItem.new(
-  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_item_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   type: coupon,
   code: startup_deal,
   name: Startup Deal

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,

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/EventInputEvent.md

@@ -8,7 +8,7 @@
 | **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). This field is optional if you send the `external_subscription_id`, targeting a specific subscription. | [optional] |
 | **external_subscription_id** | **String** | The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the `external_customer_id` is not provided. | [optional] |
 | **code** | **String** | The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process. |  |
-| **timestamp** | **Integer** | This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception. | [optional] |
+| **timestamp** | [**EventInputEventTimestamp**](EventInputEventTimestamp.md) |  | [optional] |
 | **properties** | **Hash<String, String>** | This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. | [optional] |
 
 ## Example
@@ -21,7 +21,7 @@ instance = LagoAPI::EventInputEvent.new(
   external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
   external_subscription_id: sub_1234567890,
   code: storage,
-  timestamp: 1651240791,
+  timestamp: null,
   properties: {"gb":10}
 )
 ```

data/docs/EventInputEventTimestamp.md

@@ -0,0 +1,15 @@
+# LagoAPI::EventInputEventTimestamp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::EventInputEventTimestamp.new()
+```
+

data/docs/EventObject.md

@@ -26,7 +26,7 @@ instance = LagoAPI::EventObject.new(
   lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
   code: storage,
-  timestamp: 2022-04-29T08:59:51Z,
+  timestamp: 2022-04-29T08:59:51.123Z,
   properties: null,
   lago_subscription_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
   external_subscription_id: sub_1234567890,

data/docs/FeeObject.md

@@ -13,6 +13,7 @@
 | **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. |  |
@@ -49,6 +50,7 @@ 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,

data/docs/FeeObjectItem.md

@@ -7,6 +7,7 @@
 | **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] |
 | **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 +20,7 @@ instance = LagoAPI::FeeObjectItem.new(
   type: subscription,
   code: startup,
   name: Startup,
+  invoice_display_name: Setup Fee (SF1),
   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":[]}]
 )
 ```