Rust API client for openapi

Lago API allows your application to push customer information and metrics (events) from your application to the billing application.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 0.32.0-beta
• Package version: 0.32.0-beta
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to https://api.getlago.com/api/v1

Class	Method	HTTP request	Description
AddOnsApi	apply_add_on	POST /applied_add_ons	Apply an add-on to a customer
AddOnsApi	create_add_on	POST /add_ons	Create a new add-on
AddOnsApi	destroy_add_on	DELETE /add_ons/{code}	Delete an add-on
AddOnsApi	find_add_on	GET /add_ons/{code}	Find add-on by code
AddOnsApi	find_all_add_ons	GET /add_ons	Find add-ons
AddOnsApi	update_add_on	PUT /add_ons/{code}	Update an existing add-on
BillableMetricsApi	create_billable_metric	POST /billable_metrics	Create a new billable metric
BillableMetricsApi	destroy_billable_metric	DELETE /billable_metrics/{code}	Delete a billable metric
BillableMetricsApi	find_all_billable_metric_groups	GET /billable_metrics/{code}/groups	Find Billable metric groups
BillableMetricsApi	find_all_billable_metrics	GET /billable_metrics	Find Billable metrics
BillableMetricsApi	find_billable_metric	GET /billable_metrics/{code}	Find billable metric by code
BillableMetricsApi	update_billable_metric	PUT /billable_metrics/{code}	Update an existing billable metric
CouponsApi	apply_coupon	POST /applied_coupons	Apply a coupon to a customer
CouponsApi	create_coupon	POST /coupons	Create a new coupon
CouponsApi	destroy_coupon	DELETE /coupons/{code}	Delete a coupon
CouponsApi	find_all_applied_coupons	GET /applied_coupons	Find Applied Coupons
CouponsApi	find_all_coupons	GET /coupons	Find Coupons
CouponsApi	find_coupon	GET /coupons/{code}	Find coupon by code
CouponsApi	update_coupon	PUT /coupons/{code}	Update an existing coupon
CreditNotesApi	create_credit_note	POST /credit_notes	Create a new Credit note
CreditNotesApi	download_credit_note	POST /credit_notes/{id}/download	Download an existing credit note
CreditNotesApi	find_all_credit_notes	GET /credit_notes	Find Credit notes
CreditNotesApi	find_credit_note	GET /credit_notes/{id}	Find credit note
CreditNotesApi	update_credit_note	PUT /credit_notes/{id}	Update an existing credit note
CreditNotesApi	void_credit_note	PUT /credit_notes/{id}/void	Void existing credit note
CustomersApi	create_customer	POST /customers	Create a customer
CustomersApi	delete_applied_coupon	DELETE /customers/{customer_external_id}/applied_coupons/{applied_coupon_id}	Delete customer's appplied coupon
CustomersApi	destroy_customer	DELETE /customers/{external_id}	Delete a customer
CustomersApi	find_all_customers	GET /customers	Find customers
CustomersApi	find_customer	GET /customers/{external_id}	Find customer by external ID
CustomersApi	find_customer_current_usage	GET /customers/{customer_external_id}/current_usage	Find customer current usage
CustomersApi	get_customer_portal_url	GET /customers/{customer_external_id}/portal_url	Get customer portal URL
EventsApi	create_batch_events	POST /events/batch	Create batch events
EventsApi	create_event	POST /events	Create a new event
EventsApi	event_estimate_fees	POST /events/estimate_fees	Estimate fees for an instant charge
EventsApi	find_event	GET /events/{id}	Find event by transaction ID
FeesApi	find_all_fees	GET /fees	Find all fees
FeesApi	find_fee	GET /fees/{id}	Find fee by ID
FeesApi	update_fee	PUT /fees/{id}	Update an existing fee
InvoicesApi	create_invoice	POST /invoices	Create a new invoice
InvoicesApi	download_invoice	POST /invoices/{id}/download	Download an existing invoice
InvoicesApi	finalize_invoice	PUT /invoices/{id}/finalize	Finalize a draft invoice
InvoicesApi	find_all_invoices	GET /invoices	Find all invoices
InvoicesApi	find_invoice	GET /invoices/{id}	Find invoice by ID
InvoicesApi	refresh_invoice	PUT /invoices/{id}/refresh	Refresh a draft invoice
InvoicesApi	retry_payment	POST /invoices/{id}/retry_payment	Retry invoice payment
InvoicesApi	update_invoice	PUT /invoices/{id}	Update an existing invoice status
OrganizationsApi	update_organization	PUT /organizations	Update an existing Organization
PlansApi	create_plan	POST /plans	Create a new plan
PlansApi	destroy_plan	DELETE /plans/{code}	Delete a plan
PlansApi	find_all_plans	GET /plans	Find plans
PlansApi	find_plan	GET /plans/{code}	Find plan by code
PlansApi	update_plan	PUT /plans/{code}	Update an existing plan
SubscriptionsApi	create_subscription	POST /subscriptions	Assign a plan to a customer
SubscriptionsApi	destroy_subscription	DELETE /subscriptions/{external_id}	Terminate a subscription
SubscriptionsApi	find_all_subscriptions	GET /subscriptions	Find subscriptions
SubscriptionsApi	update_subscription	PUT /subscriptions/{external_id}	Update an existing subscription
WalletsApi	create_wallet	POST /wallets	Create a new wallet
WalletsApi	create_wallet_transaction	POST /wallet_transactions	Create a new wallet transaction
WalletsApi	destroy_wallet	DELETE /wallets/{id}	Delete a wallet
WalletsApi	find_all_wallet_transactions	GET /wallets/{id}/wallet_transactions	Find wallet transactions
WalletsApi	find_all_wallets	GET /wallets	Find wallets
WalletsApi	find_wallet	GET /wallets/{id}	Find wallet
WalletsApi	update_wallet	PUT /wallets/{id}	Update an existing wallet
WebhooksApi	fetch_public_key	GET /webhooks/public_key	Fetch webhook public key

Documentation For Models

• AddOn
• AddOnInput
• AddOnInputAddOn
• AddOnObject
• AddOnsPaginated
• ApiResponseBadRequest
• ApiResponseForbidden
• ApiResponseNotAllowed
• ApiResponseNotFound
• ApiResponseUnauthorized
• ApiResponseUnprocessableEntity
• AppliedAddOn
• AppliedAddOnInput
• AppliedAddOnInputAppliedAddOn
• AppliedAddOnObject
• AppliedCoupon
• AppliedCouponInput
• AppliedCouponInputAppliedCoupon
• AppliedCouponObject
• AppliedCouponObjectExtended
• AppliedCouponObjectExtendedAllOf
• AppliedCouponsPaginated
• BatchEventInput
• BatchEventInputEvent
• BillableMetric
• BillableMetricGroup
• BillableMetricGroupValuesInner
• BillableMetricInput
• BillableMetricInputBillableMetric
• BillableMetricObject
• BillableMetricsPaginated
• BillingConfigurationCustomer
• BillingConfigurationOrganization
• ChargeObject
• ChargeUsageObject
• ChargeUsageObjectBillableMetric
• ChargeUsageObjectCharge
• ChargeUsageObjectGroupsInner
• Coupon
• CouponInput
• CouponInputCoupon
• CouponInputCouponAppliesTo
• CouponObject
• CouponsPaginated
• CreditNote
• CreditNoteInput
• CreditNoteInputCreditNote
• CreditNoteInputCreditNoteItemsInner
• CreditNoteItemObject
• CreditNoteObject
• CreditNoteUpdateInput
• CreditNoteUpdateInputCreditNote
• CreditNotes
• CreditObject
• CreditObjectInvoice
• CreditObjectItem
• Customer
• CustomerInput
• CustomerInputCustomer
• CustomerInputCustomerMetadataInner
• CustomerMetadataObject
• CustomerObject
• CustomerUsage
• CustomerUsageObject
• CustomersPaginated
• Event
• EventEstimateFeesInput
• EventEstimateFeesInputEvent
• EventInput
• EventInputEvent
• EventObject
• FeeObject
• FeeObjectItem
• FeeUpdateInput
• FeeUpdateInputInvoice
• Fees
• FeesPaginated
• FeesPaginatedAllOf
• GetCustomerPortalUrl200Response
• GetCustomerPortalUrl200ResponseCustomer
• GroupObject
• GroupPropertiesObject
• GroupsPaginated
• Invoice
• InvoiceInput
• InvoiceInputInvoice
• InvoiceInputInvoiceMetadataInner
• InvoiceMetadataObject
• InvoiceObject
• InvoiceObjectExtended
• InvoiceObjectExtendedAllOf
• InvoiceOneOffInput
• InvoiceOneOffInputInvoice
• InvoiceOneOffInputInvoiceFeesInner
• InvoicesPaginated
• Organization
• OrganizationInput
• OrganizationInputOrganization
• OrganizationObject
• PaginationMeta
• Plan
• PlanInput
• PlanInputPlan
• PlanInputPlanChargesInner
• PlanInputPlanChargesInnerGroupPropertiesInner
• PlanObject
• PlansPaginated
• Subscription
• SubscriptionCreateInput
• SubscriptionCreateInputSubscription
• SubscriptionObject
• SubscriptionUpdateInput
• SubscriptionUpdateInputSubscription
• SubscriptionsPaginated
• Wallet
• WalletInput
• WalletInputWallet
• WalletObject
• WalletTransactionInput
• WalletTransactionInputWalletTransaction
• WalletTransactionObject
• WalletTransactions
• WalletTransactionsPaginated
• WalletUpdateInput
• WalletUpdateInputWallet
• WalletsPaginated

To get access to the crate's generated documentation, use:

cargo doc --open

Author

tech@getlago.com