lago_ruby 0.51.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 (237) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -4
  3. data/docs/AddOnCreateInputAddOn.md +1 -1
  4. data/docs/AnalyticsApi.md +299 -0
  5. data/docs/CreditNoteItemObjectFee.md +4 -4
  6. data/docs/CustomerChargeUsageObjectCharge.md +3 -1
  7. data/docs/CustomersApi.md +70 -0
  8. data/docs/FeeObject.md +4 -4
  9. data/docs/GenerateCustomerCheckoutURL200Response.md +24 -0
  10. data/docs/GrossRevenueObject.md +22 -0
  11. data/docs/GrossRevenues.md +18 -0
  12. data/docs/InvoicedUsageObject.md +24 -0
  13. data/docs/InvoicedUsages.md +18 -0
  14. data/docs/MrrObject.md +22 -0
  15. data/docs/Mrrs.md +18 -0
  16. data/docs/OrganizationObject.md +2 -0
  17. data/docs/OrganizationUpdateInputOrganization.md +2 -0
  18. data/docs/OutstandingInvoiceObject.md +26 -0
  19. data/docs/OutstandingInvoices.md +18 -0
  20. data/docs/PlanOverridesObjectChargesInner.md +2 -0
  21. data/lago_ruby.gemspec +1 -1
  22. data/lib/lago_ruby/api/add_ons_api.rb +1 -1
  23. data/lib/lago_ruby/api/analytics_api.rb +268 -0
  24. data/lib/lago_ruby/api/billable_metrics_api.rb +1 -1
  25. data/lib/lago_ruby/api/coupons_api.rb +1 -1
  26. data/lib/lago_ruby/api/credit_notes_api.rb +1 -1
  27. data/lib/lago_ruby/api/customers_api.rb +64 -1
  28. data/lib/lago_ruby/api/events_api.rb +1 -1
  29. data/lib/lago_ruby/api/fees_api.rb +1 -1
  30. data/lib/lago_ruby/api/invoices_api.rb +1 -1
  31. data/lib/lago_ruby/api/organizations_api.rb +1 -1
  32. data/lib/lago_ruby/api/plans_api.rb +1 -1
  33. data/lib/lago_ruby/api/subscriptions_api.rb +1 -1
  34. data/lib/lago_ruby/api/taxes_api.rb +1 -1
  35. data/lib/lago_ruby/api/wallets_api.rb +1 -1
  36. data/lib/lago_ruby/api/webhook_endpoints_api.rb +1 -1
  37. data/lib/lago_ruby/api/webhooks_api.rb +1 -1
  38. data/lib/lago_ruby/api_client.rb +1 -1
  39. data/lib/lago_ruby/api_error.rb +1 -1
  40. data/lib/lago_ruby/configuration.rb +1 -1
  41. data/lib/lago_ruby/models/add_on.rb +1 -1
  42. data/lib/lago_ruby/models/add_on_base_input.rb +1 -1
  43. data/lib/lago_ruby/models/add_on_create_input.rb +1 -1
  44. data/lib/lago_ruby/models/add_on_create_input_add_on.rb +1 -1
  45. data/lib/lago_ruby/models/add_on_object.rb +1 -1
  46. data/lib/lago_ruby/models/add_on_update_input.rb +1 -1
  47. data/lib/lago_ruby/models/add_ons_paginated.rb +1 -1
  48. data/lib/lago_ruby/models/api_error_bad_request.rb +1 -1
  49. data/lib/lago_ruby/models/api_error_forbidden.rb +1 -1
  50. data/lib/lago_ruby/models/api_error_not_allowed.rb +1 -1
  51. data/lib/lago_ruby/models/api_error_not_found.rb +1 -1
  52. data/lib/lago_ruby/models/api_error_unauthorized.rb +1 -1
  53. data/lib/lago_ruby/models/api_error_unprocessable_entity.rb +1 -1
  54. data/lib/lago_ruby/models/applied_coupon.rb +1 -1
  55. data/lib/lago_ruby/models/applied_coupon_input.rb +1 -1
  56. data/lib/lago_ruby/models/applied_coupon_input_applied_coupon.rb +1 -1
  57. data/lib/lago_ruby/models/applied_coupon_object.rb +1 -1
  58. data/lib/lago_ruby/models/applied_coupon_object_extended.rb +1 -1
  59. data/lib/lago_ruby/models/applied_coupons_paginated.rb +1 -1
  60. data/lib/lago_ruby/models/base_applied_tax.rb +1 -1
  61. data/lib/lago_ruby/models/billable_metric.rb +1 -1
  62. data/lib/lago_ruby/models/billable_metric_base_input.rb +1 -1
  63. data/lib/lago_ruby/models/billable_metric_create_input.rb +1 -1
  64. data/lib/lago_ruby/models/billable_metric_create_input_billable_metric.rb +1 -1
  65. data/lib/lago_ruby/models/billable_metric_group.rb +1 -1
  66. data/lib/lago_ruby/models/billable_metric_group_values_inner.rb +1 -1
  67. data/lib/lago_ruby/models/billable_metric_group_values_inner_one_of.rb +1 -1
  68. data/lib/lago_ruby/models/billable_metric_object.rb +1 -1
  69. data/lib/lago_ruby/models/billable_metric_update_input.rb +1 -1
  70. data/lib/lago_ruby/models/billable_metrics_paginated.rb +1 -1
  71. data/lib/lago_ruby/models/charge_object.rb +1 -1
  72. data/lib/lago_ruby/models/charge_object_properties.rb +1 -1
  73. data/lib/lago_ruby/models/charge_properties.rb +1 -1
  74. data/lib/lago_ruby/models/charge_properties_graduated_percentage_ranges_inner.rb +1 -1
  75. data/lib/lago_ruby/models/charge_properties_graduated_ranges_inner.rb +1 -1
  76. data/lib/lago_ruby/models/charge_properties_volume_ranges_inner.rb +1 -1
  77. data/lib/lago_ruby/models/country.rb +1 -1
  78. data/lib/lago_ruby/models/coupon.rb +1 -1
  79. data/lib/lago_ruby/models/coupon_base_input.rb +1 -1
  80. data/lib/lago_ruby/models/coupon_base_input_applies_to.rb +1 -1
  81. data/lib/lago_ruby/models/coupon_create_input.rb +1 -1
  82. data/lib/lago_ruby/models/coupon_create_input_coupon.rb +1 -1
  83. data/lib/lago_ruby/models/coupon_object.rb +1 -1
  84. data/lib/lago_ruby/models/coupon_update_input.rb +1 -1
  85. data/lib/lago_ruby/models/coupons_paginated.rb +1 -1
  86. data/lib/lago_ruby/models/credit_note.rb +1 -1
  87. data/lib/lago_ruby/models/credit_note_applied_tax_object.rb +1 -1
  88. data/lib/lago_ruby/models/credit_note_create_input.rb +1 -1
  89. data/lib/lago_ruby/models/credit_note_create_input_credit_note.rb +1 -1
  90. data/lib/lago_ruby/models/credit_note_estimate_input.rb +1 -1
  91. data/lib/lago_ruby/models/credit_note_estimate_input_credit_note.rb +1 -1
  92. data/lib/lago_ruby/models/credit_note_estimate_input_credit_note_items_inner.rb +1 -1
  93. data/lib/lago_ruby/models/credit_note_estimated.rb +1 -1
  94. data/lib/lago_ruby/models/credit_note_estimated_estimated_credit_note.rb +1 -1
  95. data/lib/lago_ruby/models/credit_note_estimated_estimated_credit_note_applied_taxes_inner.rb +1 -1
  96. data/lib/lago_ruby/models/credit_note_estimated_estimated_credit_note_items_inner.rb +1 -1
  97. data/lib/lago_ruby/models/credit_note_item_object.rb +1 -1
  98. data/lib/lago_ruby/models/credit_note_item_object_fee.rb +5 -5
  99. data/lib/lago_ruby/models/credit_note_object.rb +1 -1
  100. data/lib/lago_ruby/models/credit_note_update_input.rb +1 -1
  101. data/lib/lago_ruby/models/credit_note_update_input_credit_note.rb +1 -1
  102. data/lib/lago_ruby/models/credit_notes.rb +1 -1
  103. data/lib/lago_ruby/models/credit_object.rb +1 -1
  104. data/lib/lago_ruby/models/credit_object_invoice.rb +1 -1
  105. data/lib/lago_ruby/models/credit_object_item.rb +1 -1
  106. data/lib/lago_ruby/models/currency.rb +1 -1
  107. data/lib/lago_ruby/models/customer.rb +1 -1
  108. data/lib/lago_ruby/models/customer_billing_configuration.rb +1 -1
  109. data/lib/lago_ruby/models/customer_charge_usage_object.rb +1 -1
  110. data/lib/lago_ruby/models/customer_charge_usage_object_billable_metric.rb +1 -1
  111. data/lib/lago_ruby/models/customer_charge_usage_object_charge.rb +15 -5
  112. data/lib/lago_ruby/models/customer_charge_usage_object_groups_inner.rb +1 -1
  113. data/lib/lago_ruby/models/customer_create_input.rb +1 -1
  114. data/lib/lago_ruby/models/customer_create_input_customer.rb +1 -1
  115. data/lib/lago_ruby/models/customer_create_input_customer_metadata_inner.rb +1 -1
  116. data/lib/lago_ruby/models/customer_metadata.rb +1 -1
  117. data/lib/lago_ruby/models/customer_object.rb +1 -1
  118. data/lib/lago_ruby/models/customer_object_extended.rb +1 -1
  119. data/lib/lago_ruby/models/customer_past_usage.rb +1 -1
  120. data/lib/lago_ruby/models/customer_usage.rb +1 -1
  121. data/lib/lago_ruby/models/customer_usage_object.rb +1 -1
  122. data/lib/lago_ruby/models/customers_paginated.rb +1 -1
  123. data/lib/lago_ruby/models/event.rb +1 -1
  124. data/lib/lago_ruby/models/event_batch_input.rb +1 -1
  125. data/lib/lago_ruby/models/event_batch_input_event.rb +1 -1
  126. data/lib/lago_ruby/models/event_batch_input_event_properties.rb +1 -1
  127. data/lib/lago_ruby/models/event_estimate_fees_input.rb +1 -1
  128. data/lib/lago_ruby/models/event_estimate_fees_input_event.rb +1 -1
  129. data/lib/lago_ruby/models/event_input.rb +1 -1
  130. data/lib/lago_ruby/models/event_input_event.rb +1 -1
  131. data/lib/lago_ruby/models/event_input_event_timestamp.rb +1 -1
  132. data/lib/lago_ruby/models/event_object.rb +1 -1
  133. data/lib/lago_ruby/models/event_object_properties.rb +1 -1
  134. data/lib/lago_ruby/models/fee.rb +1 -1
  135. data/lib/lago_ruby/models/fee_applied_tax_object.rb +1 -1
  136. data/lib/lago_ruby/models/fee_object.rb +5 -5
  137. data/lib/lago_ruby/models/fee_object_item.rb +1 -1
  138. data/lib/lago_ruby/models/fee_update_input.rb +1 -1
  139. data/lib/lago_ruby/models/fee_update_input_fee.rb +1 -1
  140. data/lib/lago_ruby/models/fees.rb +1 -1
  141. data/lib/lago_ruby/models/fees_paginated.rb +1 -1
  142. data/lib/lago_ruby/models/generate_customer_checkout_url200_response.rb +246 -0
  143. data/lib/lago_ruby/models/get_customer_portal_url200_response.rb +1 -1
  144. data/lib/lago_ruby/models/get_customer_portal_url200_response_customer.rb +1 -1
  145. data/lib/lago_ruby/models/gross_revenue_object.rb +241 -0
  146. data/lib/lago_ruby/models/gross_revenues.rb +223 -0
  147. data/lib/lago_ruby/models/group_object.rb +1 -1
  148. data/lib/lago_ruby/models/group_properties_object.rb +1 -1
  149. data/lib/lago_ruby/models/group_properties_object_values.rb +1 -1
  150. data/lib/lago_ruby/models/groups_paginated.rb +1 -1
  151. data/lib/lago_ruby/models/invoice.rb +1 -1
  152. data/lib/lago_ruby/models/invoice_applied_tax_object.rb +1 -1
  153. data/lib/lago_ruby/models/invoice_metadata_object.rb +1 -1
  154. data/lib/lago_ruby/models/invoice_object.rb +1 -1
  155. data/lib/lago_ruby/models/invoice_object_customer.rb +1 -1
  156. data/lib/lago_ruby/models/invoice_object_extended.rb +1 -1
  157. data/lib/lago_ruby/models/invoice_one_off_create_input.rb +1 -1
  158. data/lib/lago_ruby/models/invoice_one_off_create_input_invoice.rb +1 -1
  159. data/lib/lago_ruby/models/invoice_one_off_create_input_invoice_fees_inner.rb +1 -1
  160. data/lib/lago_ruby/models/invoice_update_input.rb +1 -1
  161. data/lib/lago_ruby/models/invoice_update_input_invoice.rb +1 -1
  162. data/lib/lago_ruby/models/invoice_update_input_invoice_metadata_inner.rb +1 -1
  163. data/lib/lago_ruby/models/invoiced_usage_object.rb +265 -0
  164. data/lib/lago_ruby/models/invoiced_usages.rb +223 -0
  165. data/lib/lago_ruby/models/invoices_paginated.rb +1 -1
  166. data/lib/lago_ruby/models/mrr_object.rb +241 -0
  167. data/lib/lago_ruby/models/mrrs.rb +223 -0
  168. data/lib/lago_ruby/models/organization.rb +1 -1
  169. data/lib/lago_ruby/models/organization_billing_configuration.rb +1 -1
  170. data/lib/lago_ruby/models/organization_object.rb +11 -2
  171. data/lib/lago_ruby/models/organization_update_input.rb +1 -1
  172. data/lib/lago_ruby/models/organization_update_input_organization.rb +11 -2
  173. data/lib/lago_ruby/models/outstanding_invoice_object.rb +309 -0
  174. data/lib/lago_ruby/models/outstanding_invoices.rb +223 -0
  175. data/lib/lago_ruby/models/pagination_meta.rb +1 -1
  176. data/lib/lago_ruby/models/plan.rb +1 -1
  177. data/lib/lago_ruby/models/plan_create_input.rb +1 -1
  178. data/lib/lago_ruby/models/plan_create_input_plan.rb +1 -1
  179. data/lib/lago_ruby/models/plan_create_input_plan_charges_inner.rb +1 -1
  180. data/lib/lago_ruby/models/plan_create_input_plan_charges_inner_group_properties_inner.rb +1 -1
  181. data/lib/lago_ruby/models/plan_object.rb +1 -1
  182. data/lib/lago_ruby/models/plan_overrides_object.rb +1 -1
  183. data/lib/lago_ruby/models/plan_overrides_object_charges_inner.rb +12 -2
  184. data/lib/lago_ruby/models/plan_update_input.rb +1 -1
  185. data/lib/lago_ruby/models/plan_update_input_plan.rb +1 -1
  186. data/lib/lago_ruby/models/plan_update_input_plan_charges_inner.rb +1 -1
  187. data/lib/lago_ruby/models/plans_paginated.rb +1 -1
  188. data/lib/lago_ruby/models/subscription.rb +1 -1
  189. data/lib/lago_ruby/models/subscription_create_input.rb +1 -1
  190. data/lib/lago_ruby/models/subscription_create_input_subscription.rb +1 -1
  191. data/lib/lago_ruby/models/subscription_object.rb +1 -1
  192. data/lib/lago_ruby/models/subscription_object_extended.rb +1 -1
  193. data/lib/lago_ruby/models/subscription_update_input.rb +1 -1
  194. data/lib/lago_ruby/models/subscription_update_input_subscription.rb +1 -1
  195. data/lib/lago_ruby/models/subscriptions_paginated.rb +1 -1
  196. data/lib/lago_ruby/models/tax.rb +1 -1
  197. data/lib/lago_ruby/models/tax_base_input.rb +1 -1
  198. data/lib/lago_ruby/models/tax_create_input.rb +1 -1
  199. data/lib/lago_ruby/models/tax_create_input_tax.rb +1 -1
  200. data/lib/lago_ruby/models/tax_object.rb +1 -1
  201. data/lib/lago_ruby/models/tax_update_input.rb +1 -1
  202. data/lib/lago_ruby/models/taxes_paginated.rb +1 -1
  203. data/lib/lago_ruby/models/timezone.rb +1 -1
  204. data/lib/lago_ruby/models/wallet.rb +1 -1
  205. data/lib/lago_ruby/models/wallet_create_input.rb +1 -1
  206. data/lib/lago_ruby/models/wallet_create_input_wallet.rb +1 -1
  207. data/lib/lago_ruby/models/wallet_object.rb +1 -1
  208. data/lib/lago_ruby/models/wallet_transaction_create_input.rb +1 -1
  209. data/lib/lago_ruby/models/wallet_transaction_create_input_wallet_transaction.rb +1 -1
  210. data/lib/lago_ruby/models/wallet_transaction_object.rb +1 -1
  211. data/lib/lago_ruby/models/wallet_transactions.rb +1 -1
  212. data/lib/lago_ruby/models/wallet_transactions_paginated.rb +1 -1
  213. data/lib/lago_ruby/models/wallet_update_input.rb +1 -1
  214. data/lib/lago_ruby/models/wallet_update_input_wallet.rb +1 -1
  215. data/lib/lago_ruby/models/wallets_paginated.rb +1 -1
  216. data/lib/lago_ruby/models/webhook_endpoint.rb +1 -1
  217. data/lib/lago_ruby/models/webhook_endpoint_create_input.rb +1 -1
  218. data/lib/lago_ruby/models/webhook_endpoint_create_input_webhook_endpoint.rb +1 -1
  219. data/lib/lago_ruby/models/webhook_endpoint_object.rb +1 -1
  220. data/lib/lago_ruby/models/webhook_endpoint_update_input.rb +1 -1
  221. data/lib/lago_ruby/models/webhook_endpoints_paginated.rb +1 -1
  222. data/lib/lago_ruby/version.rb +2 -2
  223. data/lib/lago_ruby.rb +11 -1
  224. data/spec/api/analytics_api_spec.rb +85 -0
  225. data/spec/api_client_spec.rb +1 -1
  226. data/spec/configuration_spec.rb +1 -1
  227. data/spec/models/generate_customer_checkout_url200_response_spec.rb +54 -0
  228. data/spec/models/gross_revenue_object_spec.rb +48 -0
  229. data/spec/models/gross_revenues_spec.rb +36 -0
  230. data/spec/models/invoiced_usage_object_spec.rb +54 -0
  231. data/spec/models/invoiced_usages_spec.rb +36 -0
  232. data/spec/models/mrr_object_spec.rb +48 -0
  233. data/spec/models/mrrs_spec.rb +36 -0
  234. data/spec/models/outstanding_invoice_object_spec.rb +64 -0
  235. data/spec/models/outstanding_invoices_spec.rb +36 -0
  236. data/spec/spec_helper.rb +1 -1
  237. metadata +204 -164
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8ee5d8ada117e17d202e6d6387b05da9fd389b8af53af0421f884badbcd7b252
4
- data.tar.gz: ddd36fe3358d8ebc558e6b63bc59cfe5a7f98dee008fdb2487adcc309e1cf151
3
+ metadata.gz: 22517ab6a07d771fc3b6e2c4e5826e883c85a1ddc1363dba6c51c55d847fc417
4
+ data.tar.gz: 1f31e891ed5521efec29d449e11602fd6cf54d6830f24a755df5cc38c0ca2a57
5
5
  SHA512:
6
- metadata.gz: ab5f789b2fde9cc7db29c750862486a78af93fe5e8d1eff22dfb4bec076daa1b29b9e73c7b8679a3c932b81c51fb799cd45641b5a8a356b8f7540aafaf260842
7
- data.tar.gz: ad643f65be23fa1f37d4b89561cad644d3443fc9e88e07e7d114f6b339c7b03edb88c7cd78d4b3c82f2cd545a870d43bb618c6eea1afbf0f84af78aa7037fb10
6
+ metadata.gz: 9e75d3ba2b0d5e02e7b2aeebd2f6c2926c0f12b03e9574f92baf700d256b684dcd79f4a0529bbf98d0969342bddba172a436a40774d528dafc7e0a7b6d566797
7
+ data.tar.gz: 9b7b2edc73da3aa2069a99204fb7d83180ad283713c8f12c59e0530d02bfda0ce8471f84cec7887b5b1cb377e535892f5c93ef280f3462acfaf42a09ec1c3741
data/README.md CHANGED
@@ -7,7 +7,7 @@ Lago API allows your application to push customer information and metrics (event
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 0.51.0-beta
10
- - Package version: 0.51.0-beta
10
+ - Package version: 0.52.0-beta
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
 
13
13
  [![Gem Version](https://badge.fury.io/rb/lago-ruby.svg)](https://badge.fury.io/rb/lago-ruby)
@@ -26,16 +26,16 @@ gem build lago_ruby.gemspec
26
26
  Then either install the gem locally:
27
27
 
28
28
  ```shell
29
- gem install ./lago_ruby-0.51.0-beta.gem
29
+ gem install ./lago_ruby-0.52.0-beta.gem
30
30
  ```
31
31
 
32
- (for development, run `gem install --dev ./lago_ruby-0.51.0-beta.gem` to install the development dependencies)
32
+ (for development, run `gem install --dev ./lago_ruby-0.52.0-beta.gem` to install the development dependencies)
33
33
 
34
34
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
35
35
 
36
36
  Finally add this to the Gemfile:
37
37
 
38
- gem 'lago_ruby', '~> 0.51.0-beta'
38
+ gem 'lago_ruby', '~> 0.52.0-beta'
39
39
 
40
40
  ### Install from Git
41
41
 
@@ -93,6 +93,10 @@ Class | Method | HTTP request | Description
93
93
  *LagoAPI::AddOnsApi* | [**find_add_on**](docs/AddOnsApi.md#find_add_on) | **GET** /add_ons/{code} | Retrieve an add-on
94
94
  *LagoAPI::AddOnsApi* | [**find_all_add_ons**](docs/AddOnsApi.md#find_all_add_ons) | **GET** /add_ons | List all add-ons
95
95
  *LagoAPI::AddOnsApi* | [**update_add_on**](docs/AddOnsApi.md#update_add_on) | **PUT** /add_ons/{code} | Update an add-on
96
+ *LagoAPI::AnalyticsApi* | [**find_all_gross_revenues**](docs/AnalyticsApi.md#find_all_gross_revenues) | **GET** /analytics/gross_revenue | List gross revenue
97
+ *LagoAPI::AnalyticsApi* | [**find_all_invoiced_usages**](docs/AnalyticsApi.md#find_all_invoiced_usages) | **GET** /analytics/invoiced_usage | List usage revenue
98
+ *LagoAPI::AnalyticsApi* | [**find_all_mrrs**](docs/AnalyticsApi.md#find_all_mrrs) | **GET** /analytics/mrr | List MRR
99
+ *LagoAPI::AnalyticsApi* | [**find_all_outstanding_invoices**](docs/AnalyticsApi.md#find_all_outstanding_invoices) | **GET** /analytics/outstanding_invoices | List outstanding invoices
96
100
  *LagoAPI::BillableMetricsApi* | [**create_billable_metric**](docs/BillableMetricsApi.md#create_billable_metric) | **POST** /billable_metrics | Create a billable metric
97
101
  *LagoAPI::BillableMetricsApi* | [**destroy_billable_metric**](docs/BillableMetricsApi.md#destroy_billable_metric) | **DELETE** /billable_metrics/{code} | Delete a billable metric
98
102
  *LagoAPI::BillableMetricsApi* | [**find_all_billable_metric_groups**](docs/BillableMetricsApi.md#find_all_billable_metric_groups) | **GET** /billable_metrics/{code}/groups | Find a billable metric's groups
@@ -121,6 +125,7 @@ Class | Method | HTTP request | Description
121
125
  *LagoAPI::CustomersApi* | [**find_all_customers**](docs/CustomersApi.md#find_all_customers) | **GET** /customers | List all customers
122
126
  *LagoAPI::CustomersApi* | [**find_customer**](docs/CustomersApi.md#find_customer) | **GET** /customers/{external_id} | Retrieve a customer
123
127
  *LagoAPI::CustomersApi* | [**find_customer_current_usage**](docs/CustomersApi.md#find_customer_current_usage) | **GET** /customers/{external_customer_id}/current_usage | Retrieve customer current usage
128
+ *LagoAPI::CustomersApi* | [**generate_customer_checkout_url**](docs/CustomersApi.md#generate_customer_checkout_url) | **POST** /customers/{external_customer_id}/checkout_url | Generate a Customer Payment Provider Checkout URL
124
129
  *LagoAPI::CustomersApi* | [**get_customer_portal_url**](docs/CustomersApi.md#get_customer_portal_url) | **GET** /customers/{external_customer_id}/portal_url | Get a customer portal URL
125
130
  *LagoAPI::EventsApi* | [**create_batch_events**](docs/EventsApi.md#create_batch_events) | **POST** /events/batch | Batch multiple events
126
131
  *LagoAPI::EventsApi* | [**create_event**](docs/EventsApi.md#create_event) | **POST** /events | Send usage events
@@ -271,8 +276,11 @@ Class | Method | HTTP request | Description
271
276
  - [LagoAPI::FeeUpdateInputFee](docs/FeeUpdateInputFee.md)
272
277
  - [LagoAPI::Fees](docs/Fees.md)
273
278
  - [LagoAPI::FeesPaginated](docs/FeesPaginated.md)
279
+ - [LagoAPI::GenerateCustomerCheckoutURL200Response](docs/GenerateCustomerCheckoutURL200Response.md)
274
280
  - [LagoAPI::GetCustomerPortalUrl200Response](docs/GetCustomerPortalUrl200Response.md)
275
281
  - [LagoAPI::GetCustomerPortalUrl200ResponseCustomer](docs/GetCustomerPortalUrl200ResponseCustomer.md)
282
+ - [LagoAPI::GrossRevenueObject](docs/GrossRevenueObject.md)
283
+ - [LagoAPI::GrossRevenues](docs/GrossRevenues.md)
276
284
  - [LagoAPI::GroupObject](docs/GroupObject.md)
277
285
  - [LagoAPI::GroupPropertiesObject](docs/GroupPropertiesObject.md)
278
286
  - [LagoAPI::GroupPropertiesObjectValues](docs/GroupPropertiesObjectValues.md)
@@ -289,12 +297,18 @@ Class | Method | HTTP request | Description
289
297
  - [LagoAPI::InvoiceUpdateInput](docs/InvoiceUpdateInput.md)
290
298
  - [LagoAPI::InvoiceUpdateInputInvoice](docs/InvoiceUpdateInputInvoice.md)
291
299
  - [LagoAPI::InvoiceUpdateInputInvoiceMetadataInner](docs/InvoiceUpdateInputInvoiceMetadataInner.md)
300
+ - [LagoAPI::InvoicedUsageObject](docs/InvoicedUsageObject.md)
301
+ - [LagoAPI::InvoicedUsages](docs/InvoicedUsages.md)
292
302
  - [LagoAPI::InvoicesPaginated](docs/InvoicesPaginated.md)
303
+ - [LagoAPI::MrrObject](docs/MrrObject.md)
304
+ - [LagoAPI::Mrrs](docs/Mrrs.md)
293
305
  - [LagoAPI::Organization](docs/Organization.md)
294
306
  - [LagoAPI::OrganizationBillingConfiguration](docs/OrganizationBillingConfiguration.md)
295
307
  - [LagoAPI::OrganizationObject](docs/OrganizationObject.md)
296
308
  - [LagoAPI::OrganizationUpdateInput](docs/OrganizationUpdateInput.md)
297
309
  - [LagoAPI::OrganizationUpdateInputOrganization](docs/OrganizationUpdateInputOrganization.md)
310
+ - [LagoAPI::OutstandingInvoiceObject](docs/OutstandingInvoiceObject.md)
311
+ - [LagoAPI::OutstandingInvoices](docs/OutstandingInvoices.md)
298
312
  - [LagoAPI::PaginationMeta](docs/PaginationMeta.md)
299
313
  - [LagoAPI::Plan](docs/Plan.md)
300
314
  - [LagoAPI::PlanCreateInput](docs/PlanCreateInput.md)
@@ -24,7 +24,7 @@ instance = LagoAPI::AddOnCreateInputAddOn.new(
24
24
  amount_cents: 50000,
25
25
  amount_currency: null,
26
26
  description: Implementation fee for new customers.,
27
- tax_codes: ["french_standard_vat"]
27
+ tax_codes: [french_standard_vat]
28
28
  )
29
29
  ```
30
30
 
@@ -0,0 +1,299 @@
1
+ # LagoAPI::AnalyticsApi
2
+
3
+ All URIs are relative to *https://api.getlago.com/api/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**find_all_gross_revenues**](AnalyticsApi.md#find_all_gross_revenues) | **GET** /analytics/gross_revenue | List gross revenue |
8
+ | [**find_all_invoiced_usages**](AnalyticsApi.md#find_all_invoiced_usages) | **GET** /analytics/invoiced_usage | List usage revenue |
9
+ | [**find_all_mrrs**](AnalyticsApi.md#find_all_mrrs) | **GET** /analytics/mrr | List MRR |
10
+ | [**find_all_outstanding_invoices**](AnalyticsApi.md#find_all_outstanding_invoices) | **GET** /analytics/outstanding_invoices | List outstanding invoices |
11
+
12
+
13
+ ## find_all_gross_revenues
14
+
15
+ > <GrossRevenues> find_all_gross_revenues(opts)
16
+
17
+ List gross revenue
18
+
19
+ Gross revenue is the sum of monthly `finalized` invoice payments and fees paid in advance that are not invoiceable. This total is calculated after deducting taxes and discounts.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'lago_ruby'
26
+ # setup authorization
27
+ LagoAPI.configure do |config|
28
+ # Configure Bearer authorization: bearerAuth
29
+ config.access_token = 'YOUR_BEARER_TOKEN'
30
+ end
31
+
32
+ api_instance = LagoAPI::AnalyticsApi.new
33
+ opts = {
34
+ currency: LagoAPI::Currency::AED, # Currency | Currency of revenue analytics. Format must be ISO 4217.
35
+ external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba' # String | The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.
36
+ }
37
+
38
+ begin
39
+ # List gross revenue
40
+ result = api_instance.find_all_gross_revenues(opts)
41
+ p result
42
+ rescue LagoAPI::ApiError => e
43
+ puts "Error when calling AnalyticsApi->find_all_gross_revenues: #{e}"
44
+ end
45
+ ```
46
+
47
+ #### Using the find_all_gross_revenues_with_http_info variant
48
+
49
+ This returns an Array which contains the response data, status code and headers.
50
+
51
+ > <Array(<GrossRevenues>, Integer, Hash)> find_all_gross_revenues_with_http_info(opts)
52
+
53
+ ```ruby
54
+ begin
55
+ # List gross revenue
56
+ data, status_code, headers = api_instance.find_all_gross_revenues_with_http_info(opts)
57
+ p status_code # => 2xx
58
+ p headers # => { ... }
59
+ p data # => <GrossRevenues>
60
+ rescue LagoAPI::ApiError => e
61
+ puts "Error when calling AnalyticsApi->find_all_gross_revenues_with_http_info: #{e}"
62
+ end
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ | Name | Type | Description | Notes |
68
+ | ---- | ---- | ----------- | ----- |
69
+ | **currency** | [**Currency**](.md) | Currency of revenue analytics. Format must be ISO 4217. | [optional] |
70
+ | **external_customer_id** | **String** | The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. | [optional] |
71
+
72
+ ### Return type
73
+
74
+ [**GrossRevenues**](GrossRevenues.md)
75
+
76
+ ### Authorization
77
+
78
+ [bearerAuth](../README.md#bearerAuth)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: Not defined
83
+ - **Accept**: application/json
84
+
85
+
86
+ ## find_all_invoiced_usages
87
+
88
+ > <InvoicedUsages> find_all_invoiced_usages(opts)
89
+
90
+ List usage revenue
91
+
92
+ Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.
93
+
94
+ ### Examples
95
+
96
+ ```ruby
97
+ require 'time'
98
+ require 'lago_ruby'
99
+ # setup authorization
100
+ LagoAPI.configure do |config|
101
+ # Configure Bearer authorization: bearerAuth
102
+ config.access_token = 'YOUR_BEARER_TOKEN'
103
+ end
104
+
105
+ api_instance = LagoAPI::AnalyticsApi.new
106
+ opts = {
107
+ currency: LagoAPI::Currency::AED # Currency | The currency of invoiced usage analytics. Format must be ISO 4217.
108
+ }
109
+
110
+ begin
111
+ # List usage revenue
112
+ result = api_instance.find_all_invoiced_usages(opts)
113
+ p result
114
+ rescue LagoAPI::ApiError => e
115
+ puts "Error when calling AnalyticsApi->find_all_invoiced_usages: #{e}"
116
+ end
117
+ ```
118
+
119
+ #### Using the find_all_invoiced_usages_with_http_info variant
120
+
121
+ This returns an Array which contains the response data, status code and headers.
122
+
123
+ > <Array(<InvoicedUsages>, Integer, Hash)> find_all_invoiced_usages_with_http_info(opts)
124
+
125
+ ```ruby
126
+ begin
127
+ # List usage revenue
128
+ data, status_code, headers = api_instance.find_all_invoiced_usages_with_http_info(opts)
129
+ p status_code # => 2xx
130
+ p headers # => { ... }
131
+ p data # => <InvoicedUsages>
132
+ rescue LagoAPI::ApiError => e
133
+ puts "Error when calling AnalyticsApi->find_all_invoiced_usages_with_http_info: #{e}"
134
+ end
135
+ ```
136
+
137
+ ### Parameters
138
+
139
+ | Name | Type | Description | Notes |
140
+ | ---- | ---- | ----------- | ----- |
141
+ | **currency** | [**Currency**](.md) | The currency of invoiced usage analytics. Format must be ISO 4217. | [optional] |
142
+
143
+ ### Return type
144
+
145
+ [**InvoicedUsages**](InvoicedUsages.md)
146
+
147
+ ### Authorization
148
+
149
+ [bearerAuth](../README.md#bearerAuth)
150
+
151
+ ### HTTP request headers
152
+
153
+ - **Content-Type**: Not defined
154
+ - **Accept**: application/json
155
+
156
+
157
+ ## find_all_mrrs
158
+
159
+ > <Mrrs> find_all_mrrs(opts)
160
+
161
+ List MRR
162
+
163
+ This endpoint is used to list MRR.
164
+
165
+ ### Examples
166
+
167
+ ```ruby
168
+ require 'time'
169
+ require 'lago_ruby'
170
+ # setup authorization
171
+ LagoAPI.configure do |config|
172
+ # Configure Bearer authorization: bearerAuth
173
+ config.access_token = 'YOUR_BEARER_TOKEN'
174
+ end
175
+
176
+ api_instance = LagoAPI::AnalyticsApi.new
177
+ opts = {
178
+ currency: LagoAPI::Currency::AED, # Currency | Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and prior to the deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle: - Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued. - Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next three months) as well as to fees paid in arrears (allocated to the preceding three months). - Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next twelve months) and for fees paid in arrears (spread over the previous twelve months). - Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.
179
+ months: 12 # Integer | Show data only for given number of months.
180
+ }
181
+
182
+ begin
183
+ # List MRR
184
+ result = api_instance.find_all_mrrs(opts)
185
+ p result
186
+ rescue LagoAPI::ApiError => e
187
+ puts "Error when calling AnalyticsApi->find_all_mrrs: #{e}"
188
+ end
189
+ ```
190
+
191
+ #### Using the find_all_mrrs_with_http_info variant
192
+
193
+ This returns an Array which contains the response data, status code and headers.
194
+
195
+ > <Array(<Mrrs>, Integer, Hash)> find_all_mrrs_with_http_info(opts)
196
+
197
+ ```ruby
198
+ begin
199
+ # List MRR
200
+ data, status_code, headers = api_instance.find_all_mrrs_with_http_info(opts)
201
+ p status_code # => 2xx
202
+ p headers # => { ... }
203
+ p data # => <Mrrs>
204
+ rescue LagoAPI::ApiError => e
205
+ puts "Error when calling AnalyticsApi->find_all_mrrs_with_http_info: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ | Name | Type | Description | Notes |
212
+ | ---- | ---- | ----------- | ----- |
213
+ | **currency** | [**Currency**](.md) | Quantifies the revenue generated from &#x60;subscription&#x60; fees on a monthly basis. This figure is calculated post-application of applicable taxes and prior to the deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle: - Revenue from &#x60;monthly&#x60; subscription invoices is included in the MRR for the month in which the invoice is issued. - Revenue from &#x60;quarterly&#x60; subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next three months) as well as to fees paid in arrears (allocated to the preceding three months). - Revenue from &#x60;yearly&#x60; subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next twelve months) and for fees paid in arrears (spread over the previous twelve months). - Revenue from &#x60;weekly&#x60; subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month. | [optional] |
214
+ | **months** | **Integer** | Show data only for given number of months. | [optional] |
215
+
216
+ ### Return type
217
+
218
+ [**Mrrs**](Mrrs.md)
219
+
220
+ ### Authorization
221
+
222
+ [bearerAuth](../README.md#bearerAuth)
223
+
224
+ ### HTTP request headers
225
+
226
+ - **Content-Type**: Not defined
227
+ - **Accept**: application/json
228
+
229
+
230
+ ## find_all_outstanding_invoices
231
+
232
+ > <OutstandingInvoices> find_all_outstanding_invoices(opts)
233
+
234
+ List outstanding invoices
235
+
236
+ Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.
237
+
238
+ ### Examples
239
+
240
+ ```ruby
241
+ require 'time'
242
+ require 'lago_ruby'
243
+ # setup authorization
244
+ LagoAPI.configure do |config|
245
+ # Configure Bearer authorization: bearerAuth
246
+ config.access_token = 'YOUR_BEARER_TOKEN'
247
+ end
248
+
249
+ api_instance = LagoAPI::AnalyticsApi.new
250
+ opts = {
251
+ currency: LagoAPI::Currency::AED # Currency | The currency of revenue analytics. Format must be ISO 4217.
252
+ }
253
+
254
+ begin
255
+ # List outstanding invoices
256
+ result = api_instance.find_all_outstanding_invoices(opts)
257
+ p result
258
+ rescue LagoAPI::ApiError => e
259
+ puts "Error when calling AnalyticsApi->find_all_outstanding_invoices: #{e}"
260
+ end
261
+ ```
262
+
263
+ #### Using the find_all_outstanding_invoices_with_http_info variant
264
+
265
+ This returns an Array which contains the response data, status code and headers.
266
+
267
+ > <Array(<OutstandingInvoices>, Integer, Hash)> find_all_outstanding_invoices_with_http_info(opts)
268
+
269
+ ```ruby
270
+ begin
271
+ # List outstanding invoices
272
+ data, status_code, headers = api_instance.find_all_outstanding_invoices_with_http_info(opts)
273
+ p status_code # => 2xx
274
+ p headers # => { ... }
275
+ p data # => <OutstandingInvoices>
276
+ rescue LagoAPI::ApiError => e
277
+ puts "Error when calling AnalyticsApi->find_all_outstanding_invoices_with_http_info: #{e}"
278
+ end
279
+ ```
280
+
281
+ ### Parameters
282
+
283
+ | Name | Type | Description | Notes |
284
+ | ---- | ---- | ----------- | ----- |
285
+ | **currency** | [**Currency**](.md) | The currency of revenue analytics. Format must be ISO 4217. | [optional] |
286
+
287
+ ### Return type
288
+
289
+ [**OutstandingInvoices**](OutstandingInvoices.md)
290
+
291
+ ### Authorization
292
+
293
+ [bearerAuth](../README.md#bearerAuth)
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: Not defined
298
+ - **Accept**: application/json
299
+
@@ -9,10 +9,10 @@
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) | | |
@@ -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/FeeObject.md CHANGED
@@ -9,10 +9,10 @@
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) | | |
@@ -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
+