lago_ruby 0.49.0.pre.beta → 0.52.0.pre.beta

Sign up to get free protection for your applications and to get access to all the features.
Files changed (265) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +30 -6
  4. data/docs/AddOnCreateInputAddOn.md +1 -1
  5. data/docs/AnalyticsApi.md +299 -0
  6. data/docs/CreditNoteCreateInputCreditNote.md +1 -1
  7. data/docs/CreditNoteEstimateInput.md +18 -0
  8. data/docs/CreditNoteEstimateInputCreditNote.md +20 -0
  9. data/docs/CreditNoteEstimateInputCreditNoteItemsInner.md +20 -0
  10. data/docs/CreditNoteEstimated.md +18 -0
  11. data/docs/CreditNoteEstimatedEstimatedCreditNote.md +38 -0
  12. data/docs/CreditNoteEstimatedEstimatedCreditNoteAppliedTaxesInner.md +32 -0
  13. data/docs/CreditNoteEstimatedEstimatedCreditNoteItemsInner.md +20 -0
  14. data/docs/CreditNoteItemObjectFee.md +6 -4
  15. data/docs/CreditNoteObject.md +2 -2
  16. data/docs/CreditNotesApi.md +72 -0
  17. data/docs/CustomerChargeUsageObjectCharge.md +3 -1
  18. data/docs/CustomersApi.md +70 -0
  19. data/docs/EventsApi.md +7 -6
  20. data/docs/FeeObject.md +6 -4
  21. data/docs/FeeObjectItem.md +2 -0
  22. data/docs/GenerateCustomerCheckoutURL200Response.md +24 -0
  23. data/docs/GrossRevenueObject.md +22 -0
  24. data/docs/GrossRevenues.md +18 -0
  25. data/docs/InvoicedUsageObject.md +24 -0
  26. data/docs/InvoicedUsages.md +18 -0
  27. data/docs/MrrObject.md +22 -0
  28. data/docs/Mrrs.md +18 -0
  29. data/docs/OrganizationObject.md +2 -0
  30. data/docs/OrganizationUpdateInputOrganization.md +2 -0
  31. data/docs/OutstandingInvoiceObject.md +26 -0
  32. data/docs/OutstandingInvoices.md +18 -0
  33. data/docs/PlanOverridesObject.md +32 -0
  34. data/docs/PlanOverridesObjectChargesInner.md +30 -0
  35. data/docs/Subscription.md +1 -1
  36. data/docs/SubscriptionCreateInputSubscription.md +3 -1
  37. data/docs/SubscriptionObjectExtended.md +52 -0
  38. data/docs/SubscriptionUpdateInputSubscription.md +3 -1
  39. data/lago_ruby.gemspec +2 -2
  40. data/lib/lago_ruby/api/add_ons_api.rb +2 -2
  41. data/lib/lago_ruby/api/analytics_api.rb +268 -0
  42. data/lib/lago_ruby/api/billable_metrics_api.rb +2 -2
  43. data/lib/lago_ruby/api/coupons_api.rb +2 -2
  44. data/lib/lago_ruby/api/credit_notes_api.rb +66 -2
  45. data/lib/lago_ruby/api/customers_api.rb +65 -2
  46. data/lib/lago_ruby/api/events_api.rb +7 -7
  47. data/lib/lago_ruby/api/fees_api.rb +2 -2
  48. data/lib/lago_ruby/api/invoices_api.rb +2 -2
  49. data/lib/lago_ruby/api/organizations_api.rb +2 -2
  50. data/lib/lago_ruby/api/plans_api.rb +2 -2
  51. data/lib/lago_ruby/api/subscriptions_api.rb +2 -2
  52. data/lib/lago_ruby/api/taxes_api.rb +2 -2
  53. data/lib/lago_ruby/api/wallets_api.rb +2 -2
  54. data/lib/lago_ruby/api/webhook_endpoints_api.rb +2 -2
  55. data/lib/lago_ruby/api/webhooks_api.rb +2 -2
  56. data/lib/lago_ruby/api_client.rb +12 -13
  57. data/lib/lago_ruby/api_error.rb +2 -2
  58. data/lib/lago_ruby/configuration.rb +2 -2
  59. data/lib/lago_ruby/models/add_on.rb +3 -3
  60. data/lib/lago_ruby/models/add_on_base_input.rb +3 -3
  61. data/lib/lago_ruby/models/add_on_create_input.rb +3 -3
  62. data/lib/lago_ruby/models/add_on_create_input_add_on.rb +3 -3
  63. data/lib/lago_ruby/models/add_on_object.rb +3 -3
  64. data/lib/lago_ruby/models/add_on_update_input.rb +3 -3
  65. data/lib/lago_ruby/models/add_ons_paginated.rb +3 -3
  66. data/lib/lago_ruby/models/api_error_bad_request.rb +3 -3
  67. data/lib/lago_ruby/models/api_error_forbidden.rb +3 -3
  68. data/lib/lago_ruby/models/api_error_not_allowed.rb +3 -3
  69. data/lib/lago_ruby/models/api_error_not_found.rb +3 -3
  70. data/lib/lago_ruby/models/api_error_unauthorized.rb +3 -3
  71. data/lib/lago_ruby/models/api_error_unprocessable_entity.rb +3 -3
  72. data/lib/lago_ruby/models/applied_coupon.rb +3 -3
  73. data/lib/lago_ruby/models/applied_coupon_input.rb +3 -3
  74. data/lib/lago_ruby/models/applied_coupon_input_applied_coupon.rb +3 -3
  75. data/lib/lago_ruby/models/applied_coupon_object.rb +3 -3
  76. data/lib/lago_ruby/models/applied_coupon_object_extended.rb +3 -3
  77. data/lib/lago_ruby/models/applied_coupons_paginated.rb +3 -3
  78. data/lib/lago_ruby/models/base_applied_tax.rb +3 -3
  79. data/lib/lago_ruby/models/billable_metric.rb +3 -3
  80. data/lib/lago_ruby/models/billable_metric_base_input.rb +3 -3
  81. data/lib/lago_ruby/models/billable_metric_create_input.rb +3 -3
  82. data/lib/lago_ruby/models/billable_metric_create_input_billable_metric.rb +3 -3
  83. data/lib/lago_ruby/models/billable_metric_group.rb +3 -3
  84. data/lib/lago_ruby/models/billable_metric_group_values_inner.rb +2 -2
  85. data/lib/lago_ruby/models/billable_metric_group_values_inner_one_of.rb +3 -3
  86. data/lib/lago_ruby/models/billable_metric_object.rb +3 -3
  87. data/lib/lago_ruby/models/billable_metric_update_input.rb +3 -3
  88. data/lib/lago_ruby/models/billable_metrics_paginated.rb +3 -3
  89. data/lib/lago_ruby/models/charge_object.rb +3 -3
  90. data/lib/lago_ruby/models/charge_object_properties.rb +3 -3
  91. data/lib/lago_ruby/models/charge_properties.rb +3 -3
  92. data/lib/lago_ruby/models/charge_properties_graduated_percentage_ranges_inner.rb +3 -3
  93. data/lib/lago_ruby/models/charge_properties_graduated_ranges_inner.rb +3 -3
  94. data/lib/lago_ruby/models/charge_properties_volume_ranges_inner.rb +3 -3
  95. data/lib/lago_ruby/models/country.rb +2 -2
  96. data/lib/lago_ruby/models/coupon.rb +3 -3
  97. data/lib/lago_ruby/models/coupon_base_input.rb +3 -3
  98. data/lib/lago_ruby/models/coupon_base_input_applies_to.rb +3 -3
  99. data/lib/lago_ruby/models/coupon_create_input.rb +3 -3
  100. data/lib/lago_ruby/models/coupon_create_input_coupon.rb +3 -3
  101. data/lib/lago_ruby/models/coupon_object.rb +3 -3
  102. data/lib/lago_ruby/models/coupon_update_input.rb +3 -3
  103. data/lib/lago_ruby/models/coupons_paginated.rb +3 -3
  104. data/lib/lago_ruby/models/credit_note.rb +3 -3
  105. data/lib/lago_ruby/models/credit_note_applied_tax_object.rb +3 -3
  106. data/lib/lago_ruby/models/credit_note_create_input.rb +3 -3
  107. data/lib/lago_ruby/models/credit_note_create_input_credit_note.rb +4 -4
  108. data/lib/lago_ruby/models/credit_note_estimate_input.rb +221 -0
  109. data/lib/lago_ruby/models/credit_note_estimate_input_credit_note.rb +241 -0
  110. data/lib/lago_ruby/models/credit_note_estimate_input_credit_note_items_inner.rb +239 -0
  111. data/lib/lago_ruby/models/credit_note_estimated.rb +221 -0
  112. data/lib/lago_ruby/models/credit_note_estimated_estimated_credit_note.rb +387 -0
  113. data/lib/lago_ruby/models/credit_note_estimated_estimated_credit_note_applied_taxes_inner.rb +283 -0
  114. data/lib/lago_ruby/models/credit_note_estimated_estimated_credit_note_items_inner.rb +235 -0
  115. data/lib/lago_ruby/models/credit_note_item_object.rb +3 -3
  116. data/lib/lago_ruby/models/credit_note_item_object_fee.rb +25 -8
  117. data/lib/lago_ruby/models/credit_note_object.rb +14 -14
  118. data/lib/lago_ruby/models/credit_note_update_input.rb +3 -3
  119. data/lib/lago_ruby/models/credit_note_update_input_credit_note.rb +3 -3
  120. data/lib/lago_ruby/models/credit_notes.rb +3 -3
  121. data/lib/lago_ruby/models/credit_object.rb +3 -3
  122. data/lib/lago_ruby/models/credit_object_invoice.rb +3 -3
  123. data/lib/lago_ruby/models/credit_object_item.rb +3 -3
  124. data/lib/lago_ruby/models/currency.rb +2 -2
  125. data/lib/lago_ruby/models/customer.rb +3 -3
  126. data/lib/lago_ruby/models/customer_billing_configuration.rb +3 -3
  127. data/lib/lago_ruby/models/customer_charge_usage_object.rb +3 -3
  128. data/lib/lago_ruby/models/customer_charge_usage_object_billable_metric.rb +3 -3
  129. data/lib/lago_ruby/models/customer_charge_usage_object_charge.rb +17 -7
  130. data/lib/lago_ruby/models/customer_charge_usage_object_groups_inner.rb +3 -3
  131. data/lib/lago_ruby/models/customer_create_input.rb +3 -3
  132. data/lib/lago_ruby/models/customer_create_input_customer.rb +3 -3
  133. data/lib/lago_ruby/models/customer_create_input_customer_metadata_inner.rb +3 -3
  134. data/lib/lago_ruby/models/customer_metadata.rb +3 -3
  135. data/lib/lago_ruby/models/customer_object.rb +3 -3
  136. data/lib/lago_ruby/models/customer_object_extended.rb +3 -3
  137. data/lib/lago_ruby/models/customer_past_usage.rb +3 -3
  138. data/lib/lago_ruby/models/customer_usage.rb +3 -3
  139. data/lib/lago_ruby/models/customer_usage_object.rb +3 -3
  140. data/lib/lago_ruby/models/customers_paginated.rb +3 -3
  141. data/lib/lago_ruby/models/event.rb +3 -3
  142. data/lib/lago_ruby/models/event_batch_input.rb +3 -3
  143. data/lib/lago_ruby/models/event_batch_input_event.rb +3 -3
  144. data/lib/lago_ruby/models/event_batch_input_event_properties.rb +3 -3
  145. data/lib/lago_ruby/models/event_estimate_fees_input.rb +3 -3
  146. data/lib/lago_ruby/models/event_estimate_fees_input_event.rb +3 -3
  147. data/lib/lago_ruby/models/event_input.rb +3 -3
  148. data/lib/lago_ruby/models/event_input_event.rb +3 -3
  149. data/lib/lago_ruby/models/event_input_event_timestamp.rb +2 -2
  150. data/lib/lago_ruby/models/event_object.rb +7 -23
  151. data/lib/lago_ruby/models/event_object_properties.rb +3 -3
  152. data/lib/lago_ruby/models/fee.rb +3 -3
  153. data/lib/lago_ruby/models/fee_applied_tax_object.rb +3 -3
  154. data/lib/lago_ruby/models/fee_object.rb +25 -8
  155. data/lib/lago_ruby/models/fee_object_item.rb +14 -4
  156. data/lib/lago_ruby/models/fee_update_input.rb +3 -3
  157. data/lib/lago_ruby/models/fee_update_input_fee.rb +3 -3
  158. data/lib/lago_ruby/models/fees.rb +3 -3
  159. data/lib/lago_ruby/models/fees_paginated.rb +3 -3
  160. data/lib/lago_ruby/models/generate_customer_checkout_url200_response.rb +246 -0
  161. data/lib/lago_ruby/models/get_customer_portal_url200_response.rb +3 -3
  162. data/lib/lago_ruby/models/get_customer_portal_url200_response_customer.rb +3 -3
  163. data/lib/lago_ruby/models/gross_revenue_object.rb +241 -0
  164. data/lib/lago_ruby/models/gross_revenues.rb +223 -0
  165. data/lib/lago_ruby/models/group_object.rb +3 -3
  166. data/lib/lago_ruby/models/group_properties_object.rb +3 -3
  167. data/lib/lago_ruby/models/group_properties_object_values.rb +3 -3
  168. data/lib/lago_ruby/models/groups_paginated.rb +3 -3
  169. data/lib/lago_ruby/models/invoice.rb +3 -3
  170. data/lib/lago_ruby/models/invoice_applied_tax_object.rb +3 -3
  171. data/lib/lago_ruby/models/invoice_metadata_object.rb +3 -3
  172. data/lib/lago_ruby/models/invoice_object.rb +3 -3
  173. data/lib/lago_ruby/models/invoice_object_customer.rb +3 -3
  174. data/lib/lago_ruby/models/invoice_object_extended.rb +3 -3
  175. data/lib/lago_ruby/models/invoice_one_off_create_input.rb +3 -3
  176. data/lib/lago_ruby/models/invoice_one_off_create_input_invoice.rb +3 -3
  177. data/lib/lago_ruby/models/invoice_one_off_create_input_invoice_fees_inner.rb +3 -3
  178. data/lib/lago_ruby/models/invoice_update_input.rb +3 -3
  179. data/lib/lago_ruby/models/invoice_update_input_invoice.rb +3 -3
  180. data/lib/lago_ruby/models/invoice_update_input_invoice_metadata_inner.rb +3 -3
  181. data/lib/lago_ruby/models/invoiced_usage_object.rb +265 -0
  182. data/lib/lago_ruby/models/invoiced_usages.rb +223 -0
  183. data/lib/lago_ruby/models/invoices_paginated.rb +3 -3
  184. data/lib/lago_ruby/models/mrr_object.rb +241 -0
  185. data/lib/lago_ruby/models/mrrs.rb +223 -0
  186. data/lib/lago_ruby/models/organization.rb +3 -3
  187. data/lib/lago_ruby/models/organization_billing_configuration.rb +3 -3
  188. data/lib/lago_ruby/models/organization_object.rb +13 -4
  189. data/lib/lago_ruby/models/organization_update_input.rb +3 -3
  190. data/lib/lago_ruby/models/organization_update_input_organization.rb +13 -4
  191. data/lib/lago_ruby/models/outstanding_invoice_object.rb +309 -0
  192. data/lib/lago_ruby/models/outstanding_invoices.rb +223 -0
  193. data/lib/lago_ruby/models/pagination_meta.rb +3 -3
  194. data/lib/lago_ruby/models/plan.rb +3 -3
  195. data/lib/lago_ruby/models/plan_create_input.rb +3 -3
  196. data/lib/lago_ruby/models/plan_create_input_plan.rb +3 -3
  197. data/lib/lago_ruby/models/plan_create_input_plan_charges_inner.rb +3 -3
  198. data/lib/lago_ruby/models/plan_create_input_plan_charges_inner_group_properties_inner.rb +3 -3
  199. data/lib/lago_ruby/models/plan_object.rb +3 -3
  200. data/lib/lago_ruby/models/plan_overrides_object.rb +289 -0
  201. data/lib/lago_ruby/models/plan_overrides_object_charges_inner.rb +278 -0
  202. data/lib/lago_ruby/models/plan_update_input.rb +3 -3
  203. data/lib/lago_ruby/models/plan_update_input_plan.rb +3 -3
  204. data/lib/lago_ruby/models/plan_update_input_plan_charges_inner.rb +3 -3
  205. data/lib/lago_ruby/models/plans_paginated.rb +3 -3
  206. data/lib/lago_ruby/models/subscription.rb +4 -4
  207. data/lib/lago_ruby/models/subscription_create_input.rb +3 -3
  208. data/lib/lago_ruby/models/subscription_create_input_subscription.rb +16 -7
  209. data/lib/lago_ruby/models/subscription_object.rb +3 -3
  210. data/lib/lago_ruby/models/subscription_object_extended.rb +507 -0
  211. data/lib/lago_ruby/models/subscription_update_input.rb +3 -3
  212. data/lib/lago_ruby/models/subscription_update_input_subscription.rb +16 -7
  213. data/lib/lago_ruby/models/subscriptions_paginated.rb +3 -3
  214. data/lib/lago_ruby/models/tax.rb +3 -3
  215. data/lib/lago_ruby/models/tax_base_input.rb +3 -3
  216. data/lib/lago_ruby/models/tax_create_input.rb +3 -3
  217. data/lib/lago_ruby/models/tax_create_input_tax.rb +3 -3
  218. data/lib/lago_ruby/models/tax_object.rb +3 -3
  219. data/lib/lago_ruby/models/tax_update_input.rb +3 -3
  220. data/lib/lago_ruby/models/taxes_paginated.rb +3 -3
  221. data/lib/lago_ruby/models/timezone.rb +2 -2
  222. data/lib/lago_ruby/models/wallet.rb +3 -3
  223. data/lib/lago_ruby/models/wallet_create_input.rb +3 -3
  224. data/lib/lago_ruby/models/wallet_create_input_wallet.rb +3 -3
  225. data/lib/lago_ruby/models/wallet_object.rb +3 -3
  226. data/lib/lago_ruby/models/wallet_transaction_create_input.rb +3 -3
  227. data/lib/lago_ruby/models/wallet_transaction_create_input_wallet_transaction.rb +3 -3
  228. data/lib/lago_ruby/models/wallet_transaction_object.rb +3 -3
  229. data/lib/lago_ruby/models/wallet_transactions.rb +3 -3
  230. data/lib/lago_ruby/models/wallet_transactions_paginated.rb +3 -3
  231. data/lib/lago_ruby/models/wallet_update_input.rb +3 -3
  232. data/lib/lago_ruby/models/wallet_update_input_wallet.rb +3 -3
  233. data/lib/lago_ruby/models/wallets_paginated.rb +3 -3
  234. data/lib/lago_ruby/models/webhook_endpoint.rb +3 -3
  235. data/lib/lago_ruby/models/webhook_endpoint_create_input.rb +3 -3
  236. data/lib/lago_ruby/models/webhook_endpoint_create_input_webhook_endpoint.rb +3 -3
  237. data/lib/lago_ruby/models/webhook_endpoint_object.rb +3 -3
  238. data/lib/lago_ruby/models/webhook_endpoint_update_input.rb +3 -3
  239. data/lib/lago_ruby/models/webhook_endpoints_paginated.rb +3 -3
  240. data/lib/lago_ruby/version.rb +3 -3
  241. data/lib/lago_ruby.rb +22 -3
  242. data/spec/api/analytics_api_spec.rb +85 -0
  243. data/spec/api_client_spec.rb +2 -2
  244. data/spec/configuration_spec.rb +2 -2
  245. data/spec/models/{credit_note_create_input_credit_note_items_inner_spec.rb → credit_note_estimate_input_credit_note_items_inner_spec.rb} +10 -8
  246. data/spec/models/credit_note_estimate_input_credit_note_spec.rb +42 -0
  247. data/spec/models/credit_note_estimate_input_spec.rb +36 -0
  248. data/spec/models/credit_note_estimated_estimated_credit_note_applied_taxes_inner_spec.rb +78 -0
  249. data/spec/models/credit_note_estimated_estimated_credit_note_items_inner_spec.rb +42 -0
  250. data/spec/models/credit_note_estimated_estimated_credit_note_spec.rb +96 -0
  251. data/spec/models/credit_note_estimated_spec.rb +36 -0
  252. data/spec/models/generate_customer_checkout_url200_response_spec.rb +54 -0
  253. data/spec/models/gross_revenue_object_spec.rb +48 -0
  254. data/spec/models/gross_revenues_spec.rb +36 -0
  255. data/spec/models/invoiced_usage_object_spec.rb +54 -0
  256. data/spec/models/invoiced_usages_spec.rb +36 -0
  257. data/spec/models/mrr_object_spec.rb +48 -0
  258. data/spec/models/mrrs_spec.rb +36 -0
  259. data/spec/models/outstanding_invoice_object_spec.rb +64 -0
  260. data/spec/models/outstanding_invoices_spec.rb +36 -0
  261. data/spec/models/plan_overrides_object_charges_inner_spec.rb +66 -0
  262. data/spec/models/plan_overrides_object_spec.rb +78 -0
  263. data/spec/models/subscription_object_extended_spec.rb +146 -0
  264. data/spec/spec_helper.rb +2 -2
  265. metadata +237 -159
@@ -9,16 +9,17 @@
9
9
  | **lago_invoice_id** | **String** | Unique identifier assigned to the invoice that the fee belongs to | [optional] |
10
10
  | **lago_true_up_fee_id** | **String** | Unique identifier assigned to the true-up fee when a minimum has been set to the charge. This identifier helps to distinguish and manage the true-up fee associated with the charge, which may be applicable when a minimum threshold or limit is set for the charge amount. | [optional] |
11
11
  | **lago_true_up_parent_fee_id** | **String** | Unique identifier assigned to the parent fee on which the true-up fee is assigned. This identifier establishes the relationship between the parent fee and the associated true-up fee. | [optional] |
12
- | **lago_subscription_id** | **String** | Unique identifier assigned to the subscription, 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] |
13
- | **lago_customer_id** | **String** | Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (`pay_in_advance` is set to true). | [optional] |
14
- | **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] |
15
- | **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] |
12
+ | **lago_subscription_id** | **String** | Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription. | [optional] |
13
+ | **lago_customer_id** | **String** | Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription. | [optional] |
14
+ | **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription. | [optional] |
15
+ | **external_subscription_id** | **String** | Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription. | [optional] |
16
16
  | **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] |
17
17
  | **amount_cents** | **Integer** | The cost of this specific fee, excluding any applicable taxes. | |
18
18
  | **amount_currency** | [**Currency**](Currency.md) | | |
19
19
  | **taxes_amount_cents** | **Integer** | The cost of the tax associated with this specific fee. | |
20
20
  | **taxes_rate** | **Float** | The tax rate associated with this specific fee. | |
21
21
  | **units** | **String** | The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer. | |
22
+ | **precise_unit_amount** | **String** | The unit amount of the fee per unit, with precision. | |
22
23
  | **total_amount_cents** | **Integer** | The cost of this specific fee, including any applicable taxes. | |
23
24
  | **total_amount_currency** | [**Currency**](Currency.md) | | |
24
25
  | **events_count** | **Integer** | The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process. | [optional] |
@@ -56,6 +57,7 @@ instance = LagoAPI::CreditNoteItemObjectFee.new(
56
57
  taxes_amount_cents: 20,
57
58
  taxes_rate: 20,
58
59
  units: 0.32,
60
+ precise_unit_amount: 312.5,
59
61
  total_amount_cents: 120,
60
62
  total_amount_currency: null,
61
63
  events_count: 23,
@@ -22,7 +22,7 @@
22
22
  | **balance_amount_cents** | **Integer** | The remaining credit note amount, expressed in cents. | |
23
23
  | **credit_amount_cents** | **Integer** | The credited amount of the credit note, expressed in cents. | |
24
24
  | **refund_amount_cents** | **Integer** | The refunded amount of the credit note, expressed in cents. | |
25
- | **coupons_adjustement_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. | |
25
+ | **coupons_adjustment_amount_cents** | **Integer** | The pro-rated amount of the coupons applied to the source invoice. | |
26
26
  | **created_at** | **Time** | The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC). | |
27
27
  | **updated_at** | **Time** | The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC). | |
28
28
  | **file_url** | **String** | The PDF file of the credit note. | [optional] |
@@ -53,7 +53,7 @@ instance = LagoAPI::CreditNoteObject.new(
53
53
  balance_amount_cents: 100,
54
54
  credit_amount_cents: 100,
55
55
  refund_amount_cents: 0,
56
- coupons_adjustement_amount_cents: 20,
56
+ coupons_adjustment_amount_cents: 20,
57
57
  created_at: 2022-09-14T16:35:31Z,
58
58
  updated_at: 2022-09-14T16:35:31Z,
59
59
  file_url: https://getlago.com/credit_note/file,
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.getlago.com/api/v1*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_credit_note**](CreditNotesApi.md#create_credit_note) | **POST** /credit_notes | Create a credit note |
8
8
  | [**download_credit_note**](CreditNotesApi.md#download_credit_note) | **POST** /credit_notes/{lago_id}/download | Download a credit note PDF |
9
+ | [**estimate_credit_note**](CreditNotesApi.md#estimate_credit_note) | **POST** /credit_notes/estimate | Estimate amounts for a new credit note |
9
10
  | [**find_all_credit_notes**](CreditNotesApi.md#find_all_credit_notes) | **GET** /credit_notes | List all credit notes |
10
11
  | [**find_credit_note**](CreditNotesApi.md#find_credit_note) | **GET** /credit_notes/{lago_id} | Retrieve a credit note |
11
12
  | [**update_credit_note**](CreditNotesApi.md#update_credit_note) | **PUT** /credit_notes/{lago_id} | Update a credit note |
@@ -150,6 +151,77 @@ end
150
151
  - **Accept**: application/json
151
152
 
152
153
 
154
+ ## estimate_credit_note
155
+
156
+ > <CreditNoteEstimated> estimate_credit_note(opts)
157
+
158
+ Estimate amounts for a new credit note
159
+
160
+ This endpoint allows you to retrieve amounts for a new credit note creation.
161
+
162
+ ### Examples
163
+
164
+ ```ruby
165
+ require 'time'
166
+ require 'lago_ruby'
167
+ # setup authorization
168
+ LagoAPI.configure do |config|
169
+ # Configure Bearer authorization: bearerAuth
170
+ config.access_token = 'YOUR_BEARER_TOKEN'
171
+ end
172
+
173
+ api_instance = LagoAPI::CreditNotesApi.new
174
+ opts = {
175
+ credit_note_estimate_input: LagoAPI::CreditNoteEstimateInput.new({credit_note: LagoAPI::CreditNoteEstimateInputCreditNote.new({invoice_id: '1a901a90-1a90-1a90-1a90-1a901a901a90', items: [{"fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a90", "amount_cents": 10}, {"fee_id": "1a901a90-1a90-1a90-1a90-1a901a901a91", "amount_cents": 5}]})}) # CreditNoteEstimateInput | Credit note estimate payload
176
+ }
177
+
178
+ begin
179
+ # Estimate amounts for a new credit note
180
+ result = api_instance.estimate_credit_note(opts)
181
+ p result
182
+ rescue LagoAPI::ApiError => e
183
+ puts "Error when calling CreditNotesApi->estimate_credit_note: #{e}"
184
+ end
185
+ ```
186
+
187
+ #### Using the estimate_credit_note_with_http_info variant
188
+
189
+ This returns an Array which contains the response data, status code and headers.
190
+
191
+ > <Array(<CreditNoteEstimated>, Integer, Hash)> estimate_credit_note_with_http_info(opts)
192
+
193
+ ```ruby
194
+ begin
195
+ # Estimate amounts for a new credit note
196
+ data, status_code, headers = api_instance.estimate_credit_note_with_http_info(opts)
197
+ p status_code # => 2xx
198
+ p headers # => { ... }
199
+ p data # => <CreditNoteEstimated>
200
+ rescue LagoAPI::ApiError => e
201
+ puts "Error when calling CreditNotesApi->estimate_credit_note_with_http_info: #{e}"
202
+ end
203
+ ```
204
+
205
+ ### Parameters
206
+
207
+ | Name | Type | Description | Notes |
208
+ | ---- | ---- | ----------- | ----- |
209
+ | **credit_note_estimate_input** | [**CreditNoteEstimateInput**](CreditNoteEstimateInput.md) | Credit note estimate payload | [optional] |
210
+
211
+ ### Return type
212
+
213
+ [**CreditNoteEstimated**](CreditNoteEstimated.md)
214
+
215
+ ### Authorization
216
+
217
+ [bearerAuth](../README.md#bearerAuth)
218
+
219
+ ### HTTP request headers
220
+
221
+ - **Content-Type**: application/json
222
+ - **Accept**: application/json
223
+
224
+
153
225
  ## find_all_credit_notes
154
226
 
155
227
  > <CreditNotes> find_all_credit_notes(opts)
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **lago_id** | **String** | Unique identifier assigned to the charge within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the charge’s record within the Lago system. | |
8
8
  | **charge_model** | **String** | The pricing model applied to this charge. Possible values are standard, &#x60;graduated&#x60;, &#x60;percentage&#x60;, &#x60;package&#x60; or &#x60;volume&#x60;. | |
9
+ | **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] |
9
10
 
10
11
  ## Example
11
12
 
@@ -14,7 +15,8 @@ require 'lago_ruby'
14
15
 
15
16
  instance = LagoAPI::CustomerChargeUsageObjectCharge.new(
16
17
  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
17
- charge_model: graduated
18
+ charge_model: graduated,
19
+ invoice_display_name: Setup
18
20
  )
19
21
  ```
20
22
 
data/docs/CustomersApi.md CHANGED
@@ -11,6 +11,7 @@ All URIs are relative to *https://api.getlago.com/api/v1*
11
11
  | [**find_all_customers**](CustomersApi.md#find_all_customers) | **GET** /customers | List all customers |
12
12
  | [**find_customer**](CustomersApi.md#find_customer) | **GET** /customers/{external_id} | Retrieve a customer |
13
13
  | [**find_customer_current_usage**](CustomersApi.md#find_customer_current_usage) | **GET** /customers/{external_customer_id}/current_usage | Retrieve customer current usage |
14
+ | [**generate_customer_checkout_url**](CustomersApi.md#generate_customer_checkout_url) | **POST** /customers/{external_customer_id}/checkout_url | Generate a Customer Payment Provider Checkout URL |
14
15
  | [**get_customer_portal_url**](CustomersApi.md#get_customer_portal_url) | **GET** /customers/{external_customer_id}/portal_url | Get a customer portal URL |
15
16
 
16
17
 
@@ -517,6 +518,75 @@ end
517
518
  - **Accept**: application/json
518
519
 
519
520
 
521
+ ## generate_customer_checkout_url
522
+
523
+ > <GenerateCustomerCheckoutURL200Response> generate_customer_checkout_url(external_customer_id)
524
+
525
+ Generate a Customer Payment Provider Checkout URL
526
+
527
+ This endpoint regenerates the Payment Provider Checkout URL of a Customer.
528
+
529
+ ### Examples
530
+
531
+ ```ruby
532
+ require 'time'
533
+ require 'lago_ruby'
534
+ # setup authorization
535
+ LagoAPI.configure do |config|
536
+ # Configure Bearer authorization: bearerAuth
537
+ config.access_token = 'YOUR_BEARER_TOKEN'
538
+ end
539
+
540
+ api_instance = LagoAPI::CustomersApi.new
541
+ external_customer_id = '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | The customer external unique identifier (provided by your own application).
542
+
543
+ begin
544
+ # Generate a Customer Payment Provider Checkout URL
545
+ result = api_instance.generate_customer_checkout_url(external_customer_id)
546
+ p result
547
+ rescue LagoAPI::ApiError => e
548
+ puts "Error when calling CustomersApi->generate_customer_checkout_url: #{e}"
549
+ end
550
+ ```
551
+
552
+ #### Using the generate_customer_checkout_url_with_http_info variant
553
+
554
+ This returns an Array which contains the response data, status code and headers.
555
+
556
+ > <Array(<GenerateCustomerCheckoutURL200Response>, Integer, Hash)> generate_customer_checkout_url_with_http_info(external_customer_id)
557
+
558
+ ```ruby
559
+ begin
560
+ # Generate a Customer Payment Provider Checkout URL
561
+ data, status_code, headers = api_instance.generate_customer_checkout_url_with_http_info(external_customer_id)
562
+ p status_code # => 2xx
563
+ p headers # => { ... }
564
+ p data # => <GenerateCustomerCheckoutURL200Response>
565
+ rescue LagoAPI::ApiError => e
566
+ puts "Error when calling CustomersApi->generate_customer_checkout_url_with_http_info: #{e}"
567
+ end
568
+ ```
569
+
570
+ ### Parameters
571
+
572
+ | Name | Type | Description | Notes |
573
+ | ---- | ---- | ----------- | ----- |
574
+ | **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). | |
575
+
576
+ ### Return type
577
+
578
+ [**GenerateCustomerCheckoutURL200Response**](GenerateCustomerCheckoutURL200Response.md)
579
+
580
+ ### Authorization
581
+
582
+ [bearerAuth](../README.md#bearerAuth)
583
+
584
+ ### HTTP request headers
585
+
586
+ - **Content-Type**: Not defined
587
+ - **Accept**: application/json
588
+
589
+
520
590
  ## get_customer_portal_url
521
591
 
522
592
  > <GetCustomerPortalUrl200Response> get_customer_portal_url(external_customer_id)
data/docs/EventsApi.md CHANGED
@@ -80,7 +80,7 @@ nil (empty response body)
80
80
 
81
81
  ## create_event
82
82
 
83
- > create_event(event_input)
83
+ > <Event> create_event(event_input)
84
84
 
85
85
  Send usage events
86
86
 
@@ -102,7 +102,8 @@ event_input = LagoAPI::EventInput.new({event: LagoAPI::EventInputEvent.new({tran
102
102
 
103
103
  begin
104
104
  # Send usage events
105
- api_instance.create_event(event_input)
105
+ result = api_instance.create_event(event_input)
106
+ p result
106
107
  rescue LagoAPI::ApiError => e
107
108
  puts "Error when calling EventsApi->create_event: #{e}"
108
109
  end
@@ -110,9 +111,9 @@ end
110
111
 
111
112
  #### Using the create_event_with_http_info variant
112
113
 
113
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
114
+ This returns an Array which contains the response data, status code and headers.
114
115
 
115
- > <Array(nil, Integer, Hash)> create_event_with_http_info(event_input)
116
+ > <Array(<Event>, Integer, Hash)> create_event_with_http_info(event_input)
116
117
 
117
118
  ```ruby
118
119
  begin
@@ -120,7 +121,7 @@ begin
120
121
  data, status_code, headers = api_instance.create_event_with_http_info(event_input)
121
122
  p status_code # => 2xx
122
123
  p headers # => { ... }
123
- p data # => nil
124
+ p data # => <Event>
124
125
  rescue LagoAPI::ApiError => e
125
126
  puts "Error when calling EventsApi->create_event_with_http_info: #{e}"
126
127
  end
@@ -134,7 +135,7 @@ end
134
135
 
135
136
  ### Return type
136
137
 
137
- nil (empty response body)
138
+ [**Event**](Event.md)
138
139
 
139
140
  ### Authorization
140
141
 
data/docs/FeeObject.md CHANGED
@@ -9,16 +9,17 @@
9
9
  | **lago_invoice_id** | **String** | Unique identifier assigned to the invoice that the fee belongs to | [optional] |
10
10
  | **lago_true_up_fee_id** | **String** | Unique identifier assigned to the true-up fee when a minimum has been set to the charge. This identifier helps to distinguish and manage the true-up fee associated with the charge, which may be applicable when a minimum threshold or limit is set for the charge amount. | [optional] |
11
11
  | **lago_true_up_parent_fee_id** | **String** | Unique identifier assigned to the parent fee on which the true-up fee is assigned. This identifier establishes the relationship between the parent fee and the associated true-up fee. | [optional] |
12
- | **lago_subscription_id** | **String** | Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (&#x60;pay_in_advance&#x60; is set to true). | [optional] |
13
- | **lago_customer_id** | **String** | Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (&#x60;pay_in_advance&#x60; is set to true). | [optional] |
14
- | **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 (&#x60;pay_in_advance&#x60; is set to true). | [optional] |
15
- | **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 (&#x60;pay_in_advance&#x60; is set to true). | [optional] |
12
+ | **lago_subscription_id** | **String** | Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription. | [optional] |
13
+ | **lago_customer_id** | **String** | Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription. | [optional] |
14
+ | **external_customer_id** | **String** | Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription. | [optional] |
15
+ | **external_subscription_id** | **String** | Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription. | [optional] |
16
16
  | **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] |
17
17
  | **amount_cents** | **Integer** | The cost of this specific fee, excluding any applicable taxes. | |
18
18
  | **amount_currency** | [**Currency**](Currency.md) | | |
19
19
  | **taxes_amount_cents** | **Integer** | The cost of the tax associated with this specific fee. | |
20
20
  | **taxes_rate** | **Float** | The tax rate associated with this specific fee. | |
21
21
  | **units** | **String** | The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer. | |
22
+ | **precise_unit_amount** | **String** | The unit amount of the fee per unit, with precision. | |
22
23
  | **total_amount_cents** | **Integer** | The cost of this specific fee, including any applicable taxes. | |
23
24
  | **total_amount_currency** | [**Currency**](Currency.md) | | |
24
25
  | **events_count** | **Integer** | The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process. | [optional] |
@@ -56,6 +57,7 @@ instance = LagoAPI::FeeObject.new(
56
57
  taxes_amount_cents: 20,
57
58
  taxes_rate: 20,
58
59
  units: 0.32,
60
+ precise_unit_amount: 312.5,
59
61
  total_amount_cents: 120,
60
62
  total_amount_currency: null,
61
63
  events_count: 23,
@@ -8,6 +8,7 @@
8
8
  | **code** | **String** | The code of the fee item. It can be the code of the &#x60;add-o&#x60;n, the code of the &#x60;charge&#x60;, the code of the &#x60;credit&#x60; or the code of the &#x60;subscription&#x60;. | |
9
9
  | **name** | **String** | The name of the fee item. It can be the name of the &#x60;add-on&#x60;, the name of the &#x60;charge&#x60;, the name of the &#x60;credit&#x60; or the name of the &#x60;subscription&#x60;. | |
10
10
  | **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] |
11
+ | **group_invoice_display_name** | **String** | Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name. | [optional] |
11
12
  | **lago_item_id** | **String** | Unique identifier of the fee item, created by Lago. It can be the identifier of the &#x60;add-on&#x60;, the identifier of the &#x60;charge&#x60;, the identifier of the &#x60;credit&#x60; or the identifier of the &#x60;subscription&#x60;. | |
12
13
  | **item_type** | **String** | The type of the fee item. Possible values are &#x60;AddOn&#x60;, &#x60;BillableMetric&#x60;, &#x60;WalletTransaction&#x60; or &#x60;Subscription&#x60;. | |
13
14
 
@@ -21,6 +22,7 @@ instance = LagoAPI::FeeObjectItem.new(
21
22
  code: startup,
22
23
  name: Startup,
23
24
  invoice_display_name: Setup Fee (SF1),
25
+ group_invoice_display_name: Transactions - ACH,
24
26
  lago_item_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
25
27
  item_type: Subscription
26
28
  )
@@ -0,0 +1,24 @@
1
+ # LagoAPI::GenerateCustomerCheckoutURL200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **lago_customer_id** | **String** | Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer&#39;s record within the Lago system | [optional] |
8
+ | **external_customer_id** | **String** | The customer external unique identifier (provided by your own application) | [optional] |
9
+ | **payment_provider** | **String** | The Payment Provider name linked to the Customer. | [optional] |
10
+ | **checkout_url** | **String** | The new generated Payment Provider Checkout URL for the Customer. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'lago_ruby'
16
+
17
+ instance = LagoAPI::GenerateCustomerCheckoutURL200Response.new(
18
+ lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
19
+ external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
20
+ payment_provider: stripe,
21
+ checkout_url: https://foo.bar
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # LagoAPI::GrossRevenueObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **month** | **String** | Identifies the month to analyze revenue. | |
8
+ | **amount_cents** | **Integer** | The total amount of revenue for a period, expressed in cents. | [optional] |
9
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'lago_ruby'
15
+
16
+ instance = LagoAPI::GrossRevenueObject.new(
17
+ month: 2023-11-01T00:00:00.000Z,
18
+ amount_cents: 50000,
19
+ currency: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # LagoAPI::GrossRevenues
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **gross_revenues** | [**Array&lt;GrossRevenueObject&gt;**](GrossRevenueObject.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'lago_ruby'
13
+
14
+ instance = LagoAPI::GrossRevenues.new(
15
+ gross_revenues: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,24 @@
1
+ # LagoAPI::InvoicedUsageObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **month** | **String** | Identifies the month to analyze revenue. | |
8
+ | **code** | **String** | The code of the usage-based billable metrics. | [optional] |
9
+ | **amount_cents** | **Integer** | The total amount of revenue for a period, expressed in cents. | |
10
+ | **currency** | [**Currency**](Currency.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'lago_ruby'
16
+
17
+ instance = LagoAPI::InvoicedUsageObject.new(
18
+ month: 2023-11-01T00:00:00.000Z,
19
+ code: code1,
20
+ amount_cents: 50000,
21
+ currency: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # LagoAPI::InvoicedUsages
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **invoiced_usages** | [**Array&lt;InvoicedUsageObject&gt;**](InvoicedUsageObject.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'lago_ruby'
13
+
14
+ instance = LagoAPI::InvoicedUsages.new(
15
+ invoiced_usages: null
16
+ )
17
+ ```
18
+
data/docs/MrrObject.md ADDED
@@ -0,0 +1,22 @@
1
+ # LagoAPI::MrrObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **month** | **String** | Identifies the month to analyze MRR. | |
8
+ | **amount_cents** | **Integer** | The total amount of MRR, expressed in cents. | [optional] |
9
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'lago_ruby'
15
+
16
+ instance = LagoAPI::MrrObject.new(
17
+ month: 2023-11-01T00:00:00.000Z,
18
+ amount_cents: 50000,
19
+ currency: null
20
+ )
21
+ ```
22
+
data/docs/Mrrs.md ADDED
@@ -0,0 +1,18 @@
1
+ # LagoAPI::Mrrs
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mrrs** | [**Array&lt;MrrObject&gt;**](MrrObject.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'lago_ruby'
13
+
14
+ instance = LagoAPI::Mrrs.new(
15
+ mrrs: null
16
+ )
17
+ ```
18
+
@@ -10,6 +10,7 @@
10
10
  | **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] |
11
11
  | **webhook_urls** | **Array&lt;String&gt;** | The array containing your webhooks URLs. | [optional] |
12
12
  | **country** | [**Country**](Country.md) | | [optional] |
13
+ | **default_currency** | [**Currency**](Currency.md) | | [optional] |
13
14
  | **address_line1** | **String** | The first line of your organization’s billing address. | [optional] |
14
15
  | **address_line2** | **String** | The second line of your organization’s billing address. | [optional] |
15
16
  | **state** | **String** | The state of your organization’s billing address. | [optional] |
@@ -36,6 +37,7 @@ instance = LagoAPI::OrganizationObject.new(
36
37
  webhook_url: https://webhook.brex.com,
37
38
  webhook_urls: [&quot;https://webhook.brex.com&quot;,&quot;https://webhook2.brex.com&quot;],
38
39
  country: null,
40
+ default_currency: null,
39
41
  address_line1: 100 Brex Street,
40
42
  address_line2: null,
41
43
  state: NYC,
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **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] |
8
8
  | **country** | [**Country**](Country.md) | | [optional] |
9
+ | **default_currency** | [**Currency**](Currency.md) | | [optional] |
9
10
  | **address_line1** | **String** | The first line of your organization’s billing address. | [optional] |
10
11
  | **address_line2** | **String** | The second line of your organization’s billing address. | [optional] |
11
12
  | **state** | **String** | The state of your organization’s billing address. | [optional] |
@@ -28,6 +29,7 @@ require 'lago_ruby'
28
29
  instance = LagoAPI::OrganizationUpdateInputOrganization.new(
29
30
  webhook_url: https://webhook.brex.com,
30
31
  country: null,
32
+ default_currency: null,
31
33
  address_line1: 100 Brex Street,
32
34
  address_line2: null,
33
35
  state: NYC,
@@ -0,0 +1,26 @@
1
+ # LagoAPI::OutstandingInvoiceObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **month** | **String** | Identifies the month to analyze revenue. | |
8
+ | **payment_status** | **String** | The payment status of the invoices. | [optional] |
9
+ | **invoices_count** | **Integer** | Contains invoices count. | |
10
+ | **amount_cents** | **Integer** | The total amount of revenue for a period, expressed in cents. | |
11
+ | **currency** | [**Currency**](Currency.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'lago_ruby'
17
+
18
+ instance = LagoAPI::OutstandingInvoiceObject.new(
19
+ month: 2023-11-01T00:00:00.000Z,
20
+ payment_status: succeeded,
21
+ invoices_count: 10,
22
+ amount_cents: 50000,
23
+ currency: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # LagoAPI::OutstandingInvoices
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **outstanding_invoices** | [**Array&lt;OutstandingInvoiceObject&gt;**](OutstandingInvoiceObject.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'lago_ruby'
13
+
14
+ instance = LagoAPI::OutstandingInvoices.new(
15
+ outstanding_invoices: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,32 @@
1
+ # LagoAPI::PlanOverridesObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **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] |
8
+ | **amount_currency** | [**Currency**](Currency.md) | | [optional] |
9
+ | **description** | **String** | The description on the plan. | [optional] |
10
+ | **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] |
11
+ | **name** | **String** | The name of the plan. | [optional] |
12
+ | **tax_codes** | **Array&lt;String&gt;** | List of unique code used to identify the taxes. | [optional] |
13
+ | **trial_period** | **Float** | The duration in days during which the base cost of the plan is offered for free. | [optional] |
14
+ | **charges** | [**Array&lt;PlanOverridesObjectChargesInner&gt;**](PlanOverridesObjectChargesInner.md) | Additional usage-based charges for this plan. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'lago_ruby'
20
+
21
+ instance = LagoAPI::PlanOverridesObject.new(
22
+ amount_cents: 10000,
23
+ amount_currency: null,
24
+ description: Plan for early stage startups.,
25
+ invoice_display_name: Startup plan,
26
+ name: Startup,
27
+ tax_codes: [&quot;french_standard_vat&quot;],
28
+ trial_period: 5,
29
+ charges: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,30 @@
1
+ # LagoAPI::PlanOverridesObjectChargesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier of the charge created by Lago. | [optional] |
8
+ | **billable_metric_id** | **String** | Unique identifier of the billable metric created by Lago. | [optional] |
9
+ | **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] |
10
+ | **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] |
11
+ | **properties** | [**ChargeObjectProperties**](ChargeObjectProperties.md) | | [optional] |
12
+ | **group_properties** | [**Array&lt;PlanCreateInputPlanChargesInnerGroupPropertiesInner&gt;**](PlanCreateInputPlanChargesInnerGroupPropertiesInner.md) | All charge information, sorted by groups. | [optional] |
13
+ | **tax_codes** | **Array&lt;String&gt;** | List of unique code used to identify the taxes. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'lago_ruby'
19
+
20
+ instance = LagoAPI::PlanOverridesObjectChargesInner.new(
21
+ id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
22
+ billable_metric_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
23
+ invoice_display_name: Setup,
24
+ min_amount_cents: 0,
25
+ properties: null,
26
+ group_properties: null,
27
+ tax_codes: [&quot;french_standard_vat&quot;]
28
+ )
29
+ ```
30
+
data/docs/Subscription.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **subscription** | [**SubscriptionObject**](SubscriptionObject.md) | | |
7
+ | **subscription** | [**SubscriptionObjectExtended**](SubscriptionObjectExtended.md) | | |
8
8
 
9
9
  ## Example
10
10