mint.json

{
  "name": "Lago",
  "openapi": "https://swagger.getlago.com/openapi.yaml",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  },
  "api": {
    "baseUrl": "https://api.getlago.com/api/v1"
  },
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#006CFA",
    "light": "#006CFA",
    "dark": "#006CFA",
    "anchors": { "from": "#006CFA", "to": "#4C9AFF" }
  },
  "topbarCtaButton": {
    "name": "Get Started",
    "url": "https://www.getlago.com/get-started"
  },
  "topbarLinks": [
    {
      "name": "Book a Demo",
      "url": "https://docs.google.com/forms/d/e/1FAIpQLSfKwXdwe3jIpPJuPs2Nmkw_3GqoUOEP1YxQ3B6frYfGgYJ11g/viewform"
    }
  ],
  "primaryTab": {
    "name": "Documentation"
  },
  "tabs": [
    {
      "name": "API References",
      "icon": "square-terminal",
      "url": "api-reference"
    },
    {
      "name": "Integrations",
      "icon": "link",
      "url": "integrations"
    },
    {
      "name": "Templates",
      "url": "templates"
    },
    {
      "name": "FAQ",
      "icon": "question",
      "url": "faq"
    }
  ],
  "anchors": [
    {
      "name": "Blog",
      "icon": "newspaper",
      "url": "https://www.getlago.com/blog"
    },
    {
      "name": "Changelog",
      "icon": "bolt",
      "url": "https://www.getlago.com/changelog"
    },
    {
      "name": "Community",
      "icon": "slack",
      "url": "https://www.getlago.com/slack"
    },
    {
      "name": "GitHub",
      "icon": "github",
      "url": "https://github.com/getlago/lago"
    },
    {
      "name": "Status",
      "icon": "signal-bars",
      "url": "https://status.getlago.com/"
    }
  ],
  "navigation": [
    {
      "group": "Introduction",
      "pages": [
        "guide/introduction/welcome-to-lago",
        "guide/introduction/why-billing-is-a-nightmare"
      ]
    },
    {
      "group": "Guides",
      "pages": [
        {
          "group": "Lago Self-hosted",
          "pages": [
            "guide/self-hosted/overview",
            "guide/self-hosted/docker",
            "guide/self-hosted/tracking-analytics",
            "guide/self-hosted/update-instance",
            "guide/self-hosted/commands"
          ]
        },
        "guide/lago-cloud",
        {
          "group": "Billable metrics",
          "pages": [
            "guide/billable-metrics/create-billable-metrics",
            {
              "group": "Aggregation types",
              "pages": [
                "guide/billable-metrics/aggregation-types/overview",
                "guide/billable-metrics/aggregation-types/count",
                "guide/billable-metrics/aggregation-types/count-unique",
                "guide/billable-metrics/aggregation-types/latest",
                "guide/billable-metrics/aggregation-types/max",
                "guide/billable-metrics/aggregation-types/sum",
                "guide/billable-metrics/aggregation-types/weighted-sum",
                "guide/billable-metrics/aggregation-types/custom-agg",
                "guide/billable-metrics/aggregation-types/aggregation-examples"
              ]
            },
            "guide/billable-metrics/recurring-vs-metered",
            "guide/billable-metrics/filters",
            "guide/billable-metrics/delete-billable-metrics"
          ]
        },
        {
          "group": "Plans",
          "pages": [
            "guide/plans/overview",
            "guide/plans/plan-model",
            {
              "group": "Charges",
              "pages": [
                "guide/plans/charges/overview",
                {
                  "group": "Charge models",
                  "pages": [
                    "guide/plans/charges/charge-models/standard",
                    "guide/plans/charges/charge-models/graduated",
                    "guide/plans/charges/charge-models/package",
                    "guide/plans/charges/charge-models/percentage",
                    "guide/plans/charges/charge-models/volume",
                    "guide/plans/charges/charge-models/graduated-percentage",
                    "guide/plans/charges/charge-models/dynamic",
                    "guide/plans/charges/charge-models/custom-price"
                  ]
                },
                "guide/plans/charges/metered-vs-recurring",
                "guide/plans/charges/arrears-vs-advance",
                "guide/plans/charges/prorated-vs-full",
                "guide/plans/charges/spending-minimum",
                "guide/plans/charges/invoiceable-vs-noninvoiceable",
                "guide/plans/charges/charges-with-filters"
              ]
            },
            "guide/plans/commitment",
            "guide/plans/progressive-billing"
          ]
        },
        {
          "group": "Customers",
          "pages": [
            "guide/customers/customer-management",
            "guide/customers/customer-metadata",
            "guide/customers/invoice-customer",
            "guide/customers/customer-portal"
          ]
        },
        "guide/coupons",
        {
          "group": "Subscriptions",
          "pages": [
            "guide/subscriptions/assign-plan",
            "guide/subscriptions/upgrades-downgrades",
            "guide/subscriptions/edit-subscription",
            "guide/subscriptions/terminate-subscription"
          ]
        },
        {
          "group": "One-off invoices",
          "pages": [
            "guide/one-off-invoices/create-add-ons",
            "guide/one-off-invoices/create-one-off-invoices"
          ]
        },
        {
          "group": "Events and usage",
          "pages": [
            "guide/events/ingesting-usage",
            "guide/events/events-list",
            "guide/events/retrieve-usage",
            "guide/events/metering-source"
          ]
        },
        {
          "group": "Invoicing",
          "pages": [
            "guide/invoicing/overview",
            "guide/invoicing/fees",
            "guide/invoicing/taxes",
            "guide/invoicing/grace-period",
            "guide/invoicing/net-payment-term",
            "guide/invoicing/download-invoices",
            "guide/invoicing/invoice-metadata",
            "guide/invoicing/void",
            "guide/invoicing/export"
          ]
        },
        {
          "group": "Payments",
          "pages": [
            "guide/payments/overview",
            "guide/payments/gocardless-integration",
            "guide/payments/stripe-integration",
            "guide/payments/adyen-integration",
            "guide/payments/payment-retries"
          ]
        },
        {
          "group": "Dunning",
          "pages": [
            "guide/dunning/manual-dunning",
            "guide/dunning/automatic-dunning"
          ]
        },
        "guide/credit-notes",
        {
          "group": "Wallets and prepaid credits",
          "pages": [
            "guide/wallet-and-prepaid-credits/overview",
            "guide/wallet-and-prepaid-credits/wallet-top-up-and-void"
          ]
        },
        "guide/webhooks",
        "guide/emails",
        {
          "group": "Analytics",
          "pages": [
            "guide/analytics/overview",
            "guide/analytics/invoice-overdue",
            "guide/analytics/gross-revenue",
            "guide/analytics/mrr",
            "guide/analytics/invoice-collection"
          ]
        },
        {
          "group": "Security",
          "pages": [
            "guide/security/rbac",
            "guide/security/sso",
            "guide/security/soc"
          ]
        },
        "guide/entitlements",
        "guide/integration-testing",
        "guide/lago-open-api"
      ]
    },
    {
      "group": "Migration",
      "pages": ["guide/migration/migration-to-v1.2.0"]
    },
    {
      "group": "API Reference",
      "pages": [
        "api-reference/intro",
        {
          "group": "Add-ons",
          "pages": [
            "api-reference/add-ons/add-on-object",
            "api-reference/add-ons/create",
            "api-reference/add-ons/update",
            "api-reference/add-ons/destroy",
            "api-reference/add-ons/get-specific",
            "api-reference/add-ons/get-all"
          ]
        },
        {
          "group": "Analytics",
          "pages": [
            "api-reference/analytics/gross-revenue",
            "api-reference/analytics/mrr",
            "api-reference/analytics/invoiced-usage",
            "api-reference/analytics/invoice-collection",
            "api-reference/analytics/overdue-balance"
          ]
        },
        {
          "group": "Billable metrics",
          "pages": [
            "api-reference/billable-metrics/object",
            "api-reference/billable-metrics/create",
            "api-reference/billable-metrics/update",
            "api-reference/billable-metrics/destroy",
            "api-reference/billable-metrics/get-specific",
            "api-reference/billable-metrics/get-all",
            "api-reference/billable-metrics/get-all-groups"
          ]
        },
        {
          "group": "Coupons",
          "pages": [
            "api-reference/coupons/coupon-object",
            "api-reference/coupons/create",
            "api-reference/coupons/update",
            "api-reference/coupons/destroy",
            "api-reference/coupons/get-specific",
            "api-reference/coupons/get-all",
            "api-reference/coupons/applied-coupon-object",
            "api-reference/coupons/apply",
            "api-reference/coupons/destroy-applied-coupon",
            "api-reference/coupons/get-all-applied"
          ]
        },
        {
          "group": "Credit notes",
          "pages": [
            "api-reference/credit-notes/credit-note-object",
            "api-reference/credit-notes/create",
            "api-reference/credit-notes/download",
            "api-reference/credit-notes/update",
            "api-reference/credit-notes/void",
            "api-reference/credit-notes/get-specific",
            "api-reference/credit-notes/get-all"
          ]
        },
        {
          "group": "Customer usage",
          "pages": [
            "api-reference/customer-usage/customer-usage-object",
            "api-reference/customer-usage/get-current",
            "api-reference/customer-usage/get-past"
          ]
        },
        {
          "group": "Customers",
          "pages": [
            "api-reference/customers/object",
            "api-reference/customers/create",
            "api-reference/customers/update",
            "api-reference/customers/psp-checkout-url",
            "api-reference/customers/delete",
            "api-reference/customers/get-specific",
            "api-reference/customers/get-all",
            "api-reference/customers/customer-portal"
          ]
        },
        {
          "group": "Events",
          "pages": [
            "api-reference/events/event-object",
            "api-reference/events/usage",
            "api-reference/events/batch",
            "api-reference/events/estimated-fee",
            "api-reference/events/get-specific",
            "api-reference/events/list-events"
          ]
        },
        {
          "group": "Fees",
          "pages": [
            "api-reference/fees/fee-object",
            "api-reference/fees/update-fee",
            "api-reference/fees/destroy-fee",
            "api-reference/fees/retrieve-fee",
            "api-reference/fees/list-fees"
          ]
        },
        {
          "group": "Invoices",
          "pages": [
            "api-reference/invoices/invoice-object",
            "api-reference/invoices/create-oneoff",
            "api-reference/invoices/download",
            "api-reference/invoices/void",
            "api-reference/invoices/retry_finalization",
            "api-reference/invoices/retry",
            "api-reference/invoices/payment-url",
            "api-reference/invoices/refresh",
            "api-reference/invoices/finalize",
            "api-reference/invoices/update",
            "api-reference/invoices/get-specific",
            "api-reference/invoices/get-all"
          ]
        },
        {
          "group": "Organizations",
          "pages": [
            "api-reference/organizations/organization-object",
            "api-reference/organizations/update"
          ]
        },
        {
          "group": "Payment requests",
          "pages": [
            "api-reference/payment-requests/payment-request-object",
            "api-reference/payment-requests/create",
            "api-reference/payment-requests/get-all"
          ]
        },
        {
          "group": "Plans",
          "pages": [
            "api-reference/plans/object",
            "api-reference/plans/create",
            "api-reference/plans/update",
            "api-reference/plans/destroy",
            "api-reference/plans/get-specific",
            "api-reference/plans/get-all-plans"
          ]
        },
        {
          "group": "Resources",
          "pages": [
            "api-reference/resources/currencies",
            "api-reference/resources/timezones",
            "api-reference/resources/locales"
          ]
        },
        {
          "group": "Subscriptions",
          "pages": [
            "api-reference/subscriptions/subscription-object",
            "api-reference/subscriptions/assign-plan",
            "api-reference/subscriptions/update",
            "api-reference/subscriptions/terminate",
            "api-reference/subscriptions/get-specific",
            "api-reference/subscriptions/get-all",
            "api-reference/subscriptions/lifetime-usage-object",
            "api-reference/subscriptions/get-lifetime-usage",
            "api-reference/subscriptions/update-lifetime-usage"
          ]
        },
        {
          "group": "Taxes",
          "pages": [
            "api-reference/taxes/tax-object",
            "api-reference/taxes/create",
            "api-reference/taxes/update",
            "api-reference/taxes/destroy",
            "api-reference/taxes/get-specific",
            "api-reference/taxes/get-all"
          ]
        },
        {
          "group": "Wallets",
          "pages": [
            "api-reference/wallets/wallet-object",
            "api-reference/wallets/create",
            "api-reference/wallets/update",
            "api-reference/wallets/terminate",
            "api-reference/wallets/get-specific",
            "api-reference/wallets/get-all",
            "api-reference/wallets/wallet-transaction-object",
            "api-reference/wallets/top-up",
            "api-reference/wallets/get-all-transactions"
          ]
        },
        {
          "group": "Webhook endpoints",
          "pages": [
            "api-reference/webhook-endpoints/webhook-endpoint-object",
            "api-reference/webhook-endpoints/create",
            "api-reference/webhook-endpoints/update",
            "api-reference/webhook-endpoints/destroy",
            "api-reference/webhook-endpoints/get-all",
            "api-reference/webhook-endpoints/get-specific"
          ]
        },
        {
          "group": "Webhooks",
          "pages": [
            "api-reference/webhooks/format---signature",
            "api-reference/webhooks/messages"
          ]
        }
      ]
    },
    {
      "group": "Integrations",
      "pages": ["integrations/introduction"]
    },
    {
      "group": "Usage tracking integrations",
      "pages": ["integrations/usage/segment", "integrations/usage/hightouch"]
    },
    {
      "group": "Payment integrations",
      "pages": [
        "integrations/payments/stripe-integration",
        "integrations/payments/gocardless-integration",
        "integrations/payments/adyen-integration"
      ]
    },
    {
      "group": "Accounting",
      "pages": [
        "integrations/accounting/netsuite",
        "integrations/accounting/xero"
      ]
    },
    {
      "group": "Taxes",
      "pages": ["integrations/taxes/lago-eu-taxes", "integrations/taxes/anrok"]
    },
    {
      "group": "CRM",
      "pages": [
        "integrations/crm/salesforce-crm",
        "integrations/crm/salesforce-cpq"
      ]
    },
    {
      "group": "Marketplaces",
      "pages": [
        "integrations/marketplaces/aws-marketplace",
        "integrations/marketplaces/azure-marketplace",
        "integrations/marketplaces/gcp-marketplace"
      ]
    },
    {
      "group": "Alerting integrations",
      "pages": ["integrations/alerting/zapier", "integrations/alerting/n8n"]
    },
    {
      "group": "Data integrations",
      "pages": ["integrations/data/airbyte"]
    },
    {
      "group": "Entitlements integrations",
      "pages": ["integrations/entitlements/osohq"]
    },
    {
      "group": "FAQ",
      "pages": [
        "faq/about-lago",
        "faq/about-software",
        "faq/community",
        "faq/deployment",
        "faq/general",
        "faq/pricing",
        "faq/product-features"
      ]
    },
    {
      "group": "Templates",
      "pages": ["templates/introduction"]
    },
    {
      "group": "Per-token pricing",
      "pages": ["templates/per-token/mistral", "templates/per-token/openai"]
    },
    {
      "group": "Hybrid pricing",
      "pages": ["templates/hybrid/segment"]
    },
    {
      "group": "Per-transaction pricing",
      "pages": ["templates/per-transaction/stripe"]
    },
    {
      "group": "Pay-as-you-go pricing",
      "pages": ["templates/payg/algolia", "templates/payg/bigquery"]
    },
    {
      "group": "Per-seat pricing",
      "pages": ["templates/per-seat/notion"]
    }
  ],
  "footerSocials": {
    "twitter": "https://twitter.com/GetLago",
    "slack": "https://getlago.com/slack",
    "github": "https://github.com/getlago/lago"
  },
  "redirects": [
    {
      "source": "https://docs.getlago.com/api-reference",
      "destination": "https://docs.getlago.com/api-reference/intro"
    },
    {
      "source": "https://docs.getlago.com/guide/customers/customer-balance-payment",
      "destination": "https://docs.getlago.com/guide/dunning/manual-dunning"
    },
    {
      "source": "https://getlago.com/docs/guide/customers/customer-balance-payment",
      "destination": "https://getlago.com/docs/guide/dunning/manual-dunning"
    }
  ],
  "feedback": {
    "thumbsRating": true,
    "suggestEdit": true,
    "raiseIssue": true
  },
  "analytics": {
    "clearbit": {
      "publicApiKey": "pk_7881c14f6d3a40bd55db8691a0640544"
    },
    "ga4": {
      "measurementId": "G-743BQ9THCG"
    },
    "koala": {
      "publicApiKey": "pk_963cd5673bdab99d6452d82210e66c3ed5b2"
    }
  }
}