# Lago API documentation API

> Lago API documentation API on Apizie: 216 endpoints (List all billing entities, Create a billing entity, Retrieve a billing entity, Update a billing entity, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:lago/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:lago`
- Category: Payments
- Status: byok
- Source: https://lago
- Page: https://apizie.tech/api/payments/lago
- OpenAPI: https://apizie.tech/api/payments/lago/openapi.json

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

## Endpoints

### List all billing entities
`GET https://apizie.tech/v1/payments:lago/list-billing-entities` (byok)

### Create a billing entity
`POST https://apizie.tech/v1/payments:lago/create-billing-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a billing entity
`GET https://apizie.tech/v1/payments:lago/get-billing-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | The unique code of the billing entity |

### Update a billing entity
`POST https://apizie.tech/v1/payments:lago/update-billing-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | The unique code of the billing entity |
| body | object | yes | JSON request body |

### List all activity logs
`GET https://apizie.tech/v1/payments:lago/find-all-activity-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| from_date | string | no | Filter activity logs logged at or after this date. A date or a full ISO 8601 datetime is accepted. |
| to_date | string | no | Filter activity logs logged at or before this date. A date or a full ISO 8601 datetime is accepted. |
| activity_types[] | array | no | Filter results by activity types. |
| activity_sources[] | array | no | Filter results by activity sources. |
| user_emails[] | array | no | Filter results by the email of the user who performed the activity. |
| external_customer_id | string | no | Unique identifier assigned to the customer in your application. |
| external_subscription_id | string | no | External subscription ID |
| resource_ids[] | array | no | Filter results by the unique identifiers of the resources the actions were applied to. |
| resource_types[] | array | no | Filter results by resource types. |

### Retrieve an activity log
`GET https://apizie.tech/v1/payments:lago/find-activity-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| activity_id | string | yes | The unique identifier of the activity log, created by Lago. |

### List all add-ons
`GET https://apizie.tech/v1/payments:lago/find-all-add-ons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |

### Create an add-on
`POST https://apizie.tech/v1/payments:lago/create-add-on` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an add-on
`GET https://apizie.tech/v1/payments:lago/find-add-on` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Unique code used to identify the add-on. |

### Update an add-on
`POST https://apizie.tech/v1/payments:lago/update-add-on` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Unique code used to identify the add-on. |
| body | object | yes | JSON request body |

### Delete an add-on
`POST https://apizie.tech/v1/payments:lago/destroy-add-on` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Unique code used to identify the add-on. |

### List all API logs
`GET https://apizie.tech/v1/payments:lago/find-all-api-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| from_date | string | no | Filter API logs logged at or after this date. |
| to_date | string | no | Filter API logs logged at or before this date. |
| http_methods[] | array | no | Filter results by HTTP methods. |
| http_statuses[] | array | no | Filter results by HTTP status or by generic request status. When `succeeded` or `failed` is passed, the numeric values of the filter are… |
| api_version | string | no | Filter results by API version. |
| request_paths[] | array | no | Filter results by the path of the request. A value containing `*` is matched as a wildcard, otherwise the path must match exactly. |
| clients[] | array | no | Filter results by the client that issued the request, as reported by its user agent. |

### Retrieve an API log
`GET https://apizie.tech/v1/payments:lago/find-api-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| request_id | string | yes | The unique identifier of the API log, which is the identifier of the request. |

### List gross revenue
`GET https://apizie.tech/v1/payments:lago/find-all-gross-revenues` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| currency | string | no | Currency of revenue analytics. Format must be ISO 4217. |
| external_customer_id | string | no | The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. |
| billing_entity_code | string | no | Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole… |
| months | integer | no | Show data only for given number of months. |

### List of finalized invoices
`GET https://apizie.tech/v1/payments:lago/find-all-invoice-collections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| currency | string | no | The currency of revenue analytics. Format must be ISO 4217. |
| billing_entity_code | string | no | Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole… |
| months | integer | no | Show data only for given number of months. |

### List usage revenue
`GET https://apizie.tech/v1/payments:lago/find-all-invoiced-usages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| currency | string | no | The currency of invoiced usage analytics. Format must be ISO 4217. |
| billing_entity_code | string | no | Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole… |
| months | integer | no | Show data only for given number of months. |

### List MRR
`GET https://apizie.tech/v1/payments:lago/find-all-mrrs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| currency | string | no | The currency of MRR analytics. Format must be ISO 4217. |
| billing_entity_code | string | no | Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole… |
| months | integer | no | Show data only for given number of months. |

### List overdue balance
`GET https://apizie.tech/v1/payments:lago/find-all-overdue-balances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| currency | string | no | Filter the overdue balances by the currency of the invoices. Format must be ISO 4217. |
| external_customer_id | string | no | The customer external unique identifier (provided by your own application). Use it to restrict the overdue balances to a single customer. |
| billing_entity_code | string | no | Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole… |
| months | integer | no | Show data only for given number of months. |

### List usage
`GET https://apizie.tech/v1/payments:lago/find-all-usages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| time_granularity | string | no | The time granularity of usage analytics. Possible values are 'daily', 'weekly' and 'monthly'. Defaults to 'daily'. |
| currency | string | no | The currency of usage analytics. Format must be ISO 4217. |
| from_date | string | no | The start date of the period for which the usage analytics is calculated. |
| to_date | string | no | The end date of the period for which the usage analytics is calculated. |
| customer_type | string | no | The type of customer for which the usage analytics is calculated. Possible values are 'individual', 'company'. |
| external_customer_id | string | no | The external identifier of the customer for which the usage analytics is calculated. |
| customer_country | string | no | The country of the customer for which the usage analytics is calculated. |
| external_subscription_id | string | no | The external identifier of the subscription for which the usage analytics is calculated. |
| is_billable_metric_recurring | boolean | no | Indicates whether the billable metric associated with the usage is recurring. |
| plan_code | string | no | The code of the plan for which the usage analytics is calculated. |
| billable_metric_code | string | no | The code of the usage-based billable metrics for which the usage analytics is calculated. |

### List all applied coupons
`GET https://apizie.tech/v1/payments:lago/find-all-applied-coupons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| status | string | no | The status of the coupon. Can be either `active` or `terminated`. |
| external_customer_id | string | no | The customer external unique identifier (provided by your own application) |
| coupon_code[] | array | no | The code of the coupon applied to the customer. Use it to filter applied coupons by their code. |

### Apply a coupon to a customer
`POST https://apizie.tech/v1/payments:lago/apply-coupon` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List all billable metrics
`GET https://apizie.tech/v1/payments:lago/find-all-billable-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |

### Create a billable metric
`POST https://apizie.tech/v1/payments:lago/create-billable-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Evaluate an expression for a billable metric
`POST https://apizie.tech/v1/payments:lago/evaluate-billable-metric-expression` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a billable metric
`GET https://apizie.tech/v1/payments:lago/find-billable-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the existing billable metric. |

### Update a billable metric
`POST https://apizie.tech/v1/payments:lago/update-billable-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the existing billable metric. |
| body | object | yes | JSON request body |

### Delete a billable metric
`POST https://apizie.tech/v1/payments:lago/destroy-billable-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the existing billable metric. |

### List all features
`GET https://apizie.tech/v1/payments:lago/find-all-features` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| search_term | string | no | Filter features by search term. The term is matched against the name, the code and the description of the feature. |

### Create a feature
`POST https://apizie.tech/v1/payments:lago/create-feature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a feature
`GET https://apizie.tech/v1/payments:lago/find-feature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the existing feature. |

### Update a feature
`POST https://apizie.tech/v1/payments:lago/update-feature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the existing feature. |
| body | object | yes | JSON request body |

### Delete a feature
`POST https://apizie.tech/v1/payments:lago/destroy-feature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the existing feature. |

### Delete a privilege
`POST https://apizie.tech/v1/payments:lago/delete-feature-privilege` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Code of the existing feature. |
| privilege_code | string | yes | Code of the existing privilege. |

### List all coupons
`GET https://apizie.tech/v1/payments:lago/find-all-coupons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |

### Create a coupon
`POST https://apizie.tech/v1/payments:lago/create-coupon` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a coupon
`GET https://apizie.tech/v1/payments:lago/find-coupon` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Unique code used to identify the coupon. |

### Update a coupon
`POST https://apizie.tech/v1/payments:lago/update-coupon` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Unique code used to identify the coupon. |
| body | object | yes | JSON request body |

### Delete a coupon
`POST https://apizie.tech/v1/payments:lago/destroy-coupon` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | yes | Unique code used to identify the coupon. |

### List all credit notes
`GET https://apizie.tech/v1/payments:lago/find-all-credit-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| external_customer_id | string | no | Unique identifier assigned to the customer in your application. |
| issuing_date_from | string | no | Filter credit notes starting from a specific date. |
| issuing_date_to | string | no | Filter credit notes up to a specific date. |
| search_term | string | no | Search credit notes by id, number, customer name, customer external_id or customer email. |
| currency | string | no | Filter credit notes by currency. Possible values ISO 4217 currency codes. |
| reason | string | no | Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`,… |
| credit_status | string | no | Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`. |
| refund_status | string | no | Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`. |
| invoice_number | string | no | Filter credit notes by their related invoice number. |
| purchase_order_number | string | no | Filter by the invoice purchase order number. The match is exact but case-insensitive. |
| amount_from | integer | no | Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency… |
| amount_to | integer | no | Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. |
| types[] | array | no | Filter credit notes by the kind of amount they carry. `credit` matches credit notes with a credited amount, `refund` those with a refunded… |
| self_billed | boolean | no | Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`. |
| billing_entity_codes[] | array | no | Filter credit notes by billing entity codes. |

### Create a credit note
`POST https://apizie.tech/v1/payments:lago/create-credit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a credit note
`GET https://apizie.tech/v1/payments:lago/find-credit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The credit note unique identifier, created by Lago. |

### Update a credit note
`POST https://apizie.tech/v1/payments:lago/update-credit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The credit note unique identifier, created by Lago. |
| body | object | yes | JSON request body |

### Download a credit note PDF
`POST https://apizie.tech/v1/payments:lago/download-credit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The credit note unique identifier, created by Lago. |

### Estimate amounts for a new credit note
`POST https://apizie.tech/v1/payments:lago/estimate-credit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Void available credit
`POST https://apizie.tech/v1/payments:lago/void-credit-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The credit note unique identifier, created by Lago. |

### Replace credit note metadata
`POST https://apizie.tech/v1/payments:lago/replace-credit-note-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The credit note unique identifier, created by Lago. |
| body | object | yes | JSON request body |

### Merge credit note metadata
`POST https://apizie.tech/v1/payments:lago/merge-credit-note-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The credit note unique identifier, created by Lago. |
| body | object | yes | JSON request body |

### Delete all credit note metadata
`POST https://apizie.tech/v1/payments:lago/delete-all-credit-note-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The credit note unique identifier, created by Lago. |

### Delete a metadata key
`POST https://apizie.tech/v1/payments:lago/delete-credit-note-metadata-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The credit note unique identifier, created by Lago. |
| key | string | yes | The metadata key to delete. |

### List all customers
`GET https://apizie.tech/v1/payments:lago/find-all-customers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| external_id | string | no | Filter customers by external ID. |
| account_type[] | array | no | Filter customers by account type. |
| billing_entity_codes[] | array | no | Filter customers by billing entity codes. |
| search_term | string | no | Filter customers by search term. This will filter all customers whose name, firstname, lastname, legal name, external id or email contain… |
| countries[] | array | no | Filter customers by countries. Possible values are the ISO 3166-1 alpha-2 codes. |
| states[] | array | no | Filter customers by states. |
| zipcodes[] | array | no | Filter customers by zipcodes. |
| currencies[] | array | no | Filter customers by currencies. |
| has_tax_identification_number | boolean | no | Filter customers by whether they have a tax identification number or not. |
| metadata[key] | string | no | Filter customers by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing… |
| customer_type | string | no | Filter customers by customer type. |
| has_customer_type | boolean | no | Filter customers by whether they have a customer type or not. |

### Create a customer
`POST https://apizie.tech/v1/payments:lago/create-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a customer
`GET https://apizie.tech/v1/payments:lago/find-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |

### Delete a customer
`POST https://apizie.tech/v1/payments:lago/destroy-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |

### List all customer's applied coupons
`GET https://apizie.tech/v1/payments:lago/find-all-customer-applied-coupons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| status | string | no | The status of the coupon. Can be either `active` or `terminated`. |
| coupon_code[] | array | no | The code of the coupon applied to the customer. Use it to filter applied coupons by their code. |

### Delete an applied coupon
`POST https://apizie.tech/v1/payments:lago/delete-applied-coupon` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| applied_coupon_id | string | yes | Unique identifier of the applied coupon, created by Lago. |

### List all customer's credit notes
`GET https://apizie.tech/v1/payments:lago/find-all-customer-credit-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| issuing_date_from | string | no | Filter credit notes starting from a specific date. |
| issuing_date_to | string | no | Filter credit notes up to a specific date. |
| search_term | string | no | Search credit notes by id, number, customer name, customer external_id or customer email. |
| currency | string | no | Filter credit notes by currency. Possible values ISO 4217 currency codes. |
| reason | string | no | Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`,… |
| credit_status | string | no | Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`. |
| refund_status | string | no | Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`. |
| invoice_number | string | no | Filter credit notes by their related invoice number. |
| purchase_order_number | string | no | Filter by the invoice purchase order number. The match is exact but case-insensitive. |
| amount_from | integer | no | Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency… |
| amount_to | integer | no | Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. |
| types[] | array | no | Filter credit notes by the kind of amount they carry. `credit` matches credit notes with a credited amount, `refund` those with a refunded… |
| self_billed | boolean | no | Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`. |
| billing_entity_codes[] | array | no | Filter credit notes by billing entity codes. |

### List all customer's invoices
`GET https://apizie.tech/v1/payments:lago/find-all-customer-invoices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| amount_from | integer | no | Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. |
| amount_to | integer | no | Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. |
| issuing_date_from | string | no | Filter invoices starting from a specific date. |
| issuing_date_to | string | no | Filter invoices up to a specific date. |
| status | string | no | Filter invoices by status. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`. |
| statuses[] | array | no | Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`. |
| payment_status | string | no | Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`. |
| payment_statuses[] | array | no | Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`. |
| payment_overdue | boolean | no | Filter invoices by payment_overdue. Possible values are `true` or `false`. |
| search_term | string | no | Search the customer's invoices by id or number. Customer attributes are not searched here, because the list is already scoped to one… |
| payment_dispute_lost | boolean | no | Filter invoices with a payment dispute lost. Possible values are `true` or `false`. |
| invoice_type | string | no | Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or… |
| self_billed | boolean | no | Filter invoices by self billed. Possible values are `true` or `false`. |
| currency | string | no | Filter invoices by currency. Possible values ISO 4217 currency codes. |
| partially_paid | boolean | no | Filter invoices that are partially paid. When `true`, only invoices with a non-zero amount paid that is below the total due are returned.… |
| settlements[] | array | no | Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note`… |
| billing_entity_codes[] | array | no | Filter invoices by billing entity codes. Possible values are the billing entity codes you have created. |
| metadata[key] | string | no | Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing… |
| purchase_order_number | string | no | Filter by the invoice purchase order number. The match is exact but case-insensitive. |

### List all customer's payments
`GET https://apizie.tech/v1/payments:lago/find-all-customer-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| invoice_id | string | no | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### List all customer's payment requests
`GET https://apizie.tech/v1/payments:lago/find-all-customer-payment-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| currency | string | no | Filter the results by currency, expressed as an ISO 4217 code. |
| payment_status | string | no | Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. |
| billing_entity_codes[] | array | no | Filter payment requests by billing entity codes. |

### Get a customer portal URL
`GET https://apizie.tech/v1/payments:lago/get-customer-portal-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | External ID of the existing customer |

### List all customer's subscriptions
`GET https://apizie.tech/v1/payments:lago/find-all-customer-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| currency | string | no | Filter the results by currency, expressed as an ISO 4217 code. |
| external_id | string | no | The subscription external unique identifier (provided by your own application). |
| plan_code | string | no | The unique code representing the plan to be attached to the customer. This code must correspond to the code property of one of the active… |
| overridden | boolean | no | When set, filters subscriptions by whether their plan is an override of a parent plan. `true` returns only subscriptions on overridden… |
| status[] | array | no | If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status… |
| billing_entity_codes[] | array | no | Filter subscriptions by billing entity codes. |

### List all customer's wallets
`GET https://apizie.tech/v1/payments:lago/find-all-customer-wallets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| currency | string | no | Filter the results by currency, expressed as an ISO 4217 code. |
| billing_entity_codes[] | array | no | Filter wallets by billing entity codes. |

### Create a wallet
`POST https://apizie.tech/v1/payments:lago/create-customer-wallet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| body | object | yes | JSON request body |

### Retrieve a wallet
`GET https://apizie.tech/v1/payments:lago/find-customer-wallet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |

### Update a wallet
`POST https://apizie.tech/v1/payments:lago/update-customer-wallet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| body | object | yes | JSON request body |

### Terminate a wallet
`POST https://apizie.tech/v1/payments:lago/destroy-customer-wallet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |

### Replace wallet metadata
`POST https://apizie.tech/v1/payments:lago/replace-customer-wallet-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| body | object | yes | JSON request body |

### Merge wallet metadata
`POST https://apizie.tech/v1/payments:lago/merge-customer-wallet-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| body | object | yes | JSON request body |

### Delete all wallet metadata
`POST https://apizie.tech/v1/payments:lago/delete-all-customer-wallet-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |

### Delete a metadata key
`POST https://apizie.tech/v1/payments:lago/delete-customer-wallet-metadata-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| key | string | yes | The metadata key to delete. |

### List wallet alerts
`GET https://apizie.tech/v1/payments:lago/get-customer-wallet-alerts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |

### Create wallet alert(s)
`POST https://apizie.tech/v1/payments:lago/create-customer-wallet-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| body | object | yes | JSON request body |

### Delete all wallet alerts
`POST https://apizie.tech/v1/payments:lago/delete-all-customer-wallet-alerts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |

### Retrieve a wallet alert
`GET https://apizie.tech/v1/payments:lago/get-customer-wallet-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| code | string | yes | Unique code of the alert |

### Update a wallet alert
`POST https://apizie.tech/v1/payments:lago/update-customer-wallet-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| code | string | yes | Unique code of the alert |
| body | object | yes | JSON request body |

### Delete a wallet alert
`POST https://apizie.tech/v1/payments:lago/delete-customer-wallet-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| wallet_code | string | yes | A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided. |
| code | string | yes | Unique code of the alert |

### Retrieve customer current usage
`GET https://apizie.tech/v1/payments:lago/find-customer-current-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application). |
| external_subscription_id | string | yes | The unique identifier of the subscription within your application. |
| apply_taxes | boolean | no | Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null. |
| charge_id | string | no | Filter usage to a specific charge by its Lago ID (UUID). Replaces deprecated `filter_by_charge_id`. |
| charge_code | string | no | Filter usage to a specific charge by its code. Replaces deprecated `filter_by_charge_code`. |
| billable_metric_code | string | no | Filter usage to a specific billable metric by its code. |
| group | object | no | Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `group[cloud]=aws`. Replaces deprecated `filter_by_group`. |
| filter_by_charge_id | string | no | **Deprecated.** Filter usage to a specific charge by its Lago ID (UUID). |
| filter_by_charge_code | string | no | **Deprecated.** Filter usage to a specific charge by its code. |
| filter_by_group | object | no | **Deprecated.** Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`. |
| full_usage | boolean | no | When `true`, returns usage since the subscription started instead of the current billing period. It requires the granular lifetime usage… |
| filter_by_presentation | string | no | Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values… |

### Retrieve customer current and projected usage
`GET https://apizie.tech/v1/payments:lago/find-customer-projected-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application). |
| external_subscription_id | string | yes | The unique identifier of the subscription within your application. |
| apply_taxes | boolean | no | Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null. |
| charge_id | string | no | Filter usage to a specific charge by its Lago ID (UUID). |
| charge_code | string | no | Filter usage to a specific charge by its code. |
| billable_metric_code | string | no | Filter usage to a specific billable metric by its code. |
| group | object | no | Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `group[cloud]=aws`. |
| filter_by_presentation | string | no | Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values… |

### Retrieve customer past usage
`GET https://apizie.tech/v1/payments:lago/find-all-customer-past-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application). |
| external_subscription_id | string | yes | The unique identifier of the subscription within your application. |
| billable_metric_code | string | no | Billable metric code filter to apply to the charge usage |
| periods_count | integer | no | Number of past billing period to returns in the result |

### Generate a Customer Payment Provider Checkout URL
`POST https://apizie.tech/v1/payments:lago/generate-customer-checkout-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application). |

### List all customer payment methods
`GET https://apizie.tech/v1/payments:lago/find-all-customers-payment-methods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |

### Set the payment method as default
`POST https://apizie.tech/v1/payments:lago/payment-method-set-as-default` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The payment method unique identifier, created by Lago. |
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |

### Delete a payment method
`POST https://apizie.tech/v1/payments:lago/destroy-payment-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | The payment method unique identifier, created by Lago. |
| external_customer_id | string | yes | The customer external unique identifier (provided by your own application) |

### List all events
`GET https://apizie.tech/v1/payments:lago/find-all-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| external_subscription_id | string | no | External subscription ID |
| code | string | no | Filter events by code. |
| timestamp_from_started_at | boolean | no | Requires `external_subscription_id` to be set, and cannot be combined with `timestamp_from`. Filter events by timestamp after the… |
| timestamp_from | string | no | Filter events by timestamp starting from a specific date. |
| timestamp_to | string | no | Filter events by timestamp up to a specific date. |

### Send a usage event
`POST https://apizie.tech/v1/payments:lago/create-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Batch multiple events
`POST https://apizie.tech/v1/payments:lago/create-batch-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Estimate fees for a pay in advance charge
`POST https://apizie.tech/v1/payments:lago/event-estimate-fees` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Estimate instant fees for a pay in advance charge
`POST https://apizie.tech/v1/payments:lago/event-estimate-instant-fees` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Batch estimate instant fees for a pay in advance charge
`POST https://apizie.tech/v1/payments:lago/event-batch-estimate-instant-fees` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a specific event
`GET https://apizie.tech/v1/payments:lago/find-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | yes | This field represents the unique identifier sent for this specific event (must be URL encoded). |

### List all fees
`GET https://apizie.tech/v1/payments:lago/find-all-fees` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| external_customer_id | string | no | Unique identifier assigned to the customer in your application. |
| external_subscription_id | string | no | External subscription ID |
| event_transaction_id | string | no | Filter results by event transaction ID |
| currency | string | no | Filter results by the fee's currency. |
| fee_type | string | no | The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`. |
| billable_metric_code | string | no | Filter results by the `code` of the billable metric attached to the fee. Only applies to `charge` types. |
| payment_status | string | no | Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for… |
| created_at_from | string | no | Filter results created at or after this date and time in UTC. |
| created_at_to | string | no | Filter results created at or before this date and time in UTC. |
| succeeded_at_from | string | no | Filter results with a payment success at or after this date and time in UTC. |
| succeeded_at_to | string | no | Filter results with a payment success at or before this date and time in UTC. |
| failed_at_from | string | no | Filter results with a payment failure at or after this date and time in UTC. |
| failed_at_to | string | no | Filter results with a payment failure at or before this date and time in UTC. |
| refunded_at_from | string | no | Filter results with a payment refund at or after this date and time in UTC. |
| refunded_at_to | string | no | Filter results with a payment refund at or before this date and time in UTC. |

### Retrieve a specific fee
`GET https://apizie.tech/v1/payments:lago/find-fee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Update a fee
`POST https://apizie.tech/v1/payments:lago/update-fee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique… |
| body | object | yes | JSON request body |

### Delete a fee
`POST https://apizie.tech/v1/payments:lago/delete-fee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### List all invoices
`GET https://apizie.tech/v1/payments:lago/find-all-invoices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| external_customer_id | string | no | Unique identifier assigned to the customer in your application. |
| amount_from | integer | no | Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. |
| amount_to | integer | no | Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. |
| issuing_date_from | string | no | Filter invoices starting from a specific date. |
| issuing_date_to | string | no | Filter invoices up to a specific date. |
| status | string | no | Filter invoices by status. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`. |
| statuses[] | array | no | Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`. |
| payment_status | string | no | Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`. |
| payment_statuses[] | array | no | Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`. |
| payment_overdue | boolean | no | Filter invoices by payment_overdue. Possible values are `true` or `false`. |
| search_term | string | no | Search invoices by id, number, purchase order number, or by the name, legal name, first name, last name, external_id or email of the… |
| currency | string | no | Filter invoices by currency. Possible values ISO 4217 currency codes. |
| payment_dispute_lost | boolean | no | Filter invoices with a payment dispute lost. Possible values are `true` or `false`. |
| partially_paid | boolean | no | Filter invoices that are partially paid. When `true`, only invoices with a non-zero amount paid that is below the total due are returned.… |
| settlements[] | array | no | Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note`… |
| invoice_type | string | no | Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or… |
| self_billed | boolean | no | Filter invoices by self billed. Possible values are `true` or `false`. |
| billing_entity_codes[] | array | no | Filter invoices by billing entity codes. Possible values are the billing entity codes you have created. |
| metadata[key] | string | no | Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing… |
| purchase_order_number | string | no | Filter by the invoice purchase order number. The match is exact but case-insensitive. |

### Create a one-off invoice
`POST https://apizie.tech/v1/payments:lago/create-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve an invoice
`GET https://apizie.tech/v1/payments:lago/find-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Update an invoice
`POST https://apizie.tech/v1/payments:lago/update-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |
| body | object | yes | JSON request body |

### Delete a draft invoice
`POST https://apizie.tech/v1/payments:lago/delete-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Download an invoice PDF
`POST https://apizie.tech/v1/payments:lago/download-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Finalize a draft invoice
`POST https://apizie.tech/v1/payments:lago/finalize-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Mark an invoice payment dispute as lost
`POST https://apizie.tech/v1/payments:lago/lose-dispute-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Refresh a draft invoice
`POST https://apizie.tech/v1/payments:lago/refresh-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Retry generation of a failed invoice
`POST https://apizie.tech/v1/payments:lago/retry-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Generate a payment URL
`POST https://apizie.tech/v1/payments:lago/invoice-payment-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Create an invoice preview
`POST https://apizie.tech/v1/payments:lago/invoice-preview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retry an invoice payment
`POST https://apizie.tech/v1/payments:lago/retry-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |
| body | object | no | JSON request body |

### Void an invoice
`POST https://apizie.tech/v1/payments:lago/void-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique… |
| body | object | no | JSON request body |

### List all order forms
`GET https://apizie.tech/v1/payments:lago/find-all-order-forms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| status[] | array | no | Filter order forms by status. Possible values are `generated`, `signed`, `expired` and `voided`. |
| customer_id[] | array | no | Filter order forms by the Lago identifiers of their customers. |
| number[] | array | no | Filter order forms by their number, as assigned by Lago. |
| quote_number[] | array | no | Filter order forms by the number of the quote they come from. |
| owner_id[] | array | no | Filter order forms by the Lago identifiers of the users owning the quote they come from. |
| search_term | string | no | Search order forms by number. |
| created_at_from | string | no | Filter order forms created from a specific date and time, in UTC (ISO 8601). |
| created_at_to | string | no | Filter order forms created up to a specific date and time, in UTC (ISO 8601). |
| expires_at_from | string | no | Filter order forms expiring from a specific date and time, in UTC (ISO 8601). Order forms that never expire are excluded. |
| expires_at_to | string | no | Filter order forms expiring up to a specific date and time, in UTC (ISO 8601). Order forms that never expire are excluded. |

### Retrieve an order form
`GET https://apizie.tech/v1/payments:lago/find-order-form` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the order form within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Mark an order form as signed
`POST https://apizie.tech/v1/payments:lago/mark-order-form-as-signed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the order form within the Lago application. This ID is exclusively created by Lago and serves as a unique… |
| body | object | no | JSON request body |

### Void an order form
`POST https://apizie.tech/v1/payments:lago/void-order-form` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the order form within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### List all orders
`GET https://apizie.tech/v1/payments:lago/find-all-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| status[] | array | no | Filter orders by status. Possible values are `created`, `executed` and `failed`. |
| order_type[] | array | no | Filter orders by the order type of the quote they come from. Possible values are `subscription_creation`, `subscription_amendment` and… |
| execution_mode[] | array | no | Filter orders by execution mode. Possible values are `execute_in_lago` and `order_only`. |
| customer_id[] | array | no | Filter orders by the Lago identifiers of their customers. |
| number[] | array | no | Filter orders by their number, as assigned by Lago. |
| order_form_number[] | array | no | Filter orders by the number of the order form they come from. |
| quote_number[] | array | no | Filter orders by the number of the quote they come from. |
| owner_id[] | array | no | Filter orders by the Lago identifiers of the users owning the quote they come from. |
| search_term | string | no | Search orders by number. |
| executed_at_from | string | no | Filter orders executed from a specific date and time, in UTC (ISO 8601). Orders that have not been executed are excluded. |
| executed_at_to | string | no | Filter orders executed up to a specific date and time, in UTC (ISO 8601). Orders that have not been executed are excluded. |

### Retrieve an order
`GET https://apizie.tech/v1/payments:lago/find-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the order within the Lago application. This ID is exclusively created by Lago and serves as a unique… |

### Execute an order
`POST https://apizie.tech/v1/payments:lago/execute-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier assigned to the order within the Lago application. This ID is exclusively created by Lago and serves as a unique… |
| body | object | no | JSON request body |

### Retrieve your organization
`GET https://apizie.tech/v1/payments:lago/find-organization` (byok)

### Update your organization
`POST https://apizie.tech/v1/payments:lago/update-organization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List all payment receipts
`GET https://apizie.tech/v1/payments:lago/find-all-payment-receipts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| invoice_id | string | no | Filter payment receipts by invoice. It returns the receipts of the payments made on this invoice, including the payments made through a… |

### Retrieve a payment receipt
`GET https://apizie.tech/v1/payments:lago/find-payment-receipt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| lago_id | string | yes | Unique identifier of the payment receipt. |

### List all payment requests
`GET https://apizie.tech/v1/payments:lago/find-all-payment-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. |
| per_page | integer | no | Number of records per page. The maximum is 200. A larger value returns a `422` error with `value_is_out_of_range` on `per_page`. |
| currency | string | no | Filter the results by currency, expressed as an ISO 4217 code. |
| external_customer_id | string | no | Unique identifier assigned to the customer in your application. |
| payment_status | string | no | Filter by payment status. Possible values are `pending`, `failed` or `succeeded`. |
| billing_entity_codes[] | array | no | Filter payment requests by billing entity codes. |

…and 96 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/payments:lago/list-billing-entities" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Lago API documentation API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:lago/list-billing-entities with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Lago API documentation API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Lago API documentation itself also needs your own key from lago.

### Can AI agents use the Lago API documentation API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:lago.

### What is the status of the Lago API documentation API?
Needs your own provider key (bring your own key)