lago_ruby 0.46.0.pre.beta

data/docs/OrganizationUpdateInput.md

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

data/docs/OrganizationUpdateInputOrganization.md

@@ -0,0 +1,46 @@
+# LagoAPI::OrganizationUpdateInputOrganization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_url** | **String** | The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner. | [optional] |
+| **country** | [**Country**](Country.md) |  | [optional] |
+| **address_line1** | **String** | The first line of your organization’s billing address. | [optional] |
+| **address_line2** | **String** | The second line of your organization’s billing address. | [optional] |
+| **state** | **String** | The state of your organization’s billing address. | [optional] |
+| **zipcode** | **String** | The zipcode of your organization’s billing address. | [optional] |
+| **email** | **String** | The email address of your organization used to bill your customers. | [optional] |
+| **city** | **String** | The city of your organization’s billing address. | [optional] |
+| **legal_name** | **String** | The legal name of your organization. | [optional] |
+| **legal_number** | **String** | The legal number of your organization. | [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] |
+| **tax_identification_number** | **String** | The tax identification number of your organization. | [optional] |
+| **timezone** | [**Timezone**](Timezone.md) |  | [optional] |
+| **email_settings** | **Array<String>** | Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are `invoice.finalized` and `credit_note.created`. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email. | [optional] |
+| **billing_configuration** | [**OrganizationBillingConfiguration**](OrganizationBillingConfiguration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::OrganizationUpdateInputOrganization.new(
+  webhook_url: https://webhook.brex.com,
+  country: null,
+  address_line1: 100 Brex Street,
+  address_line2: null,
+  state: NYC,
+  zipcode: 10000,
+  email: brex@brex.com,
+  city: New York,
+  legal_name: null,
+  legal_number: null,
+  net_payment_term: 30,
+  tax_identification_number: US123456789,
+  timezone: null,
+  email_settings: ["invoice.finalized","credit_note.created"],
+  billing_configuration: null
+)
+```
+

data/docs/OrganizationsApi.md

@@ -0,0 +1,77 @@
+# LagoAPI::OrganizationsApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**update_organization**](OrganizationsApi.md#update_organization) | **PUT** /organizations | Update your organization |
+
+
+## update_organization
+
+> <Organization> update_organization(organization_update_input)
+
+Update your organization
+
+This endpoint is used to update your own organization's settings.
+
+### 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::OrganizationsApi.new
+organization_update_input = LagoAPI::OrganizationUpdateInput.new({organization: LagoAPI::OrganizationUpdateInputOrganization.new}) # OrganizationUpdateInput | Update an existing organization
+
+begin
+  # Update your organization
+  result = api_instance.update_organization(organization_update_input)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling OrganizationsApi->update_organization: #{e}"
+end
+```
+
+#### Using the update_organization_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Organization>, Integer, Hash)> update_organization_with_http_info(organization_update_input)
+
+```ruby
+begin
+  # Update your organization
+  data, status_code, headers = api_instance.update_organization_with_http_info(organization_update_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Organization>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling OrganizationsApi->update_organization_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_update_input** | [**OrganizationUpdateInput**](OrganizationUpdateInput.md) | Update an existing organization |  |
+
+### Return type
+
+[**Organization**](Organization.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PaginationMeta.md

@@ -0,0 +1,26 @@
+# LagoAPI::PaginationMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **current_page** | **Integer** | Current page. |  |
+| **next_page** | **Integer** | Next page. | [optional] |
+| **prev_page** | **Integer** | Previous page. | [optional] |
+| **total_pages** | **Integer** | Total number of pages. |  |
+| **total_count** | **Integer** | Total number of records. |  |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PaginationMeta.new(
+  current_page: 2,
+  next_page: 3,
+  prev_page: 1,
+  total_pages: 4,
+  total_count: 70
+)
+```
+

data/docs/Plan.md

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

data/docs/PlanCreateInput.md

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

data/docs/PlanCreateInputPlan.md

@@ -0,0 +1,38 @@
+# LagoAPI::PlanCreateInputPlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the plan. | [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] |
+| **amount_cents** | **Integer** | The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **trial_period** | **Float** | The duration in days during which the base cost of the plan is offered for free. | [optional] |
+| **pay_in_advance** | **Boolean** | This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period. | [optional] |
+| **bill_charges_monthly** | **Boolean** | This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`. | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+| **charges** | [**Array<PlanCreateInputPlanChargesInner>**](PlanCreateInputPlanChargesInner.md) | Additional usage-based charges for this plan. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanCreateInputPlan.new(
+  name: Startup,
+  code: startup,
+  interval: monthly,
+  description: Plan for early stage startups.,
+  amount_cents: 10000,
+  amount_currency: null,
+  trial_period: 5,
+  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":[]}]
+)
+```
+

data/docs/PlanCreateInputPlanChargesInner.md

@@ -0,0 +1,34 @@
+# LagoAPI::PlanCreateInputPlanChargesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **billable_metric_id** | **String** | Unique identifier of the billable metric created by Lago. | [optional] |
+| **charge_model** | **String** | Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`. | [optional] |
+| **pay_in_advance** | **Boolean** | This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period. | [optional] |
+| **invoiceable** | **Boolean** | This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`. | [optional] |
+| **prorated** | **Boolean** | Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.  - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`. | [optional] |
+| **min_amount_cents** | **Integer** | The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. | [optional] |
+| **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) |  | [optional] |
+| **group_properties** | [**Array<PlanCreateInputPlanChargesInnerGroupPropertiesInner>**](PlanCreateInputPlanChargesInnerGroupPropertiesInner.md) | All charge information, sorted by groups. | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanCreateInputPlanChargesInner.new(
+  billable_metric_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  charge_model: standard,
+  pay_in_advance: false,
+  invoiceable: true,
+  prorated: false,
+  min_amount_cents: 0,
+  properties: null,
+  group_properties: null,
+  tax_codes: ["french_standard_vat"]
+)
+```
+

data/docs/PlanCreateInputPlanChargesInnerGroupPropertiesInner.md

@@ -0,0 +1,20 @@
+# LagoAPI::PlanCreateInputPlanChargesInnerGroupPropertiesInner
+
+## 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::PlanCreateInputPlanChargesInnerGroupPropertiesInner.new(
+  group_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  values: null
+)
+```
+

data/docs/PlanObject.md

@@ -0,0 +1,46 @@
+# LagoAPI::PlanObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier of the plan created by Lago. |  |
+| **name** | **String** | The name of the plan. |  |
+| **created_at** | **Time** | The date and time when the plan was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the plan was initially created. |  |
+| **code** | **String** | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance. |  |
+| **interval** | **String** | The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `quarterly`, `monthly` or `weekly`. |  |
+| **description** | **String** | The description on the plan. | [optional] |
+| **amount_cents** | **Integer** | The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. |  |
+| **amount_currency** | [**Currency**](Currency.md) |  |  |
+| **trial_period** | **Float** | The duration in days during which the base cost of the plan is offered for free. | [optional] |
+| **pay_in_advance** | **Boolean** | This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period. | [optional] |
+| **bill_charges_monthly** | **Boolean** | This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`. | [optional] |
+| **active_subscriptions_count** | **Integer** | The count of active subscriptions that are currently associated with the plan. This field provides valuable information regarding the impact of deleting the plan. By checking the value of this field, you can determine the number of subscriptions that will be affected if the plan is deleted. |  |
+| **draft_invoices_count** | **Integer** | The number of draft invoices that include a subscription attached to the plan. This field provides valuable information about the impact of deleting the plan. By checking the value of this field, you can determine the number of draft invoices that will be affected if the plan is deleted. |  |
+| **charges** | [**Array<ChargeObject>**](ChargeObject.md) | Additional usage-based charges for this plan. | [optional] |
+| **taxes** | [**Array<TaxObject>**](TaxObject.md) | All taxes applied to the plan. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanObject.new(
+  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  name: Startup,
+  created_at: 2023-06-27T19:43:42Z,
+  code: startup,
+  interval: monthly,
+  description: ,
+  amount_cents: 10000,
+  amount_currency: null,
+  trial_period: 5,
+  pay_in_advance: true,
+  bill_charges_monthly: null,
+  active_subscriptions_count: 0,
+  draft_invoices_count: 0,
+  charges: [{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a91","billable_metric_code":"requests","created_at":"2023-06-27T19:43:42Z","charge_model":"package","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":3000,"properties":{"amount":"30","free_units":100,"package_size":1000},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a92","billable_metric_code":"cpu","created_at":"2023-06-27T19:43:42Z","charge_model":"graduated","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"graduated_ranges":[{"from_value":0,"to_value":10,"flat_amount":"10","per_unit_amount":"0.5"},{"from_value":11,"to_value":null,"flat_amount":"0","per_unit_amount":"0.4"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a93","billable_metric_code":"seats","created_at":"2023-06-27T19:43:42Z","charge_model":"standard","invoiceable":true,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{},"group_properties":[{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a01","values":{"amount":"10"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a02","values":{"amount":"5"}},{"group_id":"1a901a90-1a90-1a90-1a90-1a901a901a03","values":{"amount":"8"}}]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a94","billable_metric_code":"storage","created_at":"2023-06-27T19:43:42Z","charge_model":"volume","invoiceable":true,"pay_in_advance":false,"prorated":false,"min_amount_cents":0,"properties":{"volume_ranges":[{"from_value":0,"to_value":100,"flat_amount":"0","per_unit_amount":"0"},{"from_value":101,"to_value":null,"flat_amount":"0","per_unit_amount":"0.5"}]},"group_properties":[]},{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","lago_billable_metric_id":"1a901a90-1a90-1a90-1a90-1a901a901a95","billable_metric_code":"payments","created_at":"2023-06-27T19:43:42Z","charge_model":"percentage","invoiceable":false,"pay_in_advance":true,"prorated":false,"min_amount_cents":0,"properties":{"rate":"1","fixed_amount":"0.5","free_units_per_events":5,"free_units_per_total_aggregation":"500"},"group_properties":[]}],
+  taxes: null
+)
+```
+

data/docs/PlanUpdateInput.md

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

data/docs/PlanUpdateInputPlan.md

@@ -0,0 +1,38 @@
+# LagoAPI::PlanUpdateInputPlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the plan. | [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] |
+| **amount_cents** | **Integer** | The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. | [optional] |
+| **amount_currency** | [**Currency**](Currency.md) |  | [optional] |
+| **trial_period** | **Float** | The duration in days during which the base cost of the plan is offered for free. | [optional] |
+| **pay_in_advance** | **Boolean** | This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period. | [optional] |
+| **bill_charges_monthly** | **Boolean** | This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan’s interval is `yearly`. | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+| **charges** | [**Array<PlanUpdateInputPlanChargesInner>**](PlanUpdateInputPlanChargesInner.md) | Additional usage-based charges for this plan. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanUpdateInputPlan.new(
+  name: Startup,
+  code: startup,
+  interval: monthly,
+  description: Plan for early stage startups.,
+  amount_cents: 10000,
+  amount_currency: null,
+  trial_period: 5,
+  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":[]}]
+)
+```
+

data/docs/PlanUpdateInputPlanChargesInner.md

@@ -0,0 +1,36 @@
+# LagoAPI::PlanUpdateInputPlanChargesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier of the charge created by Lago. | [optional] |
+| **billable_metric_id** | **String** | Unique identifier of the billable metric created by Lago. | [optional] |
+| **charge_model** | **String** | Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`. | [optional] |
+| **pay_in_advance** | **Boolean** | This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period. | [optional] |
+| **invoiceable** | **Boolean** | This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`. | [optional] |
+| **prorated** | **Boolean** | Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.  - If set to `true`, the charge is prorated based on the remaining days in the current billing period. - If set to `false`, the charge is billed in full. - If not defined in the request, default value is `false`. | [optional] |
+| **min_amount_cents** | **Integer** | The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period. | [optional] |
+| **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) |  | [optional] |
+| **group_properties** | [**Array<PlanCreateInputPlanChargesInnerGroupPropertiesInner>**](PlanCreateInputPlanChargesInnerGroupPropertiesInner.md) | All charge information, sorted by groups. | [optional] |
+| **tax_codes** | **Array<String>** | List of unique code used to identify the taxes. | [optional] |
+
+## Example
+
+```ruby
+require 'lago_ruby'
+
+instance = LagoAPI::PlanUpdateInputPlanChargesInner.new(
+  id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  billable_metric_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
+  charge_model: standard,
+  pay_in_advance: false,
+  invoiceable: true,
+  prorated: false,
+  min_amount_cents: 0,
+  properties: null,
+  group_properties: null,
+  tax_codes: ["french_standard_vat"]
+)
+```
+