Lago

# Lago

## Docs

- [The add-on object](https://getlago.com/docs/api-reference/add-ons/add-on-object.md): This object represents an add-on, a one-time fee that can be applied on one-off invoices.
- [Create an add-on](https://getlago.com/docs/api-reference/add-ons/create.md): This endpoint is used to create an add-on that can be then attached to a one-off invoice.
- [Delete an add-on](https://getlago.com/docs/api-reference/add-ons/destroy.md): This endpoint is used to delete an existing add-on.
- [List all add-ons](https://getlago.com/docs/api-reference/add-ons/get-all.md): This endpoint is used to list all existing add-ons.
- [Retrieve an add-on](https://getlago.com/docs/api-reference/add-ons/get-specific.md): This endpoint is used to retrieve a specific add-on.
- [Update an add-on](https://getlago.com/docs/api-reference/add-ons/update.md): This endpoint is used to update an existing add-on.
- [The alert object](https://getlago.com/docs/api-reference/alerts/alert-object.md): This object represents an alert to monitor your subscriptions' usage and billing by firing notifications when certain conditions are met.
- [Create an alert](https://getlago.com/docs/api-reference/alerts/create.md): This endpoint allows you to create a new alert for a subscription.
- [Delete an alert](https://getlago.com/docs/api-reference/alerts/delete.md): This endpoint allows you to delete an existing alert for a subscription.
- [List all alerts](https://getlago.com/docs/api-reference/alerts/get-all.md): This endpoint allows you to retrieve all alerts for a subscription.
- [Retrieve an alert](https://getlago.com/docs/api-reference/alerts/get-specific.md): This endpoint allows you to retrieve a specific alert for a subscription.
- [Update an alert](https://getlago.com/docs/api-reference/alerts/update.md): This endpoint allows you to update an existing alert for a subscription.
- [Retrieve gross revenue](https://getlago.com/docs/api-reference/analytics/gross-revenue.md): 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.
- [Retrieve invoice collection](https://getlago.com/docs/api-reference/analytics/invoice-collection.md): 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`.
- [Retrieve invoiced usage](https://getlago.com/docs/api-reference/analytics/invoiced-usage.md): 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.
- [Retrieve MRR (monthly recurring revenue)](https://getlago.com/docs/api-reference/analytics/mrr.md): This endpoint is used to list MRR.
- [Retrieve overdue balance](https://getlago.com/docs/api-reference/analytics/overdue-balance.md): Overdue balance is the total amount associated with overdue invoices (invoices with pending or failed payments which are past their due dates).
- [API standards](https://getlago.com/docs/api-reference/api-standards.md)
- [The activity log object](https://getlago.com/docs/api-reference/audit-logs/activity-logs-object.md): This object represents an activity log entry of any actions performed on application resources.
- [The API log object](https://getlago.com/docs/api-reference/audit-logs/api-logs-object.md): This object represents an API log entry of any actions performed through the API endpoints.
- [List all activity logs](https://getlago.com/docs/api-reference/audit-logs/get-all-activity-logs.md): This endpoint retrieves all existing activity logs that represent actions performed on application resources.
- [List all API logs](https://getlago.com/docs/api-reference/audit-logs/get-all-api-logs.md): This endpoint retrieves all existing api logs that represent requests performed to Lago's API.
- [Retrieve an activity log](https://getlago.com/docs/api-reference/audit-logs/get-specific-activity-log.md): This endpoint retrieves an existing activity log that represents an action performed on some resource. The activity log is identified by its unique activity_id.
- [Retrieve an API log](https://getlago.com/docs/api-reference/audit-logs/get-specific-api-log.md): This endpoint retrieves an existing api log that represents a request made to the API. The api log is identified by its unique request_id.
- [Create a billable metric](https://getlago.com/docs/api-reference/billable-metrics/create.md): This endpoint creates a new billable metric representing a pricing component of your application.
- [Delete a billable metric](https://getlago.com/docs/api-reference/billable-metrics/destroy.md): This endpoint deletes an existing billable metric representing a pricing component of your application.
- [List all billable metrics](https://getlago.com/docs/api-reference/billable-metrics/get-all.md): This endpoint retrieves all existing billable metrics that represent pricing components of your application.
- [Retrieve a billable metric](https://getlago.com/docs/api-reference/billable-metrics/get-specific.md): This endpoint retrieves an existing billable metric that represents a pricing component of your application. The billable metric is identified by its unique code.
- [The billable metric object](https://getlago.com/docs/api-reference/billable-metrics/object.md): This object represents a billable metric used to define how incoming events are aggregated in order to measure consumption.
- [Update a billable metric](https://getlago.com/docs/api-reference/billable-metrics/update.md): This endpoint updates an existing billable metric representing a pricing component of your application.
- [Create a billing entity](https://getlago.com/docs/api-reference/billing-entities/create.md): This endpoint is used to create a new billing entity
- [List all billing entities](https://getlago.com/docs/api-reference/billing-entities/get-all.md): This endpoint returns a list of all billing entities in the organization
- [Retrieve a billing entity](https://getlago.com/docs/api-reference/billing-entities/get-specific.md): This endpoint returns a specific billing entity by its code
- [The billing entity object](https://getlago.com/docs/api-reference/billing-entities/object.md): This object represents a billing entity used to generate invoices.
- [Update a billing entity](https://getlago.com/docs/api-reference/billing-entities/update.md): This endpoint is used to update an existing billing entity
- [The applied coupon object](https://getlago.com/docs/api-reference/coupons/applied-coupon-object.md): This object represents a coupon applied to a customer. It can override the initial values of a coupon.
- [Apply a coupon](https://getlago.com/docs/api-reference/coupons/apply.md): This endpoint is used to apply a specific coupon to a customer, before or during a subscription.
- [The coupon object](https://getlago.com/docs/api-reference/coupons/coupon-object.md): This object represents a coupon used to applies discount on customer next invoices. This coupon can be applied to a customer with overriden values.
- [Create a coupon](https://getlago.com/docs/api-reference/coupons/create.md): This endpoint is used to create a coupon that can be then attached to a customer to create a discount.
- [Delete a coupon](https://getlago.com/docs/api-reference/coupons/destroy.md): This endpoint is used to delete a coupon.
- [Delete an applied coupon](https://getlago.com/docs/api-reference/coupons/destroy-applied-coupon.md): This endpoint is used to delete a specific coupon that has been applied to a customer.
- [List all coupons](https://getlago.com/docs/api-reference/coupons/get-all.md): This endpoint is used to list all existing coupons.
- [List all applied coupons](https://getlago.com/docs/api-reference/coupons/get-all-applied.md): This endpoint is used to list all applied coupons. You can filter by coupon status and by customer.
- [Retrieve a coupon](https://getlago.com/docs/api-reference/coupons/get-specific.md): This endpoint is used to retrieve a specific coupon.
- [Update a coupon](https://getlago.com/docs/api-reference/coupons/update.md): This endpoint is used to update a coupon that can be then attached to a customer to create a discount.
- [Create a credit note](https://getlago.com/docs/api-reference/credit-notes/create.md): This endpoint creates a new credit note.
- [The credit note object](https://getlago.com/docs/api-reference/credit-notes/credit-note-object.md): This object represents a credit note, used to refund or credit back a customer for a fee or an invoice.
- [Download a credit note](https://getlago.com/docs/api-reference/credit-notes/download.md): This endpoint downloads the PDF of an existing credit note.
- [Estimate a credit note](https://getlago.com/docs/api-reference/credit-notes/estimate.md): This endpoint allows you to retrieve amounts for a new credit note creation.
- [List all credit notes](https://getlago.com/docs/api-reference/credit-notes/get-all.md): This endpoint list all existing credit notes.
- [Retrieve a credit note](https://getlago.com/docs/api-reference/credit-notes/get-specific.md): This endpoint retrieves an existing credit note.
- [Update a credit note](https://getlago.com/docs/api-reference/credit-notes/update.md): This endpoint updates an existing credit note.
- [Void available credit](https://getlago.com/docs/api-reference/credit-notes/void.md): This endpoint voids the available credit linked to a specific credit note.
- [The customer usage object](https://getlago.com/docs/api-reference/customer-usage/customer-usage-object.md): This object represents the usage-based charges associated with one of your customers for a defined billing period. It allows you to monitor customer usage throughout the period.
- [Retrieve current usage](https://getlago.com/docs/api-reference/customer-usage/get-current.md): Retrieve real-time customer usage data for the current open billing period.
- [Retrieve past usage](https://getlago.com/docs/api-reference/customer-usage/get-past.md): Fetch historical customer usage data for closed billing periods.
- [Retrieve projected usage](https://getlago.com/docs/api-reference/customer-usage/get-projected.md): Retrieve real-time projected usage data for the current open billing period.
- [Create a customer](https://getlago.com/docs/api-reference/customers/create.md): This endpoint creates a new customer.
- [Retrieve customer portal URL](https://getlago.com/docs/api-reference/customers/customer-portal.md): Retrieves an embeddable link for displaying a customer portal.

This endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal
- [Delete a customer](https://getlago.com/docs/api-reference/customers/delete.md): This endpoint deletes an existing customer.
- [List all customers](https://getlago.com/docs/api-reference/customers/get-all.md): This endpoint retrieves all existing customers.
- [Retrieve a customer](https://getlago.com/docs/api-reference/customers/get-specific.md): This endpoint retrieves an existing customer.
- [The customer object](https://getlago.com/docs/api-reference/customers/object.md): This object represents a customer of your business. It lets you create or update a customer, but also track usage and create invoices for the same customer.
- [Regenerate checkout URL](https://getlago.com/docs/api-reference/customers/psp-checkout-url.md): This endpoint regenerates the Payment Provider Checkout URL of a Customer.
- [Update a customer](https://getlago.com/docs/api-reference/customers/update.md): This endpoint creates a new customer.
- [Create a feature](https://getlago.com/docs/api-reference/entitlements/features/create-feature.md): This endpoint creates a new feature representing an entitlement component of your application.
- [Delete a feature](https://getlago.com/docs/api-reference/entitlements/features/delete-feature.md): This endpoint deletes an existing feature representing an entitlement component of your application. Deleting a feature will remove it from all plans and subscriptions.
- [Delete a feature privilege](https://getlago.com/docs/api-reference/entitlements/features/delete-privilege.md): Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.
- [The feature object](https://getlago.com/docs/api-reference/entitlements/features/feature-object.md): This object represents a feature of your business, that can be entitled to a customer through a plan or a subscription.
- [List all features](https://getlago.com/docs/api-reference/entitlements/features/get-all-features.md): This endpoint retrieves all existing features that represent entitlement components of your application.
- [Retrieve a feature](https://getlago.com/docs/api-reference/entitlements/features/get-feature.md): This endpoint retrieves an existing feature that represents an entitlement component of your application. The feature is identified by its unique code.
- [Update a feature](https://getlago.com/docs/api-reference/entitlements/features/update-feature.md): This endpoint updates an existing feature representing an entitlement component of your application.
- [Create plan entitlements](https://getlago.com/docs/api-reference/entitlements/plan-entitlements/create-plan-entitlement.md): This endpoint creates new entitlements by adding features to a plan. Note that all existing entitlements will be deleted and replaced by the ones provided. To add a new entitlement without removing the existing ones, use PATCH. The feature must exist and all privileges must be valid for the feature.
- [Delete a plan entitlement](https://getlago.com/docs/api-reference/entitlements/plan-entitlements/delete-plan-entitlement.md): This endpoint deletes an existing entitlement by removing the feature from the plan.
- [Delete a plan entitlement privilege](https://getlago.com/docs/api-reference/entitlements/plan-entitlements/delete-plan-entitlement-privilege.md): This endpoint removes a specific privilege and its value from an entitlement. The privilege remains untouched on the original feature.
- [List plan entitlements](https://getlago.com/docs/api-reference/entitlements/plan-entitlements/get-all-plan-entitlements.md): This endpoint retrieves all entitlements for a specific plan.
- [Retrieve a plan entitlement](https://getlago.com/docs/api-reference/entitlements/plan-entitlements/get-specific-plan-entitlement.md): This endpoint retrieves a specific entitlement for a plan.
- [The plan entitlement object](https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object.md): This object represents entitlements belonging to a plan.
- [Update plan entitlements](https://getlago.com/docs/api-reference/entitlements/plan-entitlements/update-plan-entitlement.md): This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
- [Delete a subscription entitlement](https://getlago.com/docs/api-reference/entitlements/subscription-entitlements/delete-subscription-entitlement.md): This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.
- [Delete a subscription entitlement privilege](https://getlago.com/docs/api-reference/entitlements/subscription-entitlements/delete-subscription-entitlement-privilege.md): This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.
- [List subscription entitlements](https://getlago.com/docs/api-reference/entitlements/subscription-entitlements/get-all-subscription-entitlements.md): This endpoint retrieves all entitlements for a specific subscription, including both plan entitlements and any subscription-specific overrides.
- [The subscription entitlement object](https://getlago.com/docs/api-reference/entitlements/subscription-entitlements/subscription-entitlement-object.md): This object represents entitlements belonging to a subscription.
- [Update subscription entitlements](https://getlago.com/docs/api-reference/entitlements/subscription-entitlements/update-subscription-entitlement.md): This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features  and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
- [Errors](https://getlago.com/docs/api-reference/errors.md)
- [Batch usage events](https://getlago.com/docs/api-reference/events/batch.md): This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.
- [Estimate an upcoming fee](https://getlago.com/docs/api-reference/events/estimated-fee.md): Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges.
- [The event object](https://getlago.com/docs/api-reference/events/event-object.md): Events represents usage measurement sent to lago application that will then be aggregated into invoice line items.
- [Retrieve an event](https://getlago.com/docs/api-reference/events/get-specific.md): This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.
- [List all events](https://getlago.com/docs/api-reference/events/list-events.md): This endpoint is used for retrieving all events.
- [Send usage event](https://getlago.com/docs/api-reference/events/usage.md): This endpoint is used for transmitting usage measurement events to either a designated customer or a specific subscription.
- [Delete a fee](https://getlago.com/docs/api-reference/fees/destroy-fee.md): This endpoint is used for deleting a specific fee that has not yet been invoiced
- [The fee object](https://getlago.com/docs/api-reference/fees/fee-object.md): This object represents a line item of an invoice, handling amount, billed units and item description.
- [List all fees](https://getlago.com/docs/api-reference/fees/list-fees.md): This endpoint is used for retrieving all fees that has been issued.