lago_ruby 0.46.0.pre.beta

data/docs/FeesApi.md

@@ -0,0 +1,253 @@
+# LagoAPI::FeesApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**find_all_fees**](FeesApi.md#find_all_fees) | **GET** /fees | List all fees |
+| [**find_fee**](FeesApi.md#find_fee) | **GET** /fees/{lago_id} | Retrieve a specific fee |
+| [**update_fee**](FeesApi.md#update_fee) | **PUT** /fees/{lago_id} | Update a fee |
+
+
+## find_all_fees
+
+> <FeesPaginated> find_all_fees(opts)
+
+List all fees
+
+This endpoint is used for retrieving all fees that has been issued.
+
+### 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::FeesApi.new
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20, # Integer | Number of records per page.
+  external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba', # String | Unique identifier assigned to the customer in your application.
+  external_subscription_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba', # String | External subscription ID
+  currency: LagoAPI::Currency::AED, # Currency | Filter results by fee’s currency.
+  fee_type: 'charge', # String | The fee type. Possible values are `add-on`, `charge`, `credit` or `subscription`.
+  billable_metric_code: 'bm_code', # String | Filter results by the `code` of the billable metric attached to the fee. Only applies to `charge` types.
+  payment_status: 'pending', # String | Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are `pending`, `succeeded`, `failed` and refunded`.
+  created_at_from: Time.parse('2023-03-28T12:21:51Z'), # Time | Filter results created after creation date and time in UTC.
+  created_at_to: Time.parse('2023-03-28T12:21:51Z'), # Time | Filter results created before creation date and time in UTC.
+  succeeded_at_from: Time.parse('2023-03-28T12:21:51Z'), # Time | Filter results with payment success after creation date and time in UTC.
+  succeeded_at_to: Time.parse('2023-03-28T12:21:51Z'), # Time | Filter results with payment success after creation date and time in UTC.
+  failed_at_from: Time.parse('2023-03-28T12:21:51Z'), # Time | Filter results with payment failure after creation date and time in UTC.
+  failed_at_to: Time.parse('2023-03-28T12:21:51Z'), # Time | Filter results with payment failure after creation date and time in UTC.
+  refunded_at_from: Time.parse('2023-03-28T12:21:51Z'), # Time | Filter results with payment refund after creation date and time in UTC.
+  refunded_at_to: Time.parse('2023-03-28T12:21:51Z') # Time | Filter results with payment refund after creation date and time in UTC.
+}
+
+begin
+  # List all fees
+  result = api_instance.find_all_fees(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling FeesApi->find_all_fees: #{e}"
+end
+```
+
+#### Using the find_all_fees_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeesPaginated>, Integer, Hash)> find_all_fees_with_http_info(opts)
+
+```ruby
+begin
+  # List all fees
+  data, status_code, headers = api_instance.find_all_fees_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeesPaginated>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling FeesApi->find_all_fees_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. | [optional] |
+| **per_page** | **Integer** | Number of records per page. | [optional] |
+| **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. | [optional] |
+| **external_subscription_id** | **String** | External subscription ID | [optional] |
+| **currency** | [**Currency**](.md) | Filter results by fee’s currency. | [optional] |
+| **fee_type** | **String** | The fee type. Possible values are &#x60;add-on&#x60;, &#x60;charge&#x60;, &#x60;credit&#x60; or &#x60;subscription&#x60;. | [optional] |
+| **billable_metric_code** | **String** | Filter results by the &#x60;code&#x60; of the billable metric attached to the fee. Only applies to &#x60;charge&#x60; types. | [optional] |
+| **payment_status** | **String** | Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are &#x60;pending&#x60;, &#x60;succeeded&#x60;, &#x60;failed&#x60; and refunded&#x60;. | [optional] |
+| **created_at_from** | **Time** | Filter results created after creation date and time in UTC. | [optional] |
+| **created_at_to** | **Time** | Filter results created before creation date and time in UTC. | [optional] |
+| **succeeded_at_from** | **Time** | Filter results with payment success after creation date and time in UTC. | [optional] |
+| **succeeded_at_to** | **Time** | Filter results with payment success after creation date and time in UTC. | [optional] |
+| **failed_at_from** | **Time** | Filter results with payment failure after creation date and time in UTC. | [optional] |
+| **failed_at_to** | **Time** | Filter results with payment failure after creation date and time in UTC. | [optional] |
+| **refunded_at_from** | **Time** | Filter results with payment refund after creation date and time in UTC. | [optional] |
+| **refunded_at_to** | **Time** | Filter results with payment refund after creation date and time in UTC. | [optional] |
+
+### Return type
+
+[**FeesPaginated**](FeesPaginated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_fee
+
+> <Fee> find_fee(lago_id)
+
+Retrieve a specific fee
+
+This endpoint is used for retrieving a specific fee that has been issued.
+
+### 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::FeesApi.new
+lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # 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.
+
+begin
+  # Retrieve a specific fee
+  result = api_instance.find_fee(lago_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling FeesApi->find_fee: #{e}"
+end
+```
+
+#### Using the find_fee_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Fee>, Integer, Hash)> find_fee_with_http_info(lago_id)
+
+```ruby
+begin
+  # Retrieve a specific fee
+  data, status_code, headers = api_instance.find_fee_with_http_info(lago_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Fee>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling FeesApi->find_fee_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_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. |  |
+
+### Return type
+
+[**Fee**](Fee.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_fee
+
+> <Fee> update_fee(lago_id, opts)
+
+Update a fee
+
+This endpoint is used for updating a specific fee that has been issued.
+
+### 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::FeesApi.new
+lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # 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.
+opts = {
+  fee_update_input: LagoAPI::FeeUpdateInput.new({fee: LagoAPI::FeeUpdateInputFee.new({payment_status: 'pending'})}) # FeeUpdateInput | Fee payload
+}
+
+begin
+  # Update a fee
+  result = api_instance.update_fee(lago_id, opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling FeesApi->update_fee: #{e}"
+end
+```
+
+#### Using the update_fee_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Fee>, Integer, Hash)> update_fee_with_http_info(lago_id, opts)
+
+```ruby
+begin
+  # Update a fee
+  data, status_code, headers = api_instance.update_fee_with_http_info(lago_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Fee>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling FeesApi->update_fee_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_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. |  |
+| **fee_update_input** | [**FeeUpdateInput**](FeeUpdateInput.md) | Fee payload | [optional] |
+
+### Return type
+
+[**Fee**](Fee.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FeesPaginated.md

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

data/docs/FindAllWebhookEndpoints200Response.md

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

data/docs/GetCustomerPortalUrl200Response.md

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

data/docs/GetCustomerPortalUrl200ResponseCustomer.md

@@ -0,0 +1,18 @@
+# LagoAPI::GetCustomerPortalUrl200ResponseCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **portal_url** | **String** | An embeddable link for displaying a customer portal |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::GetCustomerPortalUrl200ResponseCustomer.new(
+  portal_url: https://app.lago.com/customer-portal/1234567890
+)
+```
+

data/docs/GroupObject.md

@@ -0,0 +1,22 @@
+# LagoAPI::GroupObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier of a specific group associated with the billable metric. |  |
+| **key** | **String** | Key of a specific group associated with the billable metric. |  |
+| **value** | **String** | One of the values for a specific group associated with the billable metric. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::GroupObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  key: region,
+  value: us-east-1
+)
+```
+

data/docs/GroupPropertiesObject.md

@@ -0,0 +1,20 @@
+# LagoAPI::GroupPropertiesObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_id** | **String** | Unique identifier of a billable metric group, created by Lago. |  |
+| **values** | [**GroupPropertiesObjectValues**](GroupPropertiesObjectValues.md) |  |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::GroupPropertiesObject.new(
+  group_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  values: null
+)
+```
+

data/docs/GroupPropertiesObjectValues.md

@@ -0,0 +1,40 @@
+# LagoAPI::GroupPropertiesObjectValues
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **graduated_ranges** | [**Array<ChargePropertiesGraduatedRangesInner>**](ChargePropertiesGraduatedRangesInner.md) | Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model. | [optional] |
+| **graduated_percentage_ranges** | [**Array<ChargePropertiesGraduatedPercentageRangesInner>**](ChargePropertiesGraduatedPercentageRangesInner.md) | Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model. | [optional] |
+| **amount** | **String** | - The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value. - The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value. | [optional] |
+| **free_units** | **Integer** | The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle. | [optional] |
+| **package_size** | **Integer** | The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure. | [optional] |
+| **rate** | **String** | The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value. | [optional] |
+| **fixed_amount** | **String** | The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value. | [optional] |
+| **free_units_per_events** | **Integer** | The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee. | [optional] |
+| **free_units_per_total_aggregation** | **String** | The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee. | [optional] |
+| **per_transaction_max_amount** | **String** | Specifies the maximum allowable spending for a single transaction. Working as a transaction cap. | [optional] |
+| **per_transaction_min_amount** | **String** | Specifies the minimum allowable spending for a single transaction. Working as a transaction floor. | [optional] |
+| **volume_ranges** | [**Array<ChargePropertiesVolumeRangesInner>**](ChargePropertiesVolumeRangesInner.md) | Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::GroupPropertiesObjectValues.new(
+  graduated_ranges: null,
+  graduated_percentage_ranges: null,
+  amount: 30,
+  free_units: 100,
+  package_size: 1000,
+  rate: 1,
+  fixed_amount: 0.5,
+  free_units_per_events: 5,
+  free_units_per_total_aggregation: 500,
+  per_transaction_max_amount: 3.75,
+  per_transaction_min_amount: 1.75,
+  volume_ranges: null
+)
+```
+

data/docs/GroupsPaginated.md

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

data/docs/Invoice.md

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

data/docs/InvoiceAppliedTaxObject.md

@@ -0,0 +1,38 @@
+# LagoAPI::InvoiceAppliedTaxObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_invoice_id** | **String** | Unique identifier of the invoice, created by Lago. | [optional] |
+| **fees_amount_cents** | **Integer** | Fees total amount on which the tax is applied | [optional] |
+| **lago_id** | **String** | Unique identifier of the applied tax, created by Lago. | [optional] |
+| **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] |
+| **amount_cents** | **Integer** | Amount of the tax | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **created_at** | **Time** | The date and time when the applied tax 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 applied tax was initially created. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceAppliedTaxObject.new(
+  lago_invoice_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  fees_amount_cents: 20000,
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  lago_tax_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  tax_name: TVA,
+  tax_code: french_standard_vat,
+  tax_rate: 20,
+  tax_description: French standard VAT,
+  amount_cents: 2000,
+  amount_currency: null,
+  created_at: 2022-09-14T16:35:31Z
+)
+```
+

data/docs/InvoiceMetadataObject.md

@@ -0,0 +1,24 @@
+# LagoAPI::InvoiceMetadataObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the invoice metadata within the Lago application. | [optional] |
+| **key** | **String** | Represents the key of the metadata’s key-value pair. | [optional] |
+| **value** | **String** | Represents the value of the metadata’s key-value pair. | [optional] |
+| **created_at** | **Time** | The date and time when the metadata object was created. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceMetadataObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  key: digital_ref_id,
+  value: INV-0123456-98765,
+  created_at: 2022-04-29T08:59:51Z
+)
+```
+

data/docs/InvoiceObject.md

@@ -0,0 +1,62 @@
+# LagoAPI::InvoiceObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_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. |  |
+| **sequential_id** | **Integer** | This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context. |  |
+| **number** | **String** | The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system. |  |
+| **issuing_date** | **Date** | The date when the invoice was issued. It is provided in the ISO 8601 date format. |  |
+| **payment_due_date** | **Date** | The payment due date for the invoice, specified in the ISO 8601 date format. | [optional] |
+| **net_payment_term** | **Integer** | The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. | [optional] |
+| **invoice_type** | **String** | The type of invoice issued. Possible values are `subscription`, `one-off` or `credit`. |  |
+| **status** | **String** | The status of the invoice. It indicates the current state of the invoice and can have two possible values: - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice. - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore. |  |
+| **payment_status** | **String** | The status of the payment associated with the invoice. It can have one of the following values: - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint. - `succeeded`: the payment of the invoice has been successfully processed. - `failed`: the payment of the invoice has failed or encountered an error during processing. |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **fees_amount_cents** | **Integer** | The total sum of fees amount in cents. It calculates the cumulative amount of all the fees associated with the invoice, providing a consolidated value. |  |
+| **coupons_amount_cents** | **Integer** | The total sum of all coupons discounted on the invoice. It calculates the cumulative discount amount applied by coupons, expressed in cents. |  |
+| **credit_notes_amount_cents** | **Integer** | The total sum of all credit notes discounted on the invoice. It calculates the cumulative discount amount applied by credit notes, expressed in cents. |  |
+| **sub_total_excluding_taxes_amount_cents** | **Integer** | Subtotal amount, excluding taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version: - Version 1: is equal to the sum of `fees_amount_cents`, minus `coupons_amount_cents`, and minus `prepaid_credit_amount_cents`. - Version 2: is equal to the `fees_amount_cents`. - Version 3: is equal to the `fees_amount_cents`, minus `coupons_amount_cents` |  |
+| **taxes_amount_cents** | **Integer** | The sum of tax amount associated with the invoice, expressed in cents. |  |
+| **sub_total_including_taxes_amount_cents** | **Integer** | Subtotal amount, including taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version: - Version 1: is equal to the `total_amount_cents`. - Version 2: is equal to the sum of `fees_amount_cents` and `taxes_amount_cents`. - Version 3: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents` |  |
+| **prepaid_credit_amount_cents** | **Integer** | The total sum of all prepaid credits discounted on the invoice. It calculates the cumulative discount amount applied by prepaid credits, expressed in cents. |  |
+| **total_amount_cents** | **Integer** | The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes. |  |
+| **version_number** | **Integer** |  |  |
+| **file_url** | **String** | Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice | [optional] |
+| **customer** | [**InvoiceObjectCustomer**](InvoiceObjectCustomer.md) |  | [optional] |
+| **metadata** | [**Array<InvoiceMetadataObject>**](InvoiceMetadataObject.md) |  | [optional] |
+| **applied_taxes** | [**Array<InvoiceAppliedTaxObject>**](InvoiceAppliedTaxObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  sequential_id: 2,
+  number: LAG-1234-001-002,
+  issuing_date: Sat Apr 30 00:00:00 UTC 2022,
+  payment_due_date: Sat Apr 30 00:00:00 UTC 2022,
+  net_payment_term: 30,
+  invoice_type: subscription,
+  status: finalized,
+  payment_status: succeeded,
+  currency: null,
+  fees_amount_cents: 100,
+  coupons_amount_cents: 10,
+  credit_notes_amount_cents: 10,
+  sub_total_excluding_taxes_amount_cents: 100,
+  taxes_amount_cents: 20,
+  sub_total_including_taxes_amount_cents: 120,
+  prepaid_credit_amount_cents: 0,
+  total_amount_cents: 100,
+  version_number: 3,
+  file_url: https://getlago.com/invoice/file,
+  customer: null,
+  metadata: null,
+  applied_taxes: null
+)
+```
+

data/docs/InvoiceObjectCustomer.md

@@ -0,0 +1,68 @@
+# LagoAPI::InvoiceObjectCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_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 |  |
+| **sequential_id** | **Integer** | The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id`` associated with them, allowing for easy identification and sorting based on the order of creation |  |
+| **slug** | **String** | A concise and unique identifier for the customer, formed by combining the Organization's `name`, `id`, and customer's `sequential_id` |  |
+| **external_id** | **String** | The customer external unique identifier (provided by your own application) |  |
+| **address_line1** | **String** | The first line of the billing address | [optional] |
+| **address_line2** | **String** | The second line of the billing address | [optional] |
+| **applicable_timezone** | [**Timezone**](Timezone.md) |  |  |
+| **city** | **String** | The city of the customer's billing address | [optional] |
+| **country** | [**Country**](Country.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **email** | **String** | The email of the customer | [optional] |
+| **legal_name** | **String** | The legal company name of the customer | [optional] |
+| **legal_number** | **String** | The legal company number of the customer | [optional] |
+| **logo_url** | **String** | The logo URL of the customer | [optional] |
+| **name** | **String** | The full name of the customer | [optional] |
+| **phone** | **String** | The phone number of the customer | [optional] |
+| **state** | **String** | The state of the customer's billing address | [optional] |
+| **tax_identification_number** | **String** | The tax identification number of the customer | [optional] |
+| **timezone** | [**Timezone**](Timezone.md) |  | [optional] |
+| **url** | **String** | The custom website URL of the customer | [optional] |
+| **zipcode** | **String** | The zipcode of the customer's billing address | [optional] |
+| **net_payment_term** | **Integer** | The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. | [optional] |
+| **created_at** | **Time** | The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created |  |
+| **updated_at** | **Time** | The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated | [optional] |
+| **billing_configuration** | [**CustomerBillingConfiguration**](CustomerBillingConfiguration.md) |  | [optional] |
+| **metadata** | [**Array<CustomerMetadata>**](CustomerMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::InvoiceObjectCustomer.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  sequential_id: 1,
+  slug: LAG-1234-001,
+  external_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
+  address_line1: 5230 Penfield Ave,
+  address_line2: null,
+  applicable_timezone: null,
+  city: Woodland Hills,
+  country: null,
+  currency: null,
+  email: dinesh@piedpiper.test,
+  legal_name: Coleman-Blair,
+  legal_number: 49-008-2965,
+  logo_url: http://hooli.com/logo.png,
+  name: Gavin Belson,
+  phone: 1-171-883-3711 x245,
+  state: CA,
+  tax_identification_number: EU123456789,
+  timezone: null,
+  url: http://hooli.com,
+  zipcode: 91364,
+  net_payment_term: 30,
+  created_at: 2022-04-29T08:59:51Z,
+  updated_at: 2022-04-29T08:59:51Z,
+  billing_configuration: null,
+  metadata: null
+)
+```
+