### lago plans get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_get.md Example invocation of the get command with a plan code. ```bash lago plans get ``` -------------------------------- ### lago plans delete-plan-metadata-key examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_delete-plan-metadata-key.md Shows basic usage and an example with the --output flag set to json to get the full resource. ```bash lago plans delete-plan-metadata-key ``` ```bash lago plans delete-plan-metadata-key --output json # full resource ``` -------------------------------- ### Quickstart: Create metric, plan, customer, subscription, send event, preview invoice Source: https://github.com/getlago/lago-cli/blob/main/README.md Walks through the full Lago CLI quickstart: create a billable metric, plan, customer, and subscription, send a usage event, and preview an invoice. The plan payload requires the `billable_metric_id` from the first command's `LAGO_ID` output. Each command prints a terse identifier block by default. ```console $ lago billable-metrics create --name Requests --code quickstart_requests --aggregation-type count_agg LAGO_ID 0b8a1e70-1a90-4b2c-9f3d-5e6a7b8c9d01 CODE quickstart_requests NAME Requests ``` ```console $ lago plans create --input '{"plan":{"name":"Quickstart","code":"quickstart","interval":"monthly","amount_cents":0,"amount_currency":"USD","pay_in_advance":false,"charges":[{"billable_metric_id":"0b8a1e70-1a90-4b2c-9f3d-5e6a7b8c9d01","charge_model":"standard","properties":{"amount":"1"}}]}}' LAGO_ID 2b902b90-2b90-2b90-2b90-2b902b902b90 CODE quickstart NAME Quickstart ``` ```console $ lago customers create --external-id quickstart_customer --name "Quickstart Customer" LAGO_ID 1a901a90-1a90-1a90-1a90-1a901a901a90 EXTERNAL_ID quickstart_customer NAME Quickstart Customer ``` ```console $ lago subscriptions create \ --external-customer-id quickstart_customer \ --external-id quickstart_subscription \ --plan-code quickstart LAGO_ID 3c903c90-3c90-3c90-3c90-3c903c903c90 EXTERNAL_ID quickstart_subscription STATUS active ``` ```console $ lago events send --external-subscription-id quickstart_subscription --code quickstart_requests CODE quickstart_requests LAGO_ID 5e905e90-5e90-5e90-5e90-5e905e905e90 TRANSACTION_ID 0f3c1d2e-4a5b-6c7d-8e9f-0a1b2c3d4e5f ``` ```console $ lago invoices preview --input '{"customer":{"external_id":"quickstart_customer"},"subscriptions":{"external_ids":["quickstart_subscription"]}}' CURRENCY USD FEES 1 item ISSUING_DATE 2026-10-01 TOTAL_AMOUNT_CENTS 100 ``` -------------------------------- ### lago add-ons get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_add-ons_get.md Example invocation of the get command with a placeholder for the add-on code. ```bash lago add-ons get ``` -------------------------------- ### lago features get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_features_get.md Basic usage example for the get command. ```bash lago features get ``` -------------------------------- ### Example: lago plans list Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_list.md Example invocation of the list command. ```bash lago plans list ``` -------------------------------- ### lago wallets get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_get.md Example invocation of the get command with a wallet ID placeholder. ```bash lago wallets get ``` -------------------------------- ### lago entitlements get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_entitlements_get.md Example usage of the get command with placeholder arguments. ```bash lago entitlements get ``` -------------------------------- ### lago coupons get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_coupons_get.md Example invocation of the get command with a coupon code. ```bash lago coupons get ``` -------------------------------- ### lago subscriptions get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_get.md Displays a minimal example of the command without any flags, retrieving the subscription with the specified external ID. ```bash lago subscriptions get ``` -------------------------------- ### lago payment-receipts get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payment-receipts_get.md Example usage of the get command with a placeholder Lago ID. ```bash lago payment-receipts get ``` -------------------------------- ### lago taxes get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_taxes_get.md Example usage of the command to retrieve a tax. ```bash lago taxes get ``` -------------------------------- ### lago plans delete-all-plan-metadata examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_delete-all-plan-metadata.md Two usage examples: the basic command and one with --output json to get the full resource in JSON format. ```bash lago plans delete-all-plan-metadata lago plans delete-all-plan-metadata --output json # full resource ``` -------------------------------- ### lago webhook-endpoints get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_webhook-endpoints_get.md Example invocation of the get command with a Lago ID. ```bash lago webhook-endpoints get ``` -------------------------------- ### lago customers get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_get.md Example invocation of the get command with an external customer ID. ```bash lago customers get ``` -------------------------------- ### Inspect Shell Installer Before Running Source: https://github.com/getlago/lago-cli/blob/main/README.md Downloads the installer script to a file, reviews it with less, then executes it. Recommended before piping to sh. ```console $ curl -fsSL https://getlago.github.io/lago-cli/install.sh -o install-lago.sh $ less install-lago.sh && sh install-lago.sh ``` -------------------------------- ### lago docs examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_docs.md Shows example invocations for opening documentation of the 'customers' and 'billable-metrics' resources. ```bash lago docs customers lago docs billable-metrics ``` -------------------------------- ### lago payment-requests get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payment-requests_get.md Example usage of the get command with a placeholder lago_id. ```bash lago payment-requests get ``` -------------------------------- ### lago wallets get-customer-wallet-alerts example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_get-customer-wallet-alerts.md Example invocation of the command with the required arguments. ```bash lago wallets get-customer-wallet-alerts ``` -------------------------------- ### lago api-logs get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_api-logs_get.md Example usage of the get command with a request_id placeholder. ```bash lago api-logs get ``` -------------------------------- ### lago order-forms get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_order-forms_get.md Example usage of the get command with a Lago ID. ```bash lago order-forms get ``` -------------------------------- ### lago api usage examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_api.md Examples of making GET and POST requests. Use --data with a JSON string, @file to read from a file, or - to read from stdin. The third example pipes JSON from printf into the command. ```bash lago api GET /customers?page=2 lago api POST /events --data @event.json printf '{"event":{}}' | lago api POST /events --data - ``` -------------------------------- ### lago subscriptions list Example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_list.md Example command to list subscriptions. ```bash lago subscriptions list ``` -------------------------------- ### lago credit-notes get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_credit-notes_get.md Example invocation of the get command with a Lago ID placeholder. ```bash lago credit-notes get ``` -------------------------------- ### lago events get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_events_get.md Example invocation of the get command with a transaction_id placeholder. ```bash lago events get ``` -------------------------------- ### lago fees list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_fees_list.md Basic usage example that lists all fees. ```bash lago fees list ``` -------------------------------- ### lago subscriptions charges example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_charges.md Example usage of the command. ```bash lago subscriptions charges ``` -------------------------------- ### lago activity-logs list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_activity-logs_list.md Basic example that lists all activity logs. ```bash lago activity-logs list ``` -------------------------------- ### lago activity-logs get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_activity-logs_get.md Example usage of the get command with an activity_id placeholder. Replace with the actual identifier of the activity log you want to retrieve. ```bash lago activity-logs get ``` -------------------------------- ### lago add-ons delete examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_add-ons_delete.md Two usage examples: a basic delete command and one with --output json to get the full resource. ```bash lago add-ons delete lago add-ons delete --output json # full resource ``` -------------------------------- ### lago plans charges example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_charges.md Basic usage example for the lago plans charges command. ```bash lago plans charges ``` -------------------------------- ### lago customers create usage examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_create.md Two example invocations: one using default output and one requesting JSON output for the full resource. ```bash lago customers create --input @payload.json ``` ```bash lago customers create --input @payload.json --output json # full resource ``` -------------------------------- ### lago wallets list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_list.md Basic usage example for the lago wallets list command. ```bash lago wallets list ``` -------------------------------- ### lago billable-metrics get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_billable-metrics_get.md Example invocation of the get command with a billable metric code. ```bash lago billable-metrics get ``` -------------------------------- ### Example: lago coupons list Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_coupons_list.md Example usage of the `lago coupons list` command. ```bash lago coupons list ``` -------------------------------- ### lago fees get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_fees_get.md Basic usage example for the lago fees get command. Replace with the actual fee identifier. ```bash lago fees get ``` -------------------------------- ### lago api-logs list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_api-logs_list.md Basic usage example that lists all API logs with default options. ```bash lago api-logs list ``` -------------------------------- ### lago payments get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payments_get.md Example invocation of the `lago payments get` command with a placeholder ``. ```bash lago payments get ``` -------------------------------- ### lago webhook-endpoints create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_webhook-endpoints_create.md Two example invocations: one using an input file and another that also outputs the full resource as JSON. ```bash lago webhook-endpoints create --input @payload.json lago webhook-endpoints create --input @payload.json --output json # full resource ``` -------------------------------- ### lago billing-entities get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_billing-entities_get.md Example usage of the get command with a billing entity code placeholder. ```bash lago billing-entities get ``` -------------------------------- ### lago coupons list-applied-coupons Example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_coupons_list-applied-coupons.md Basic usage example that lists all applied coupons. ```bash lago coupons list-applied-coupons ``` -------------------------------- ### lago billable-metrics create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_billable-metrics_create.md Example invocations: one using an input file and another that also requests full JSON output. ```bash lago billable-metrics create --input @payload.json lago billable-metrics create --input @payload.json --output json # full resource ``` -------------------------------- ### lago subscriptions get-subscription-fixed-charge example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_get-subscription-fixed-charge.md Example invocation of the command with the required arguments. ```bash lago subscriptions get-subscription-fixed-charge ``` -------------------------------- ### lago invoices get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_invoices_get.md Example of retrieving an invoice using its Lago ID. ```bash lago invoices get ``` -------------------------------- ### lago orders get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_orders_get.md Basic example of retrieving an order by its Lago ID. ```bash lago orders get ``` -------------------------------- ### lago profile list examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_profile_list.md Example invocations of the list command. The second example uses the --output flag to format the output as JSON. ```bash lago profile list ``` ```bash lago profile list --output json ``` -------------------------------- ### lago wallets get-customer-wallet example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_get-customer-wallet.md Example invocation of the get-customer-wallet command with the required arguments. ```bash lago wallets get-customer-wallet ``` -------------------------------- ### lago init examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_init.md Provides three usage examples: a basic init, one with explicit API key, region, and mode flags, and one using an environment variable for the API key with a self-hosted region and custom API URL. ```bash lago init lago init --api-key lago_test_FAKE000000000000000000000000 --region eu --mode test lago init --api-key "$LAGO_API_KEY" --region self-hosted --api-url https://billing.example.test ``` -------------------------------- ### lago taxes list Example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_taxes_list.md Basic usage example that lists all taxes. ```bash lago taxes list ``` -------------------------------- ### Install Lago CLI via go install Source: https://github.com/getlago/lago-cli/blob/main/README.md Installs the Lago CLI binary using Go's module system. Requires a Go toolchain and works on any platform Go supports. ```console $ go install github.com/getlago/lago-cli/cmd/lago@latest ``` -------------------------------- ### lago credit-notes list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_credit-notes_list.md Basic usage example that lists all existing credit notes. ```bash lago credit-notes list ``` -------------------------------- ### lago plans create examples with input file and JSON output Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_create.md Two example invocations: one reads the request body from a JSON file, the other also requests JSON output for the full resource. ```bash lago plans create --input @payload.json lago plans create --input @payload.json --output json # full resource ``` -------------------------------- ### lago customers export example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_export.md Basic usage example that exports all existing customers. ```bash lago customers export ``` -------------------------------- ### lago subscriptions create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_create.md Example invocations of the create command. The first uses an input file for the JSON request body. The second adds the --output json flag to display the full resource. ```bash lago subscriptions create --input @payload.json ``` ```bash lago subscriptions create --input @payload.json --output json # full resource ``` -------------------------------- ### lago billing-entities list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_billing-entities_list.md Basic usage example that lists all billing entities. ```bash lago billing-entities list ``` -------------------------------- ### Usage examples for update-subscription-alert Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_update-subscription-alert.md Two example invocations: the first uses an input payload file, the second adds the --output json flag to get the full resource in JSON format. ```bash lago subscriptions update-subscription-alert --input @payload.json lago subscriptions update-subscription-alert --input @payload.json --output json # full resource ``` -------------------------------- ### lago plans create-plan-charge examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_create-plan-charge.md Two example invocations: the first uses an input file, the second adds --output json to display the full resource. ```bash lago plans create-plan-charge --input @payload.json ``` ```bash lago plans create-plan-charge --input @payload.json --output json # full resource ``` -------------------------------- ### lago analytics overdue-balance example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_analytics_overdue-balance.md Basic usage example for the command. ```bash lago analytics overdue-balance ``` -------------------------------- ### lago wallets create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_create.md Two example invocations: one using an input file and another that also requests JSON output for the full resource. ```bash lago wallets create --input @payload.json ``` ```bash lago wallets create --input @payload.json --output json # full resource ``` -------------------------------- ### lago init with eu region Source: https://github.com/getlago/lago-cli/blob/main/README.md Initializes the CLI with the EU region in test mode. The profile is saved only after a live GET /api/v1/organizations accepts the key. ```console $ lago init --api-key "$LAGO_API_KEY" --region eu --mode test ``` -------------------------------- ### lago order-forms list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_order-forms_list.md Basic usage example that lists all order forms. ```bash lago order-forms list ``` -------------------------------- ### lago plans create-plan-fixed-charge examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_create-plan-fixed-charge.md Two example invocations: one using an input file and another that also requests JSON output for the full resource. ```bash lago plans create-plan-fixed-charge --input @payload.json ``` ```bash lago plans create-plan-fixed-charge --input @payload.json --output json # full resource ``` -------------------------------- ### lago entitlements create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_entitlements_create.md Provides example invocations. The first uses an input file; the second adds --output json to display the full resource. ```bash lago entitlements create --input @payload.json lago entitlements create --input @payload.json --output json # full resource ``` -------------------------------- ### lago wallets list-wallet-transaction-consumptions example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_list-wallet-transaction-consumptions.md Basic usage example for listing wallet transaction consumptions. ```bash lago wallets list-wallet-transaction-consumptions ``` -------------------------------- ### lago init with us region Source: https://github.com/getlago/lago-cli/blob/main/README.md Initializes the CLI with the US region in test mode. The profile is saved only after a live GET /api/v1/organizations accepts the key. ```console $ lago init --api-key "$LAGO_API_KEY" --region us --mode test Connected to Lago as Example Organization. Saved us profile "default" to ~/.config/lago/config.toml (mode: test). ``` -------------------------------- ### lago plans get-plan-charge example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_get-plan-charge.md Example invocation of the get-plan-charge command with plan code and charge code placeholders. ```bash lago plans get-plan-charge ``` -------------------------------- ### lago payment-methods list-customers-payment-methods example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payment-methods_list-customers-payment-methods.md Example command to list all payment methods for a customer. Replace with the actual customer ID. ```bash lago payment-methods list-customers-payment-methods ``` -------------------------------- ### lago invoices download example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_invoices_download.md Example usage of the download command with a Lago ID placeholder. ```bash lago invoices download ``` -------------------------------- ### lago analytics gross-revenue example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_analytics_gross-revenue.md Basic usage example for the gross-revenue command. ```bash lago analytics gross-revenue ``` -------------------------------- ### lago upgrade examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_upgrade.md Provides example invocations of the `lago upgrade` command, including checking the beta release channel. ```bash lago upgrade lago upgrade --channel beta ``` -------------------------------- ### lago invoices create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_invoices_create.md Two example invocations: one using an input file with default table output, and one using --output json to display the full resource. ```bash lago invoices create --input @payload.json lago invoices create --input @payload.json --output json # full resource ``` -------------------------------- ### lago completion usage examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_completion.md Examples of generating completion scripts for zsh and powershell. The zsh example redirects output to a file, while the powershell example pipes it to Invoke-Expression. ```bash lago completion zsh > ~/.zfunc/_lago ``` ```powershell lago completion powershell | Out-String | Invoke-Expression ``` -------------------------------- ### lago customers applied-coupons example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_applied-coupons.md Example invocation of the applied-coupons command with a customer external ID. ```bash lago customers applied-coupons ``` -------------------------------- ### lago customers invoices example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_invoices.md Example usage of the command to list all invoices for a customer. ```bash lago customers invoices ``` -------------------------------- ### lago init with self-hosted region Source: https://github.com/getlago/lago-cli/blob/main/README.md Initializes the CLI with the self-hosted region and a custom API URL in test mode. The profile is saved only after a live GET /api/v1/organizations accepts the key. ```console $ lago init --api-key "$LAGO_API_KEY" --region self-hosted --api-url https://lago.example.com --mode test ``` -------------------------------- ### lago invoices preview example with input file Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_invoices_preview.md Example invocation that passes a JSON payload file using the --input flag. ```bash lago invoices preview --input @payload.json ``` -------------------------------- ### lago plans import examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_import.md Two example invocations: one with --dry-run to preview changes without sending them, and one with --output json to format the result as JSON. ```bash lago plans import plans.json --dry-run lago plans import plans.json --output json ``` -------------------------------- ### lago billable-metrics list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_billable-metrics_list.md Basic usage example that lists all billable metrics. ```bash lago billable-metrics list ``` -------------------------------- ### lago payments list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payments_list.md Basic usage example for listing all payments. ```bash lago payments list ``` -------------------------------- ### lago credit-notes download example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_credit-notes_download.md Example usage of the download command with a placeholder Lago ID. ```bash lago credit-notes download ``` -------------------------------- ### lago add-ons create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_add-ons_create.md Two usage examples: the first reads the request body from a JSON file; the second also outputs the full resource in JSON format. ```bash lago add-ons create --input @payload.json ``` ```bash lago add-ons create --input @payload.json --output json # full resource ``` -------------------------------- ### lago orders list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_orders_list.md Example usage of the lago orders list command. ```bash lago orders list ``` -------------------------------- ### lago add-ons list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_add-ons_list.md Example invocation of the list command without any flags. This lists all add-ons using default settings. ```bash lago add-ons list ``` -------------------------------- ### lago payment-requests create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payment-requests_create.md Two example invocations: one with a JSON payload file and one that also requests JSON output to display the full resource. ```bash lago payment-requests create --input @payload.json lago payment-requests create --input @payload.json --output json # full resource ``` -------------------------------- ### lago wallets create-customer-wallet Examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_create-customer-wallet.md Two example invocations: the first uses an input payload file, the second adds the --output json flag to display the full resource. Both use the @payload.json input file. ```bash lago wallets create-customer-wallet --input @payload.json lago wallets create-customer-wallet --input @payload.json --output json # full resource ``` -------------------------------- ### lago subscriptions get-subscription-alert Example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_get-subscription-alert.md Example usage of the get-subscription-alert command with the required arguments. ```bash lago subscriptions get-subscription-alert ``` -------------------------------- ### lago webhooks public-key example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_webhooks_public-key.md Example invocation of the public-key command without any flags. ```bash lago webhooks public-key ``` -------------------------------- ### lago events estimate-fees example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_events_estimate-fees.md Example invocation using an input file. ```bash lago events estimate-fees --input @payload.json ``` -------------------------------- ### lago plans fixed-charges example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_fixed-charges.md Basic usage example for the command. Replace with the plan code. ```bash lago plans fixed-charges ``` -------------------------------- ### lago features create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_features_create.md Example invocations of the create command. The first uses an input file; the second adds --output json to display the full resource. ```bash lago features create --input @payload.json lago features create --input @payload.json --output json # full resource ``` -------------------------------- ### lago payment-requests list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payment-requests_list.md Basic usage example for listing all payment requests. ```bash lago payment-requests list ``` -------------------------------- ### lago coupons apply examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_coupons_apply.md Example invocations of the apply command. The first uses an input file, the second adds JSON output to show the full resource. ```bash lago coupons apply --input @payload.json lago coupons apply --input @payload.json --output json # full resource ``` -------------------------------- ### lago entitlements list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_entitlements_list.md Basic usage example for the lago entitlements list command. ```bash lago entitlements list ``` -------------------------------- ### lago quotes get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_quotes_get.md Example of retrieving a quote by its Lago ID. ```bash lago quotes get ``` -------------------------------- ### lago subscriptions lifetime-usage example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_lifetime-usage.md Basic example of the command with a placeholder external ID. ```bash lago subscriptions lifetime-usage ``` -------------------------------- ### lago payment-receipts list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payment-receipts_list.md Basic usage example that lists all payment receipts. ```bash lago payment-receipts list ``` -------------------------------- ### lago wallets delete-all-wallet-metadata usage examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_delete-all-wallet-metadata.md Two usage examples: the basic command and one with the --output json flag to display the full resource. ```bash lago wallets delete-all-wallet-metadata ``` ```bash lago wallets delete-all-wallet-metadata --output json # full resource ``` -------------------------------- ### lago wallets list-customer-wallets example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_list-customer-wallets.md Example invocation of the list-customer-wallets command with an external customer ID. ```bash lago wallets list-customer-wallets ``` -------------------------------- ### lago webhook-endpoints list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_webhook-endpoints_list.md Example usage of the command to list all webhook endpoints. ```bash lago webhook-endpoints list ``` -------------------------------- ### lago customers payment-requests example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_payment-requests.md Example usage of the command with an external customer ID. ```bash lago customers payment-requests ``` -------------------------------- ### lago seed demo examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_seed_demo.md Runs the demo with default settings or with a custom prefix and JSON output. ```bash lago seed demo lago seed demo --prefix local-demo --output json ``` -------------------------------- ### lago customers credit-notes example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_credit-notes.md Example invocation of the command with a customer ID placeholder. ```bash lago customers credit-notes ``` -------------------------------- ### lago customers portal-url example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_portal-url.md Example invocation of the portal-url command with an external customer ID. ```bash lago customers portal-url ``` -------------------------------- ### lago organizations get example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_organizations_get.md Runs the command to retrieve your organization's settings. ```bash lago organizations get ``` -------------------------------- ### Example usage of lago wallets get-customer-wallet-alert Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_get-customer-wallet-alert.md Example invocation of the command to retrieve a wallet alert. ```bash lago wallets get-customer-wallet-alert ``` -------------------------------- ### lago quotes versions example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_quotes_versions.md Basic usage example for listing versions of a quote. ```bash lago quotes versions ``` -------------------------------- ### Delete subscription alert examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_delete-subscription-alert.md Shows basic usage and an example with --output json to get the full resource. ```bash lago subscriptions delete-subscription-alert ``` ```bash lago subscriptions delete-subscription-alert --output json # full resource ``` -------------------------------- ### lago init usage syntax Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_init.md Shows the command-line syntax for the `lago init` command, which configures a Lago profile and validates its credentials. ```bash lago init [flags] ``` -------------------------------- ### lago plans update-plan-charge examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_update-plan-charge.md Two example invocations. The first uses an input payload file; the second adds --output json to display the full resource. ```bash lago plans update-plan-charge --input @payload.json ``` ```bash lago plans update-plan-charge --input @payload.json --output json # full resource ``` -------------------------------- ### Usage examples for destroy-subscription-entitlement Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_entitlements_destroy-subscription-entitlement.md Two example invocations: the basic command and one with the --output json flag to get the full resource. ```bash lago entitlements destroy-subscription-entitlement lago entitlements destroy-subscription-entitlement --output json # full resource ``` -------------------------------- ### Delete applied coupon examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_coupons_delete-applied-coupon.md Two usage examples: the basic command and one with --output json to get the full resource. ```bash lago coupons delete-applied-coupon ``` ```bash lago coupons delete-applied-coupon --output json # full resource ``` -------------------------------- ### lago webhooks json-public-key Example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_webhooks_json-public-key.md Example invocation of the command to retrieve the webhook public key. ```bash lago webhooks json-public-key ``` -------------------------------- ### lago invoices retry examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_invoices_retry.md Basic usage and an example with the --output json flag to get the full resource output. ```bash lago invoices retry lago invoices retry --output json # full resource ``` -------------------------------- ### Example invocations with input file and JSON output Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_create-subscription-charge-filter.md Two example invocations: the first reads the request body from a JSON file, the second also requests JSON output and includes a comment noting it returns the full resource. ```bash lago subscriptions create-subscription-charge-filter --input @payload.json ``` ```bash lago subscriptions create-subscription-charge-filter --input @payload.json --output json # full resource ``` -------------------------------- ### lago subscriptions update-subscription-lifetime-usage examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_update-subscription-lifetime-usage.md Provides example invocations. The first uses an input file; the second adds --output json to display the full resource. ```bash lago subscriptions update-subscription-lifetime-usage --input @payload.json ``` ```bash lago subscriptions update-subscription-lifetime-usage --input @payload.json --output json # full resource ``` -------------------------------- ### Example: lago wallets list-wallet-transaction-fundings Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_list-wallet-transaction-fundings.md Example command to list wallet transaction fundings. Replace with the actual wallet transaction ID. ```bash lago wallets list-wallet-transaction-fundings ``` -------------------------------- ### lago plans metadata examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_metadata.md Example invocations of the metadata command. The first uses an input file; the second adds --output json to display the full resource. ```bash lago plans metadata --input @payload.json lago plans metadata --input @payload.json --output json # full resource ``` -------------------------------- ### lago customers past-usage example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_past-usage.md Basic usage example for retrieving past usage for a customer. ```bash lago customers past-usage ``` -------------------------------- ### lago version examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_version.md Examples of using the `lago version` command: basic version display and checking for a newer release with `--check`. ```bash lago version lago version --check ``` -------------------------------- ### lago subscriptions alerts example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_alerts.md Example invocation of the command to list alerts for a subscription. ```bash lago subscriptions alerts ``` -------------------------------- ### lago fees delete examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_fees_delete.md Two usage examples: a basic delete and one with --output json to get the full resource in JSON format. ```bash lago fees delete lago fees delete --output json # full resource ``` -------------------------------- ### lago credit-notes create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_credit-notes_create.md Example invocations of the create command. The first uses an input file; the second adds --output json to display the full resource. ```bash lago credit-notes create --input @payload.json lago credit-notes create --input @payload.json --output json # full resource ``` -------------------------------- ### lago wallets update-customer-wallet examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_update-customer-wallet.md Two example invocations: the first uses a JSON payload file, the second adds --output json to display the full resource. ```bash lago wallets update-customer-wallet --input @payload.json ``` ```bash lago wallets update-customer-wallet --input @payload.json --output json # full resource ``` -------------------------------- ### lago events list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_events_list.md Basic usage example that lists all events without any flags. ```bash lago events list ``` -------------------------------- ### Examples of void-quote-version command Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_quotes_void-quote-version.md Shows basic usage and usage with --output json to get the full resource. ```bash lago quotes void-quote-version ``` ```bash lago quotes void-quote-version --output json # full resource ``` -------------------------------- ### lago plans get-plan-fixed-charge example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_get-plan-fixed-charge.md Example usage of the command to retrieve a fixed charge for a plan. ```bash lago plans get-plan-fixed-charge ``` -------------------------------- ### lago logs tail examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_logs_tail.md Provides example invocations of the `lago logs tail` command. The first example runs without filters; the second filters logs by status class `4xx`, resource path `/customers`, and HTTP method `POST`. ```bash lago logs tail lago logs tail --status 4xx --resource /customers --method POST ``` -------------------------------- ### Check for Lago CLI Updates Source: https://github.com/getlago/lago-cli/blob/main/README.md Checks for a newer release and prints the appropriate upgrade command. The output shows an example when version 1.1.0 is available. ```console $ lago upgrade Lago CLI 1.1.0 is available (installed: 1.0.0). brew upgrade getlago/tap/lago ``` -------------------------------- ### lago invoices void examples with --input and --output Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_invoices_void.md Shows two example invocations: one using --input @payload.json, and another that also uses --output json to get the full resource. The --input flag accepts a complete JSON request body or @file.json. ```bash lago invoices void --input @payload.json ``` ```bash lago invoices void --input @payload.json --output json # full resource ``` -------------------------------- ### lago wallets create command synopsis Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_create.md Shows the basic command syntax for creating a wallet. Use this as the starting point for the create command. ```bash lago wallets create [flags] ``` -------------------------------- ### lago payments create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_payments_create.md Example invocations: one using a JSON payload file and another that also sets the output format to JSON to display the full resource. ```bash lago payments create --input @payload.json lago payments create --input @payload.json --output json # full resource ``` -------------------------------- ### lago coupons create examples with input and output flags Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_coupons_create.md Two example invocations: the first uses an input file (payload.json) with default output, the second adds --output json to display the full resource. The --input flag accepts a complete JSON request body or @file.json. ```bash lago coupons create --input @payload.json ``` ```bash lago coupons create --input @payload.json --output json # full resource ``` -------------------------------- ### Install Lago CLI via Shell Installer Source: https://github.com/getlago/lago-cli/blob/main/README.md Downloads and runs the official shell installer for macOS and Linux. Verifies SHA-256 checksum and cosign signature if available, then installs to /usr/local/bin. ```console $ curl -fsSL https://getlago.github.io/lago-cli/install.sh | sh ``` -------------------------------- ### Examples for update-customer-wallet-alert Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_update-customer-wallet-alert.md Two example invocations: the first uses an input payload file, the second adds --output json to display the full resource. ```bash lago wallets update-customer-wallet-alert --input @payload.json lago wallets update-customer-wallet-alert --input @payload.json --output json # full resource ``` -------------------------------- ### Examples: create wallet alert with input file and output format Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_create-customer-wallet-alert.md Two example invocations. The first sends a JSON payload from a file. The second adds `--output json` to display the full resource in JSON format. ```bash lago wallets create-customer-wallet-alert --input @payload.json lago wallets create-customer-wallet-alert --input @payload.json --output json # full resource ``` -------------------------------- ### lago plans filters example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_filters.md Example invocation of the filters command with the required plan code and charge code arguments. ```bash lago plans filters ``` -------------------------------- ### lago wallets update examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_update.md Two example invocations: one using a JSON payload file and another that also outputs the full resource as JSON. ```bash lago wallets update --input @payload.json ``` ```bash lago wallets update --input @payload.json --output json # full resource ``` -------------------------------- ### lago billing-entities get options Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_billing-entities_get.md Lists the options specific to the get command, including --watch and --watch-interval for polling. ```bash -h, --help help for get --watch Poll and re-render when the response changes --watch-interval duration Polling interval used with --watch (default 2s) ``` -------------------------------- ### lago subscriptions update examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_update.md Provides example invocations. The first uses an input file; the second adds --output json to display the full resource. ```bash lago subscriptions update --input @payload.json lago subscriptions update --input @payload.json --output json # full resource ``` -------------------------------- ### lago api-logs get options Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_api-logs_get.md Options specific to the get command, including --watch and --watch-interval for polling. ```bash -h, --help help for get --watch Poll and re-render when the response changes --watch-interval duration Polling interval used with --watch (default 2s) ``` -------------------------------- ### Install Lago CLI via Homebrew Source: https://github.com/getlago/lago-cli/blob/main/README.md Installs the Lago CLI binary, man page, and shell completions on macOS and Linux. Requires Homebrew. ```console $ brew install getlago/tap/lago ``` -------------------------------- ### lago customers list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_customers_list.md Lists all existing customers using the default options. ```bash lago customers list ``` -------------------------------- ### lago plans get command usage Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_get.md Shows the command syntax for retrieving a specific plan. The placeholder must be replaced with the plan identifier. ```bash lago plans get [flags] ``` -------------------------------- ### Install Lago CLI with Custom Directory and Version Source: https://github.com/getlago/lago-cli/blob/main/README.md Uses environment variables LAGO_INSTALL_DIR and LAGO_INSTALL_VERSION to customize the installation location and pin a specific release version. ```console $ curl -fsSL https://getlago.github.io/lago-cli/install.sh | LAGO_INSTALL_DIR=$HOME/.local/bin LAGO_INSTALL_VERSION=1.0.0 sh ``` -------------------------------- ### lago wallets get-wallet-transaction example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_wallets_get-wallet-transaction.md Example invocation of the get-wallet-transaction command. ```bash lago wallets get-wallet-transaction ``` -------------------------------- ### Examples for update-subscription-entitlements Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_entitlements_update-subscription-entitlements.md Two example invocations: one using a JSON payload file and another that also requests full resource output in JSON format. ```bash lago entitlements update-subscription-entitlements --input @payload.json ``` ```bash lago entitlements update-subscription-entitlements --input @payload.json --output json # full resource ``` -------------------------------- ### lago subscriptions create-subscription-alert examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_subscriptions_create-subscription-alert.md Two example invocations: the first sends a JSON payload from a file; the second also requests JSON output to display the full resource. ```bash lago subscriptions create-subscription-alert --input @payload.json ``` ```bash lago subscriptions create-subscription-alert --input @payload.json --output json # full resource ``` -------------------------------- ### lago seed demo usage Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_seed_demo.md Shows the command syntax for creating a metric, plan, customer, subscription, event, and invoice preview. ```bash lago seed demo [flags] ``` -------------------------------- ### lago quotes get command synopsis Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_quotes_get.md Shows the usage syntax for the `lago quotes get` command. The command retrieves a specific quote along with its owners and current version. This is a premium feature. ```bash lago quotes get [flags] ``` -------------------------------- ### lago plans merge-plan-metadata examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_merge-plan-metadata.md Two example invocations: the first uses an input file (payload.json) and the default table output; the second adds --output json to display the full resource. The --input flag accepts a complete JSON request body or @file.json. ```bash lago plans merge-plan-metadata --input @payload.json ``` ```bash lago plans merge-plan-metadata --input @payload.json --output json # full resource ``` -------------------------------- ### lago plans update examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_plans_update.md Two example invocations: the first uses an input payload file, the second adds --output json to display the full resource. ```bash lago plans update --input @payload.json ``` ```bash lago plans update --input @payload.json --output json # full resource ``` -------------------------------- ### Interactive lago init Source: https://github.com/getlago/lago-cli/blob/main/README.md Runs lago init with no flags, prompting for profile name, release check, API key, and region. The API key is hidden and the profile is saved only after validation. ```console $ lago init Profile name [default]: staging Allow an anonymous release check at most once per day? (y/N) [N]: n API key (hidden): Region (us/eu/self-hosted) [us]: eu Connected to Lago as Example Organization. Saved eu profile "staging" to ~/.config/lago/config.toml (mode: live). ``` -------------------------------- ### lago billing-entities create examples Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_billing-entities_create.md Example invocations of the create command. The first uses an input payload file; the second adds the --output json flag to display the full resource. ```bash lago billing-entities create --input @payload.json lago billing-entities create --input @payload.json --output json # full resource ``` -------------------------------- ### Create customer with JSON output Source: https://github.com/getlago/lago-cli/blob/main/README.md Shows the full resource returned by `--output json` for a customer create. This is the structured form to script against, as opposed to the default terse identifier block. ```console $ lago customers create --external-id quickstart_customer --name "Quickstart Customer" --output json { "customer": { "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90", "external_id": "quickstart_customer", "name": "Quickstart Customer", "currency": "USD", "created_at": "2026-09-01T10:00:00Z" } } ``` -------------------------------- ### lago events get options Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_events_get.md Options specific to the get command: --watch polls and re-renders when the response changes, and --watch-interval sets the polling interval used with --watch (default 2s). ```bash -h, --help help for get --watch Poll and re-render when the response changes --watch-interval duration Polling interval used with --watch (default 2s) ``` -------------------------------- ### lago add-ons get options Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_add-ons_get.md Options specific to the get command. --watch enables polling and re-rendering when the response changes; --watch-interval sets the polling interval used with --watch (default 2s). ```bash -h, --help help for get --watch Poll and re-render when the response changes --watch-interval duration Polling interval used with --watch (default 2s) ``` -------------------------------- ### lago alias list example Source: https://github.com/getlago/lago-cli/blob/main/docs/reference/lago_alias_list.md Example invocation of the 'lago alias list' command. ```bash lago alias list ```