{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/payments:lago/list-billing-entities":{"get":{"operationId":"payments_lago_list_billing_entities","summary":"List all billing entities","description":"GET /billing_entities","tags":["payments"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-billing-entity":{"post":{"operationId":"payments_lago_create_billing_entity","summary":"Create a billing entity","description":"POST /billing_entities","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/get-billing-entity":{"get":{"operationId":"payments_lago_get_billing_entity","summary":"Retrieve a billing entity","description":"GET /billing_entities/{code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"The unique code of the billing entity","schema":{"type":"string","description":"The unique code of the billing entity"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-billing-entity":{"post":{"operationId":"payments_lago_update_billing_entity","summary":"Update a billing entity","description":"PUT /billing_entities/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"The unique code of the billing entity"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-activity-logs":{"get":{"operationId":"payments_lago_find_all_activity_logs","summary":"List all activity logs","description":"GET /activity_logs","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"from_date","in":"query","required":false,"description":"Filter activity logs logged at or after this date. A date or a full ISO 8601 datetime is accepted.","schema":{"type":"string","description":"Filter activity logs logged at or after this date. A date or a full ISO 8601 datetime is accepted."}},{"name":"to_date","in":"query","required":false,"description":"Filter activity logs logged at or before this date. A date or a full ISO 8601 datetime is accepted.","schema":{"type":"string","description":"Filter activity logs logged at or before this date. A date or a full ISO 8601 datetime is accepted."}},{"name":"activity_types[]","in":"query","required":false,"description":"Filter results by activity types.","schema":{"type":"array","description":"Filter results by activity types."}},{"name":"activity_sources[]","in":"query","required":false,"description":"Filter results by activity sources.","schema":{"type":"array","description":"Filter results by activity sources."}},{"name":"user_emails[]","in":"query","required":false,"description":"Filter results by the email of the user who performed the activity.","schema":{"type":"array","description":"Filter results by the email of the user who performed the activity."}},{"name":"external_customer_id","in":"query","required":false,"description":"Unique identifier assigned to the customer in your application.","schema":{"type":"string","description":"Unique identifier assigned to the customer in your application."}},{"name":"external_subscription_id","in":"query","required":false,"description":"External subscription ID","schema":{"type":"string","description":"External subscription ID"}},{"name":"resource_ids[]","in":"query","required":false,"description":"Filter results by the unique identifiers of the resources the actions were applied to.","schema":{"type":"array","description":"Filter results by the unique identifiers of the resources the actions were applied to."}},{"name":"resource_types[]","in":"query","required":false,"description":"Filter results by resource types.","schema":{"type":"array","description":"Filter results by resource types."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-activity-log":{"get":{"operationId":"payments_lago_find_activity_log","summary":"Retrieve an activity log","description":"GET /activity_logs/{activity_id}","tags":["payments"],"parameters":[{"name":"activity_id","in":"query","required":true,"description":"The unique identifier of the activity log, created by Lago.","schema":{"type":"string","description":"The unique identifier of the activity log, created by Lago."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-add-ons":{"get":{"operationId":"payments_lago_find_all_add_ons","summary":"List all add-ons","description":"GET /add_ons","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-add-on":{"post":{"operationId":"payments_lago_create_add_on","summary":"Create an add-on","description":"POST /add_ons","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-add-on":{"get":{"operationId":"payments_lago_find_add_on","summary":"Retrieve an add-on","description":"GET /add_ons/{code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Unique code used to identify the add-on.","schema":{"type":"string","description":"Unique code used to identify the add-on."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-add-on":{"post":{"operationId":"payments_lago_update_add_on","summary":"Update an add-on","description":"PUT /add_ons/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"Unique code used to identify the add-on."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-add-on":{"post":{"operationId":"payments_lago_destroy_add_on","summary":"Delete an add-on","description":"DELETE /add_ons/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Unique code used to identify the add-on."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-api-logs":{"get":{"operationId":"payments_lago_find_all_api_logs","summary":"List all API logs","description":"GET /api_logs","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"from_date","in":"query","required":false,"description":"Filter API logs logged at or after this date.","schema":{"type":"string","description":"Filter API logs logged at or after this date."}},{"name":"to_date","in":"query","required":false,"description":"Filter API logs logged at or before this date.","schema":{"type":"string","description":"Filter API logs logged at or before this date."}},{"name":"http_methods[]","in":"query","required":false,"description":"Filter results by HTTP methods.","schema":{"type":"array","description":"Filter results by HTTP methods."}},{"name":"http_statuses[]","in":"query","required":false,"description":"Filter results by HTTP status or by generic request status. When `succeeded` or `failed` is passed, the numeric values of the filter are…","schema":{"type":"array","description":"Filter results by HTTP status or by generic request status. When `succeeded` or `failed` is passed, the numeric values of the filter are…"}},{"name":"api_version","in":"query","required":false,"description":"Filter results by API version.","schema":{"type":"string","description":"Filter results by API version."}},{"name":"request_paths[]","in":"query","required":false,"description":"Filter results by the path of the request. A value containing `*` is matched as a wildcard, otherwise the path must match exactly.","schema":{"type":"array","description":"Filter results by the path of the request. A value containing `*` is matched as a wildcard, otherwise the path must match exactly."}},{"name":"clients[]","in":"query","required":false,"description":"Filter results by the client that issued the request, as reported by its user agent.","schema":{"type":"array","description":"Filter results by the client that issued the request, as reported by its user agent."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-api-log":{"get":{"operationId":"payments_lago_find_api_log","summary":"Retrieve an API log","description":"GET /api_logs/{request_id}","tags":["payments"],"parameters":[{"name":"request_id","in":"query","required":true,"description":"The unique identifier of the API log, which is the identifier of the request.","schema":{"type":"string","description":"The unique identifier of the API log, which is the identifier of the request."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-gross-revenues":{"get":{"operationId":"payments_lago_find_all_gross_revenues","summary":"List gross revenue","description":"GET /analytics/gross_revenue","tags":["payments"],"parameters":[{"name":"currency","in":"query","required":false,"description":"Currency of revenue analytics. Format must be ISO 4217.","schema":{"type":"string","description":"Currency of revenue analytics. Format must be ISO 4217."}},{"name":"external_customer_id","in":"query","required":false,"description":"The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level."}},{"name":"billing_entity_code","in":"query","required":false,"description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…","schema":{"type":"string","description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…"}},{"name":"months","in":"query","required":false,"description":"Show data only for given number of months.","schema":{"type":"integer","description":"Show data only for given number of months."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-invoice-collections":{"get":{"operationId":"payments_lago_find_all_invoice_collections","summary":"List of finalized invoices","description":"GET /analytics/invoice_collection","tags":["payments"],"parameters":[{"name":"currency","in":"query","required":false,"description":"The currency of revenue analytics. Format must be ISO 4217.","schema":{"type":"string","description":"The currency of revenue analytics. Format must be ISO 4217."}},{"name":"billing_entity_code","in":"query","required":false,"description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…","schema":{"type":"string","description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…"}},{"name":"months","in":"query","required":false,"description":"Show data only for given number of months.","schema":{"type":"integer","description":"Show data only for given number of months."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-invoiced-usages":{"get":{"operationId":"payments_lago_find_all_invoiced_usages","summary":"List usage revenue","description":"GET /analytics/invoiced_usage","tags":["payments"],"parameters":[{"name":"currency","in":"query","required":false,"description":"The currency of invoiced usage analytics. Format must be ISO 4217.","schema":{"type":"string","description":"The currency of invoiced usage analytics. Format must be ISO 4217."}},{"name":"billing_entity_code","in":"query","required":false,"description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…","schema":{"type":"string","description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…"}},{"name":"months","in":"query","required":false,"description":"Show data only for given number of months.","schema":{"type":"integer","description":"Show data only for given number of months."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-mrrs":{"get":{"operationId":"payments_lago_find_all_mrrs","summary":"List MRR","description":"GET /analytics/mrr","tags":["payments"],"parameters":[{"name":"currency","in":"query","required":false,"description":"The currency of MRR analytics. Format must be ISO 4217.","schema":{"type":"string","description":"The currency of MRR analytics. Format must be ISO 4217."}},{"name":"billing_entity_code","in":"query","required":false,"description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…","schema":{"type":"string","description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…"}},{"name":"months","in":"query","required":false,"description":"Show data only for given number of months.","schema":{"type":"integer","description":"Show data only for given number of months."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-overdue-balances":{"get":{"operationId":"payments_lago_find_all_overdue_balances","summary":"List overdue balance","description":"GET /analytics/overdue_balance","tags":["payments"],"parameters":[{"name":"currency","in":"query","required":false,"description":"Filter the overdue balances by the currency of the invoices. Format must be ISO 4217.","schema":{"type":"string","description":"Filter the overdue balances by the currency of the invoices. Format must be ISO 4217."}},{"name":"external_customer_id","in":"query","required":false,"description":"The customer external unique identifier (provided by your own application). Use it to restrict the overdue balances to a single customer.","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application). Use it to restrict the overdue balances to a single customer."}},{"name":"billing_entity_code","in":"query","required":false,"description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…","schema":{"type":"string","description":"Restrict the analytics to a single billing entity, identified by its code. An unknown code is ignored and the analytics cover the whole…"}},{"name":"months","in":"query","required":false,"description":"Show data only for given number of months.","schema":{"type":"integer","description":"Show data only for given number of months."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-usages":{"get":{"operationId":"payments_lago_find_all_usages","summary":"List usage","description":"GET /analytics/usage","tags":["payments"],"parameters":[{"name":"time_granularity","in":"query","required":false,"description":"The time granularity of usage analytics. Possible values are 'daily', 'weekly' and 'monthly'. Defaults to 'daily'.","schema":{"type":"string","enum":["daily","weekly","monthly"],"default":"daily","description":"The time granularity of usage analytics. Possible values are 'daily', 'weekly' and 'monthly'. Defaults to 'daily'."}},{"name":"currency","in":"query","required":false,"description":"The currency of usage analytics. Format must be ISO 4217.","schema":{"type":"string","description":"The currency of usage analytics. Format must be ISO 4217."}},{"name":"from_date","in":"query","required":false,"description":"The start date of the period for which the usage analytics is calculated.","schema":{"type":"string","description":"The start date of the period for which the usage analytics is calculated."}},{"name":"to_date","in":"query","required":false,"description":"The end date of the period for which the usage analytics is calculated.","schema":{"type":"string","description":"The end date of the period for which the usage analytics is calculated."}},{"name":"customer_type","in":"query","required":false,"description":"The type of customer for which the usage analytics is calculated. Possible values are 'individual', 'company'.","schema":{"type":"string","enum":["individual","company"],"description":"The type of customer for which the usage analytics is calculated. Possible values are 'individual', 'company'."}},{"name":"external_customer_id","in":"query","required":false,"description":"The external identifier of the customer for which the usage analytics is calculated.","schema":{"type":"string","description":"The external identifier of the customer for which the usage analytics is calculated."}},{"name":"customer_country","in":"query","required":false,"description":"The country of the customer for which the usage analytics is calculated.","schema":{"type":"string","description":"The country of the customer for which the usage analytics is calculated."}},{"name":"external_subscription_id","in":"query","required":false,"description":"The external identifier of the subscription for which the usage analytics is calculated.","schema":{"type":"string","description":"The external identifier of the subscription for which the usage analytics is calculated."}},{"name":"is_billable_metric_recurring","in":"query","required":false,"description":"Indicates whether the billable metric associated with the usage is recurring.","schema":{"type":"boolean","description":"Indicates whether the billable metric associated with the usage is recurring."}},{"name":"plan_code","in":"query","required":false,"description":"The code of the plan for which the usage analytics is calculated.","schema":{"type":"string","description":"The code of the plan for which the usage analytics is calculated."}},{"name":"billable_metric_code","in":"query","required":false,"description":"The code of the usage-based billable metrics for which the usage analytics is calculated.","schema":{"type":"string","description":"The code of the usage-based billable metrics for which the usage analytics is calculated."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-applied-coupons":{"get":{"operationId":"payments_lago_find_all_applied_coupons","summary":"List all applied coupons","description":"GET /applied_coupons","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"status","in":"query","required":false,"description":"The status of the coupon. Can be either `active` or `terminated`.","schema":{"type":"string","enum":["active","terminated"],"description":"The status of the coupon. Can be either `active` or `terminated`."}},{"name":"external_customer_id","in":"query","required":false,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"coupon_code[]","in":"query","required":false,"description":"The code of the coupon applied to the customer. Use it to filter applied coupons by their code.","schema":{"type":"array","description":"The code of the coupon applied to the customer. Use it to filter applied coupons by their code."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/apply-coupon":{"post":{"operationId":"payments_lago_apply_coupon","summary":"Apply a coupon to a customer","description":"POST /applied_coupons","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-billable-metrics":{"get":{"operationId":"payments_lago_find_all_billable_metrics","summary":"List all billable metrics","description":"GET /billable_metrics","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-billable-metric":{"post":{"operationId":"payments_lago_create_billable_metric","summary":"Create a billable metric","description":"POST /billable_metrics","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/evaluate-billable-metric-expression":{"post":{"operationId":"payments_lago_evaluate_billable_metric_expression","summary":"Evaluate an expression for a billable metric","description":"POST /billable_metrics/evaluate_expression","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-billable-metric":{"get":{"operationId":"payments_lago_find_billable_metric","summary":"Retrieve a billable metric","description":"GET /billable_metrics/{code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing billable metric.","schema":{"type":"string","description":"Code of the existing billable metric."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-billable-metric":{"post":{"operationId":"payments_lago_update_billable_metric","summary":"Update a billable metric","description":"PUT /billable_metrics/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"Code of the existing billable metric."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-billable-metric":{"post":{"operationId":"payments_lago_destroy_billable_metric","summary":"Delete a billable metric","description":"DELETE /billable_metrics/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Code of the existing billable metric."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-features":{"get":{"operationId":"payments_lago_find_all_features","summary":"List all features","description":"GET /features","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"search_term","in":"query","required":false,"description":"Filter features by search term. The term is matched against the name, the code and the description of the feature.","schema":{"type":"string","description":"Filter features by search term. The term is matched against the name, the code and the description of the feature."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-feature":{"post":{"operationId":"payments_lago_create_feature","summary":"Create a feature","description":"POST /features","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-feature":{"get":{"operationId":"payments_lago_find_feature","summary":"Retrieve a feature","description":"GET /features/{code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing feature.","schema":{"type":"string","description":"Code of the existing feature."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-feature":{"post":{"operationId":"payments_lago_update_feature","summary":"Update a feature","description":"PUT /features/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"Code of the existing feature."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-feature":{"post":{"operationId":"payments_lago_destroy_feature","summary":"Delete a feature","description":"DELETE /features/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Code of the existing feature."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-feature-privilege":{"post":{"operationId":"payments_lago_delete_feature_privilege","summary":"Delete a privilege","description":"DELETE /features/{code}/privileges/{privilege_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","privilege_code"],"properties":{"code":{"type":"string","description":"Code of the existing feature."},"privilege_code":{"type":"string","description":"Code of the existing privilege."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-coupons":{"get":{"operationId":"payments_lago_find_all_coupons","summary":"List all coupons","description":"GET /coupons","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-coupon":{"post":{"operationId":"payments_lago_create_coupon","summary":"Create a coupon","description":"POST /coupons","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-coupon":{"get":{"operationId":"payments_lago_find_coupon","summary":"Retrieve a coupon","description":"GET /coupons/{code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Unique code used to identify the coupon.","schema":{"type":"string","description":"Unique code used to identify the coupon."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-coupon":{"post":{"operationId":"payments_lago_update_coupon","summary":"Update a coupon","description":"PUT /coupons/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"Unique code used to identify the coupon."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-coupon":{"post":{"operationId":"payments_lago_destroy_coupon","summary":"Delete a coupon","description":"DELETE /coupons/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Unique code used to identify the coupon."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-credit-notes":{"get":{"operationId":"payments_lago_find_all_credit_notes","summary":"List all credit notes","description":"GET /credit_notes","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"external_customer_id","in":"query","required":false,"description":"Unique identifier assigned to the customer in your application.","schema":{"type":"string","description":"Unique identifier assigned to the customer in your application."}},{"name":"issuing_date_from","in":"query","required":false,"description":"Filter credit notes starting from a specific date.","schema":{"type":"string","description":"Filter credit notes starting from a specific date."}},{"name":"issuing_date_to","in":"query","required":false,"description":"Filter credit notes up to a specific date.","schema":{"type":"string","description":"Filter credit notes up to a specific date."}},{"name":"search_term","in":"query","required":false,"description":"Search credit notes by id, number, customer name, customer external_id or customer email.","schema":{"type":"string","description":"Search credit notes by id, number, customer name, customer external_id or customer email."}},{"name":"currency","in":"query","required":false,"description":"Filter credit notes by currency. Possible values ISO 4217 currency codes.","schema":{"type":"string","description":"Filter credit notes by currency. Possible values ISO 4217 currency codes."}},{"name":"reason","in":"query","required":false,"description":"Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`,…","schema":{"type":"string","enum":["product_unsatisfactory","order_change","order_cancellation","fraudulent_charge","duplicated_charge","other"],"description":"Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`,…"}},{"name":"credit_status","in":"query","required":false,"description":"Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`.","schema":{"type":"string","enum":["available","consumed","voided"],"description":"Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`."}},{"name":"refund_status","in":"query","required":false,"description":"Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`.","schema":{"type":"string","enum":["pending","succeeded","failed"],"description":"Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`."}},{"name":"invoice_number","in":"query","required":false,"description":"Filter credit notes by their related invoice number.","schema":{"type":"string","description":"Filter credit notes by their related invoice number."}},{"name":"purchase_order_number","in":"query","required":false,"description":"Filter by the invoice purchase order number. The match is exact but case-insensitive.","schema":{"type":"string","description":"Filter by the invoice purchase order number. The match is exact but case-insensitive."}},{"name":"amount_from","in":"query","required":false,"description":"Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency…","schema":{"type":"integer","description":"Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency…"}},{"name":"amount_to","in":"query","required":false,"description":"Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.","schema":{"type":"integer","description":"Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types."}},{"name":"types[]","in":"query","required":false,"description":"Filter credit notes by the kind of amount they carry. `credit` matches credit notes with a credited amount, `refund` those with a refunded…","schema":{"type":"array","description":"Filter credit notes by the kind of amount they carry. `credit` matches credit notes with a credited amount, `refund` those with a refunded…"}},{"name":"self_billed","in":"query","required":false,"description":"Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`.","schema":{"type":"boolean","description":"Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`."}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter credit notes by billing entity codes.","schema":{"type":"array","description":"Filter credit notes by billing entity codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-credit-note":{"post":{"operationId":"payments_lago_create_credit_note","summary":"Create a credit note","description":"POST /credit_notes","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-credit-note":{"get":{"operationId":"payments_lago_find_credit_note","summary":"Retrieve a credit note","description":"GET /credit_notes/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"The credit note unique identifier, created by Lago.","schema":{"type":"string","description":"The credit note unique identifier, created by Lago."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-credit-note":{"post":{"operationId":"payments_lago_update_credit_note","summary":"Update a credit note","description":"PUT /credit_notes/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"The credit note unique identifier, created by Lago."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/download-credit-note":{"post":{"operationId":"payments_lago_download_credit_note","summary":"Download a credit note PDF","description":"POST /credit_notes/{lago_id}/download","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"The credit note unique identifier, created by Lago."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/estimate-credit-note":{"post":{"operationId":"payments_lago_estimate_credit_note","summary":"Estimate amounts for a new credit note","description":"POST /credit_notes/estimate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/void-credit-note":{"post":{"operationId":"payments_lago_void_credit_note","summary":"Void available credit","description":"PUT /credit_notes/{lago_id}/void","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"The credit note unique identifier, created by Lago."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/replace-credit-note-metadata":{"post":{"operationId":"payments_lago_replace_credit_note_metadata","summary":"Replace credit note metadata","description":"POST /credit_notes/{lago_id}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"The credit note unique identifier, created by Lago."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/merge-credit-note-metadata":{"post":{"operationId":"payments_lago_merge_credit_note_metadata","summary":"Merge credit note metadata","description":"PATCH /credit_notes/{lago_id}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"The credit note unique identifier, created by Lago."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-all-credit-note-metadata":{"post":{"operationId":"payments_lago_delete_all_credit_note_metadata","summary":"Delete all credit note metadata","description":"DELETE /credit_notes/{lago_id}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"The credit note unique identifier, created by Lago."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-credit-note-metadata-key":{"post":{"operationId":"payments_lago_delete_credit_note_metadata_key","summary":"Delete a metadata key","description":"DELETE /credit_notes/{lago_id}/metadata/{key}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","key"],"properties":{"lago_id":{"type":"string","description":"The credit note unique identifier, created by Lago."},"key":{"type":"string","description":"The metadata key to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customers":{"get":{"operationId":"payments_lago_find_all_customers","summary":"List all customers","description":"GET /customers","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"external_id","in":"query","required":false,"description":"Filter customers by external ID.","schema":{"type":"string","description":"Filter customers by external ID."}},{"name":"account_type[]","in":"query","required":false,"description":"Filter customers by account type.","schema":{"type":"array","description":"Filter customers by account type."}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter customers by billing entity codes.","schema":{"type":"array","description":"Filter customers by billing entity codes."}},{"name":"search_term","in":"query","required":false,"description":"Filter customers by search term. This will filter all customers whose name, firstname, lastname, legal name, external id or email contain…","schema":{"type":"string","description":"Filter customers by search term. This will filter all customers whose name, firstname, lastname, legal name, external id or email contain…"}},{"name":"countries[]","in":"query","required":false,"description":"Filter customers by countries. Possible values are the ISO 3166-1 alpha-2 codes.","schema":{"type":"array","description":"Filter customers by countries. Possible values are the ISO 3166-1 alpha-2 codes."}},{"name":"states[]","in":"query","required":false,"description":"Filter customers by states.","schema":{"type":"array","description":"Filter customers by states."}},{"name":"zipcodes[]","in":"query","required":false,"description":"Filter customers by zipcodes.","schema":{"type":"array","description":"Filter customers by zipcodes."}},{"name":"currencies[]","in":"query","required":false,"description":"Filter customers by currencies.","schema":{"type":"array","description":"Filter customers by currencies."}},{"name":"has_tax_identification_number","in":"query","required":false,"description":"Filter customers by whether they have a tax identification number or not.","schema":{"type":"boolean","description":"Filter customers by whether they have a tax identification number or not."}},{"name":"metadata[key]","in":"query","required":false,"description":"Filter customers by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing…","schema":{"type":"string","description":"Filter customers by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing…"}},{"name":"customer_type","in":"query","required":false,"description":"Filter customers by customer type.","schema":{"type":"string","enum":["company","individual"],"description":"Filter customers by customer type."}},{"name":"has_customer_type","in":"query","required":false,"description":"Filter customers by whether they have a customer type or not.","schema":{"type":"boolean","description":"Filter customers by whether they have a customer type or not."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-customer":{"post":{"operationId":"payments_lago_create_customer","summary":"Create a customer","description":"POST /customers","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-customer":{"get":{"operationId":"payments_lago_find_customer","summary":"Retrieve a customer","description":"GET /customers/{external_customer_id}","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-customer":{"post":{"operationId":"payments_lago_destroy_customer","summary":"Delete a customer","description":"DELETE /customers/{external_customer_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customer-applied-coupons":{"get":{"operationId":"payments_lago_find_all_customer_applied_coupons","summary":"List all customer's applied coupons","description":"GET /customers/{external_customer_id}/applied_coupons","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"status","in":"query","required":false,"description":"The status of the coupon. Can be either `active` or `terminated`.","schema":{"type":"string","enum":["active","terminated"],"description":"The status of the coupon. Can be either `active` or `terminated`."}},{"name":"coupon_code[]","in":"query","required":false,"description":"The code of the coupon applied to the customer. Use it to filter applied coupons by their code.","schema":{"type":"array","description":"The code of the coupon applied to the customer. Use it to filter applied coupons by their code."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-applied-coupon":{"post":{"operationId":"payments_lago_delete_applied_coupon","summary":"Delete an applied coupon","description":"DELETE /customers/{external_customer_id}/applied_coupons/{applied_coupon_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","applied_coupon_id"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"applied_coupon_id":{"type":"string","description":"Unique identifier of the applied coupon, created by Lago."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customer-credit-notes":{"get":{"operationId":"payments_lago_find_all_customer_credit_notes","summary":"List all customer's credit notes","description":"GET /customers/{external_customer_id}/credit_notes","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"issuing_date_from","in":"query","required":false,"description":"Filter credit notes starting from a specific date.","schema":{"type":"string","description":"Filter credit notes starting from a specific date."}},{"name":"issuing_date_to","in":"query","required":false,"description":"Filter credit notes up to a specific date.","schema":{"type":"string","description":"Filter credit notes up to a specific date."}},{"name":"search_term","in":"query","required":false,"description":"Search credit notes by id, number, customer name, customer external_id or customer email.","schema":{"type":"string","description":"Search credit notes by id, number, customer name, customer external_id or customer email."}},{"name":"currency","in":"query","required":false,"description":"Filter credit notes by currency. Possible values ISO 4217 currency codes.","schema":{"type":"string","description":"Filter credit notes by currency. Possible values ISO 4217 currency codes."}},{"name":"reason","in":"query","required":false,"description":"Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`,…","schema":{"type":"string","enum":["product_unsatisfactory","order_change","order_cancellation","fraudulent_charge","duplicated_charge","other"],"description":"Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`,…"}},{"name":"credit_status","in":"query","required":false,"description":"Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`.","schema":{"type":"string","enum":["available","consumed","voided"],"description":"Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`."}},{"name":"refund_status","in":"query","required":false,"description":"Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`.","schema":{"type":"string","enum":["pending","succeeded","failed"],"description":"Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`."}},{"name":"invoice_number","in":"query","required":false,"description":"Filter credit notes by their related invoice number.","schema":{"type":"string","description":"Filter credit notes by their related invoice number."}},{"name":"purchase_order_number","in":"query","required":false,"description":"Filter by the invoice purchase order number. The match is exact but case-insensitive.","schema":{"type":"string","description":"Filter by the invoice purchase order number. The match is exact but case-insensitive."}},{"name":"amount_from","in":"query","required":false,"description":"Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency…","schema":{"type":"integer","description":"Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency…"}},{"name":"amount_to","in":"query","required":false,"description":"Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.","schema":{"type":"integer","description":"Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types."}},{"name":"types[]","in":"query","required":false,"description":"Filter credit notes by the kind of amount they carry. `credit` matches credit notes with a credited amount, `refund` those with a refunded…","schema":{"type":"array","description":"Filter credit notes by the kind of amount they carry. `credit` matches credit notes with a credited amount, `refund` those with a refunded…"}},{"name":"self_billed","in":"query","required":false,"description":"Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`.","schema":{"type":"boolean","description":"Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`."}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter credit notes by billing entity codes.","schema":{"type":"array","description":"Filter credit notes by billing entity codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customer-invoices":{"get":{"operationId":"payments_lago_find_all_customer_invoices","summary":"List all customer's invoices","description":"GET /customers/{external_customer_id}/invoices","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"amount_from","in":"query","required":false,"description":"Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.","schema":{"type":"integer","description":"Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types."}},{"name":"amount_to","in":"query","required":false,"description":"Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.","schema":{"type":"integer","description":"Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types."}},{"name":"issuing_date_from","in":"query","required":false,"description":"Filter invoices starting from a specific date.","schema":{"type":"string","description":"Filter invoices starting from a specific date."}},{"name":"issuing_date_to","in":"query","required":false,"description":"Filter invoices up to a specific date.","schema":{"type":"string","description":"Filter invoices up to a specific date."}},{"name":"status","in":"query","required":false,"description":"Filter invoices by status. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`.","schema":{"type":"string","enum":["draft","finalized","failed","pending","voided"],"description":"Filter invoices by status. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`."}},{"name":"statuses[]","in":"query","required":false,"description":"Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`.","schema":{"type":"array","description":"Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`."}},{"name":"payment_status","in":"query","required":false,"description":"Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`.","schema":{"type":"string","enum":["pending","failed","succeeded"],"description":"Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`."}},{"name":"payment_statuses[]","in":"query","required":false,"description":"Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`.","schema":{"type":"array","description":"Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`."}},{"name":"payment_overdue","in":"query","required":false,"description":"Filter invoices by payment_overdue. Possible values are `true` or `false`.","schema":{"type":"boolean","description":"Filter invoices by payment_overdue. Possible values are `true` or `false`."}},{"name":"search_term","in":"query","required":false,"description":"Search the customer's invoices by id or number. Customer attributes are not searched here, because the list is already scoped to one…","schema":{"type":"string","description":"Search the customer's invoices by id or number. Customer attributes are not searched here, because the list is already scoped to one…"}},{"name":"payment_dispute_lost","in":"query","required":false,"description":"Filter invoices with a payment dispute lost. Possible values are `true` or `false`.","schema":{"type":"boolean","description":"Filter invoices with a payment dispute lost. Possible values are `true` or `false`."}},{"name":"invoice_type","in":"query","required":false,"description":"Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or…","schema":{"type":"string","enum":["subscription","add_on","credit","one_off","advance_charges","progressive_billing"],"description":"Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or…"}},{"name":"self_billed","in":"query","required":false,"description":"Filter invoices by self billed. Possible values are `true` or `false`.","schema":{"type":"boolean","description":"Filter invoices by self billed. Possible values are `true` or `false`."}},{"name":"currency","in":"query","required":false,"description":"Filter invoices by currency. Possible values ISO 4217 currency codes.","schema":{"type":"string","description":"Filter invoices by currency. Possible values ISO 4217 currency codes."}},{"name":"partially_paid","in":"query","required":false,"description":"Filter invoices that are partially paid. When `true`, only invoices with a non-zero amount paid that is below the total due are returned.…","schema":{"type":"boolean","description":"Filter invoices that are partially paid. When `true`, only invoices with a non-zero amount paid that is below the total due are returned.…"}},{"name":"settlements[]","in":"query","required":false,"description":"Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note`…","schema":{"type":"array","description":"Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note`…"}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter invoices by billing entity codes. Possible values are the billing entity codes you have created.","schema":{"type":"array","description":"Filter invoices by billing entity codes. Possible values are the billing entity codes you have created."}},{"name":"metadata[key]","in":"query","required":false,"description":"Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing…","schema":{"type":"string","description":"Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing…"}},{"name":"purchase_order_number","in":"query","required":false,"description":"Filter by the invoice purchase order number. The match is exact but case-insensitive.","schema":{"type":"string","description":"Filter by the invoice purchase order number. The match is exact but case-insensitive."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customer-payments":{"get":{"operationId":"payments_lago_find_all_customer_payments","summary":"List all customer's payments","description":"GET /customers/{external_customer_id}/payments","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"invoice_id","in":"query","required":false,"description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customer-payment-requests":{"get":{"operationId":"payments_lago_find_all_customer_payment_requests","summary":"List all customer's payment requests","description":"GET /customers/{external_customer_id}/payment_requests","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"currency","in":"query","required":false,"description":"Filter the results by currency, expressed as an ISO 4217 code.","schema":{"type":"string","description":"Filter the results by currency, expressed as an ISO 4217 code."}},{"name":"payment_status","in":"query","required":false,"description":"Filter by payment status. Possible values are `pending`, `failed` or `succeeded`.","schema":{"type":"string","enum":["pending","failed","succeeded"],"description":"Filter by payment status. Possible values are `pending`, `failed` or `succeeded`."}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter payment requests by billing entity codes.","schema":{"type":"array","description":"Filter payment requests by billing entity codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/get-customer-portal-url":{"get":{"operationId":"payments_lago_get_customer_portal_url","summary":"Get a customer portal URL","description":"GET /customers/{external_customer_id}/portal_url","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"External ID of the existing customer","schema":{"type":"string","description":"External ID of the existing customer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customer-subscriptions":{"get":{"operationId":"payments_lago_find_all_customer_subscriptions","summary":"List all customer's subscriptions","description":"GET /customers/{external_customer_id}/subscriptions","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"currency","in":"query","required":false,"description":"Filter the results by currency, expressed as an ISO 4217 code.","schema":{"type":"string","description":"Filter the results by currency, expressed as an ISO 4217 code."}},{"name":"external_id","in":"query","required":false,"description":"The subscription external unique identifier (provided by your own application).","schema":{"type":"string","description":"The subscription external unique identifier (provided by your own application)."}},{"name":"plan_code","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"overridden","in":"query","required":false,"description":"When set, filters subscriptions by whether their plan is an override of a parent plan. `true` returns only subscriptions on overridden…","schema":{"type":"boolean","description":"When set, filters subscriptions by whether their plan is an override of a parent plan. `true` returns only subscriptions on overridden…"}},{"name":"status[]","in":"query","required":false,"description":"If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status…","schema":{"type":"array","description":"If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status…"}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter subscriptions by billing entity codes.","schema":{"type":"array","description":"Filter subscriptions by billing entity codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customer-wallets":{"get":{"operationId":"payments_lago_find_all_customer_wallets","summary":"List all customer's wallets","description":"GET /customers/{external_customer_id}/wallets","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"currency","in":"query","required":false,"description":"Filter the results by currency, expressed as an ISO 4217 code.","schema":{"type":"string","description":"Filter the results by currency, expressed as an ISO 4217 code."}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter wallets by billing entity codes.","schema":{"type":"array","description":"Filter wallets by billing entity codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-customer-wallet":{"post":{"operationId":"payments_lago_create_customer_wallet","summary":"Create a wallet","description":"POST /customers/{external_customer_id}/wallets","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","body"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-customer-wallet":{"get":{"operationId":"payments_lago_find_customer_wallet","summary":"Retrieve a wallet","description":"GET /customers/{external_customer_id}/wallets/{code}","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"code","in":"query","required":true,"description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided.","schema":{"type":"string","description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-customer-wallet":{"post":{"operationId":"payments_lago_update_customer_wallet","summary":"Update a wallet","description":"PUT /customers/{external_customer_id}/wallets/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","code","body"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"code":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-customer-wallet":{"post":{"operationId":"payments_lago_destroy_customer_wallet","summary":"Terminate a wallet","description":"DELETE /customers/{external_customer_id}/wallets/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","code"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"code":{"type":"string","description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/replace-customer-wallet-metadata":{"post":{"operationId":"payments_lago_replace_customer_wallet_metadata","summary":"Replace wallet metadata","description":"POST /customers/{external_customer_id}/wallets/{wallet_code}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","wallet_code","body"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"wallet_code":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/merge-customer-wallet-metadata":{"post":{"operationId":"payments_lago_merge_customer_wallet_metadata","summary":"Merge wallet metadata","description":"PATCH /customers/{external_customer_id}/wallets/{wallet_code}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","wallet_code","body"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"wallet_code":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-all-customer-wallet-metadata":{"post":{"operationId":"payments_lago_delete_all_customer_wallet_metadata","summary":"Delete all wallet metadata","description":"DELETE /customers/{external_customer_id}/wallets/{wallet_code}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","wallet_code"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"wallet_code":{"type":"string","description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-customer-wallet-metadata-key":{"post":{"operationId":"payments_lago_delete_customer_wallet_metadata_key","summary":"Delete a metadata key","description":"DELETE /customers/{external_customer_id}/wallets/{wallet_code}/metadata/{key}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","wallet_code","key"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"wallet_code":{"type":"string","description":"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":{"type":"string","description":"The metadata key to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/get-customer-wallet-alerts":{"get":{"operationId":"payments_lago_get_customer_wallet_alerts","summary":"List wallet alerts","description":"GET /customers/{external_customer_id}/wallets/{wallet_code}/alerts","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"wallet_code","in":"query","required":true,"description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided.","schema":{"type":"string","description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-customer-wallet-alert":{"post":{"operationId":"payments_lago_create_customer_wallet_alert","summary":"Create wallet alert(s)","description":"POST /customers/{external_customer_id}/wallets/{wallet_code}/alerts","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","wallet_code","body"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"wallet_code":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-all-customer-wallet-alerts":{"post":{"operationId":"payments_lago_delete_all_customer_wallet_alerts","summary":"Delete all wallet alerts","description":"DELETE /customers/{external_customer_id}/wallets/{wallet_code}/alerts","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","wallet_code"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"wallet_code":{"type":"string","description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/get-customer-wallet-alert":{"get":{"operationId":"payments_lago_get_customer_wallet_alert","summary":"Retrieve a wallet alert","description":"GET /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"wallet_code","in":"query","required":true,"description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided.","schema":{"type":"string","description":"A unique wallet identifier within a customer. It is either set by the user at creation or auto-generated by Lago if not provided."}},{"name":"code","in":"query","required":true,"description":"Unique code of the alert","schema":{"type":"string","description":"Unique code of the alert"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-customer-wallet-alert":{"post":{"operationId":"payments_lago_update_customer_wallet_alert","summary":"Update a wallet alert","description":"PUT /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","wallet_code","code","body"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"wallet_code":{"type":"string","description":"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":{"type":"string","description":"Unique code of the alert"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-customer-wallet-alert":{"post":{"operationId":"payments_lago_delete_customer_wallet_alert","summary":"Delete a wallet alert","description":"DELETE /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id","wallet_code","code"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"},"wallet_code":{"type":"string","description":"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":{"type":"string","description":"Unique code of the alert"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-customer-current-usage":{"get":{"operationId":"payments_lago_find_customer_current_usage","summary":"Retrieve customer current usage","description":"GET /customers/{external_customer_id}/current_usage","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application).","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)."}},{"name":"external_subscription_id","in":"query","required":true,"description":"The unique identifier of the subscription within your application.","schema":{"type":"string","description":"The unique identifier of the subscription within your application."}},{"name":"apply_taxes","in":"query","required":false,"description":"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.","schema":{"type":"boolean","default":true,"description":"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null."}},{"name":"charge_id","in":"query","required":false,"description":"Filter usage to a specific charge by its Lago ID (UUID). Replaces deprecated `filter_by_charge_id`.","schema":{"type":"string","description":"Filter usage to a specific charge by its Lago ID (UUID). Replaces deprecated `filter_by_charge_id`."}},{"name":"charge_code","in":"query","required":false,"description":"Filter usage to a specific charge by its code. Replaces deprecated `filter_by_charge_code`.","schema":{"type":"string","description":"Filter usage to a specific charge by its code. Replaces deprecated `filter_by_charge_code`."}},{"name":"billable_metric_code","in":"query","required":false,"description":"Filter usage to a specific billable metric by its code.","schema":{"type":"string","description":"Filter usage to a specific billable metric by its code."}},{"name":"group","in":"query","required":false,"description":"Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `group[cloud]=aws`. Replaces deprecated `filter_by_group`.","schema":{"type":"object","description":"Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `group[cloud]=aws`. Replaces deprecated `filter_by_group`."}},{"name":"filter_by_charge_id","in":"query","required":false,"description":"**Deprecated.** Filter usage to a specific charge by its Lago ID (UUID).","schema":{"type":"string","description":"**Deprecated.** Filter usage to a specific charge by its Lago ID (UUID)."}},{"name":"filter_by_charge_code","in":"query","required":false,"description":"**Deprecated.** Filter usage to a specific charge by its code.","schema":{"type":"string","description":"**Deprecated.** Filter usage to a specific charge by its code."}},{"name":"filter_by_group","in":"query","required":false,"description":"**Deprecated.** Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.","schema":{"type":"object","description":"**Deprecated.** Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`."}},{"name":"full_usage","in":"query","required":false,"description":"When `true`, returns usage since the subscription started instead of the current billing period. It requires the granular lifetime usage…","schema":{"type":"boolean","default":false,"description":"When `true`, returns usage since the subscription started instead of the current billing period. It requires the granular lifetime usage…"}},{"name":"filter_by_presentation","in":"query","required":false,"description":"Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values…","schema":{"type":"string","description":"Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-customer-projected-usage":{"get":{"operationId":"payments_lago_find_customer_projected_usage","summary":"Retrieve customer current and projected usage","description":"GET /customers/{external_customer_id}/projected_usage","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application).","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)."}},{"name":"external_subscription_id","in":"query","required":true,"description":"The unique identifier of the subscription within your application.","schema":{"type":"string","description":"The unique identifier of the subscription within your application."}},{"name":"apply_taxes","in":"query","required":false,"description":"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.","schema":{"type":"boolean","default":true,"description":"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null."}},{"name":"charge_id","in":"query","required":false,"description":"Filter usage to a specific charge by its Lago ID (UUID).","schema":{"type":"string","description":"Filter usage to a specific charge by its Lago ID (UUID)."}},{"name":"charge_code","in":"query","required":false,"description":"Filter usage to a specific charge by its code.","schema":{"type":"string","description":"Filter usage to a specific charge by its code."}},{"name":"billable_metric_code","in":"query","required":false,"description":"Filter usage to a specific billable metric by its code.","schema":{"type":"string","description":"Filter usage to a specific billable metric by its code."}},{"name":"group","in":"query","required":false,"description":"Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `group[cloud]=aws`.","schema":{"type":"object","description":"Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `group[cloud]=aws`."}},{"name":"filter_by_presentation","in":"query","required":false,"description":"Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values…","schema":{"type":"string","description":"Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customer-past-usage":{"get":{"operationId":"payments_lago_find_all_customer_past_usage","summary":"Retrieve customer past usage","description":"GET /customers/{external_customer_id}/past_usage","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application).","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)."}},{"name":"external_subscription_id","in":"query","required":true,"description":"The unique identifier of the subscription within your application.","schema":{"type":"string","description":"The unique identifier of the subscription within your application."}},{"name":"billable_metric_code","in":"query","required":false,"description":"Billable metric code filter to apply to the charge usage","schema":{"type":"string","description":"Billable metric code filter to apply to the charge usage"}},{"name":"periods_count","in":"query","required":false,"description":"Number of past billing period to returns in the result","schema":{"type":"integer","description":"Number of past billing period to returns in the result"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/generate-customer-checkout-url":{"post":{"operationId":"payments_lago_generate_customer_checkout_url","summary":"Generate a Customer Payment Provider Checkout URL","description":"POST /customers/{external_customer_id}/checkout_url","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_customer_id"],"properties":{"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-customers-payment-methods":{"get":{"operationId":"payments_lago_find_all_customers_payment_methods","summary":"List all customer payment methods","description":"GET /customers/{external_customer_id}/payment_methods","tags":["payments"],"parameters":[{"name":"external_customer_id","in":"query","required":true,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/payment-method-set-as-default":{"post":{"operationId":"payments_lago_payment_method_set_as_default","summary":"Set the payment method as default","description":"PUT /customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","external_customer_id"],"properties":{"lago_id":{"type":"string","description":"The payment method unique identifier, created by Lago."},"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-payment-method":{"post":{"operationId":"payments_lago_destroy_payment_method","summary":"Delete a payment method","description":"DELETE /customers/{external_customer_id}/payment_methods/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","external_customer_id"],"properties":{"lago_id":{"type":"string","description":"The payment method unique identifier, created by Lago."},"external_customer_id":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-events":{"get":{"operationId":"payments_lago_find_all_events","summary":"List all events","description":"GET /events","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"external_subscription_id","in":"query","required":false,"description":"External subscription ID","schema":{"type":"string","description":"External subscription ID"}},{"name":"code","in":"query","required":false,"description":"Filter events by code.","schema":{"type":"string","description":"Filter events by code."}},{"name":"timestamp_from_started_at","in":"query","required":false,"description":"Requires `external_subscription_id` to be set, and cannot be combined with `timestamp_from`. Filter events by timestamp after the…","schema":{"type":"boolean","description":"Requires `external_subscription_id` to be set, and cannot be combined with `timestamp_from`. Filter events by timestamp after the…"}},{"name":"timestamp_from","in":"query","required":false,"description":"Filter events by timestamp starting from a specific date.","schema":{"type":"string","description":"Filter events by timestamp starting from a specific date."}},{"name":"timestamp_to","in":"query","required":false,"description":"Filter events by timestamp up to a specific date.","schema":{"type":"string","description":"Filter events by timestamp up to a specific date."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-event":{"post":{"operationId":"payments_lago_create_event","summary":"Send a usage event","description":"POST /events","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/create-batch-events":{"post":{"operationId":"payments_lago_create_batch_events","summary":"Batch multiple events","description":"POST /events/batch","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/event-estimate-fees":{"post":{"operationId":"payments_lago_event_estimate_fees","summary":"Estimate fees for a pay in advance charge","description":"POST /events/estimate_fees","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/event-estimate-instant-fees":{"post":{"operationId":"payments_lago_event_estimate_instant_fees","summary":"Estimate instant fees for a pay in advance charge","description":"POST /events/estimate_instant_fees","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/event-batch-estimate-instant-fees":{"post":{"operationId":"payments_lago_event_batch_estimate_instant_fees","summary":"Batch estimate instant fees for a pay in advance charge","description":"POST /events/batch_estimate_instant_fees","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-event":{"get":{"operationId":"payments_lago_find_event","summary":"Retrieve a specific event","description":"GET /events/{transaction_id}","tags":["payments"],"parameters":[{"name":"transaction_id","in":"query","required":true,"description":"This field represents the unique identifier sent for this specific event (must be URL encoded).","schema":{"type":"string","description":"This field represents the unique identifier sent for this specific event (must be URL encoded)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-fees":{"get":{"operationId":"payments_lago_find_all_fees","summary":"List all fees","description":"GET /fees","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"external_customer_id","in":"query","required":false,"description":"Unique identifier assigned to the customer in your application.","schema":{"type":"string","description":"Unique identifier assigned to the customer in your application."}},{"name":"external_subscription_id","in":"query","required":false,"description":"External subscription ID","schema":{"type":"string","description":"External subscription ID"}},{"name":"event_transaction_id","in":"query","required":false,"description":"Filter results by event transaction ID","schema":{"type":"string","description":"Filter results by event transaction ID"}},{"name":"currency","in":"query","required":false,"description":"Filter results by the fee's currency.","schema":{"type":"string","description":"Filter results by the fee's currency."}},{"name":"fee_type","in":"query","required":false,"description":"The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`.","schema":{"type":"string","enum":["charge","fixed_charge","add_on","subscription","credit","commitment"],"description":"The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`."}},{"name":"billable_metric_code","in":"query","required":false,"description":"Filter results by the `code` of the billable metric attached to the fee. Only applies to `charge` types.","schema":{"type":"string","description":"Filter results by the `code` of the billable metric attached to the fee. Only applies to `charge` types."}},{"name":"payment_status","in":"query","required":false,"description":"Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for…","schema":{"type":"string","enum":["pending","succeeded","failed","refunded"],"description":"Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for…"}},{"name":"created_at_from","in":"query","required":false,"description":"Filter results created at or after this date and time in UTC.","schema":{"type":"string","description":"Filter results created at or after this date and time in UTC."}},{"name":"created_at_to","in":"query","required":false,"description":"Filter results created at or before this date and time in UTC.","schema":{"type":"string","description":"Filter results created at or before this date and time in UTC."}},{"name":"succeeded_at_from","in":"query","required":false,"description":"Filter results with a payment success at or after this date and time in UTC.","schema":{"type":"string","description":"Filter results with a payment success at or after this date and time in UTC."}},{"name":"succeeded_at_to","in":"query","required":false,"description":"Filter results with a payment success at or before this date and time in UTC.","schema":{"type":"string","description":"Filter results with a payment success at or before this date and time in UTC."}},{"name":"failed_at_from","in":"query","required":false,"description":"Filter results with a payment failure at or after this date and time in UTC.","schema":{"type":"string","description":"Filter results with a payment failure at or after this date and time in UTC."}},{"name":"failed_at_to","in":"query","required":false,"description":"Filter results with a payment failure at or before this date and time in UTC.","schema":{"type":"string","description":"Filter results with a payment failure at or before this date and time in UTC."}},{"name":"refunded_at_from","in":"query","required":false,"description":"Filter results with a payment refund at or after this date and time in UTC.","schema":{"type":"string","description":"Filter results with a payment refund at or after this date and time in UTC."}},{"name":"refunded_at_to","in":"query","required":false,"description":"Filter results with a payment refund at or before this date and time in UTC.","schema":{"type":"string","description":"Filter results with a payment refund at or before this date and time in UTC."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-fee":{"get":{"operationId":"payments_lago_find_fee","summary":"Retrieve a specific fee","description":"GET /fees/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-fee":{"post":{"operationId":"payments_lago_update_fee","summary":"Update a fee","description":"PUT /fees/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-fee":{"post":{"operationId":"payments_lago_delete_fee","summary":"Delete a fee","description":"DELETE /fees/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-invoices":{"get":{"operationId":"payments_lago_find_all_invoices","summary":"List all invoices","description":"GET /invoices","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"external_customer_id","in":"query","required":false,"description":"Unique identifier assigned to the customer in your application.","schema":{"type":"string","description":"Unique identifier assigned to the customer in your application."}},{"name":"amount_from","in":"query","required":false,"description":"Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.","schema":{"type":"integer","description":"Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types."}},{"name":"amount_to","in":"query","required":false,"description":"Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.","schema":{"type":"integer","description":"Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types."}},{"name":"issuing_date_from","in":"query","required":false,"description":"Filter invoices starting from a specific date.","schema":{"type":"string","description":"Filter invoices starting from a specific date."}},{"name":"issuing_date_to","in":"query","required":false,"description":"Filter invoices up to a specific date.","schema":{"type":"string","description":"Filter invoices up to a specific date."}},{"name":"status","in":"query","required":false,"description":"Filter invoices by status. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`.","schema":{"type":"string","enum":["draft","finalized","failed","pending","voided"],"description":"Filter invoices by status. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`."}},{"name":"statuses[]","in":"query","required":false,"description":"Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`.","schema":{"type":"array","description":"Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`."}},{"name":"payment_status","in":"query","required":false,"description":"Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`.","schema":{"type":"string","enum":["pending","failed","succeeded"],"description":"Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`."}},{"name":"payment_statuses[]","in":"query","required":false,"description":"Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`.","schema":{"type":"array","description":"Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`."}},{"name":"payment_overdue","in":"query","required":false,"description":"Filter invoices by payment_overdue. Possible values are `true` or `false`.","schema":{"type":"boolean","description":"Filter invoices by payment_overdue. Possible values are `true` or `false`."}},{"name":"search_term","in":"query","required":false,"description":"Search invoices by id, number, purchase order number, or by the name, legal name, first name, last name, external_id or email of the…","schema":{"type":"string","description":"Search invoices by id, number, purchase order number, or by the name, legal name, first name, last name, external_id or email of the…"}},{"name":"currency","in":"query","required":false,"description":"Filter invoices by currency. Possible values ISO 4217 currency codes.","schema":{"type":"string","description":"Filter invoices by currency. Possible values ISO 4217 currency codes."}},{"name":"payment_dispute_lost","in":"query","required":false,"description":"Filter invoices with a payment dispute lost. Possible values are `true` or `false`.","schema":{"type":"boolean","description":"Filter invoices with a payment dispute lost. Possible values are `true` or `false`."}},{"name":"partially_paid","in":"query","required":false,"description":"Filter invoices that are partially paid. When `true`, only invoices with a non-zero amount paid that is below the total due are returned.…","schema":{"type":"boolean","description":"Filter invoices that are partially paid. When `true`, only invoices with a non-zero amount paid that is below the total due are returned.…"}},{"name":"settlements[]","in":"query","required":false,"description":"Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note`…","schema":{"type":"array","description":"Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note`…"}},{"name":"invoice_type","in":"query","required":false,"description":"Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or…","schema":{"type":"string","enum":["subscription","add_on","credit","one_off","advance_charges","progressive_billing"],"description":"Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or…"}},{"name":"self_billed","in":"query","required":false,"description":"Filter invoices by self billed. Possible values are `true` or `false`.","schema":{"type":"boolean","description":"Filter invoices by self billed. Possible values are `true` or `false`."}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter invoices by billing entity codes. Possible values are the billing entity codes you have created.","schema":{"type":"array","description":"Filter invoices by billing entity codes. Possible values are the billing entity codes you have created."}},{"name":"metadata[key]","in":"query","required":false,"description":"Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing…","schema":{"type":"string","description":"Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing…"}},{"name":"purchase_order_number","in":"query","required":false,"description":"Filter by the invoice purchase order number. The match is exact but case-insensitive.","schema":{"type":"string","description":"Filter by the invoice purchase order number. The match is exact but case-insensitive."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-invoice":{"post":{"operationId":"payments_lago_create_invoice","summary":"Create a one-off invoice","description":"POST /invoices","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-invoice":{"get":{"operationId":"payments_lago_find_invoice","summary":"Retrieve an invoice","description":"GET /invoices/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-invoice":{"post":{"operationId":"payments_lago_update_invoice","summary":"Update an invoice","description":"PUT /invoices/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-invoice":{"post":{"operationId":"payments_lago_delete_invoice","summary":"Delete a draft invoice","description":"DELETE /invoices/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/download-invoice":{"post":{"operationId":"payments_lago_download_invoice","summary":"Download an invoice PDF","description":"POST /invoices/{lago_id}/download","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/finalize-invoice":{"post":{"operationId":"payments_lago_finalize_invoice","summary":"Finalize a draft invoice","description":"PUT /invoices/{lago_id}/finalize","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/lose-dispute-invoice":{"post":{"operationId":"payments_lago_lose_dispute_invoice","summary":"Mark an invoice payment dispute as lost","description":"POST /invoices/{lago_id}/lose_dispute","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/refresh-invoice":{"post":{"operationId":"payments_lago_refresh_invoice","summary":"Refresh a draft invoice","description":"PUT /invoices/{lago_id}/refresh","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/retry-invoice":{"post":{"operationId":"payments_lago_retry_invoice","summary":"Retry generation of a failed invoice","description":"POST /invoices/{lago_id}/retry","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/invoice-payment-url":{"post":{"operationId":"payments_lago_invoice_payment_url","summary":"Generate a payment URL","description":"POST /invoices/{lago_id}/payment_url","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/invoice-preview":{"post":{"operationId":"payments_lago_invoice_preview","summary":"Create an invoice preview","description":"POST /invoices/preview","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/retry-payment":{"post":{"operationId":"payments_lago_retry_payment","summary":"Retry an invoice payment","description":"POST /invoices/{lago_id}/retry_payment","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/void-invoice":{"post":{"operationId":"payments_lago_void_invoice","summary":"Void an invoice","description":"POST /invoices/{lago_id}/void","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-order-forms":{"get":{"operationId":"payments_lago_find_all_order_forms","summary":"List all order forms","description":"GET /order_forms","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"status[]","in":"query","required":false,"description":"Filter order forms by status. Possible values are `generated`, `signed`, `expired` and `voided`.","schema":{"type":"array","description":"Filter order forms by status. Possible values are `generated`, `signed`, `expired` and `voided`."}},{"name":"customer_id[]","in":"query","required":false,"description":"Filter order forms by the Lago identifiers of their customers.","schema":{"type":"array","description":"Filter order forms by the Lago identifiers of their customers."}},{"name":"number[]","in":"query","required":false,"description":"Filter order forms by their number, as assigned by Lago.","schema":{"type":"array","description":"Filter order forms by their number, as assigned by Lago."}},{"name":"quote_number[]","in":"query","required":false,"description":"Filter order forms by the number of the quote they come from.","schema":{"type":"array","description":"Filter order forms by the number of the quote they come from."}},{"name":"owner_id[]","in":"query","required":false,"description":"Filter order forms by the Lago identifiers of the users owning the quote they come from.","schema":{"type":"array","description":"Filter order forms by the Lago identifiers of the users owning the quote they come from."}},{"name":"search_term","in":"query","required":false,"description":"Search order forms by number.","schema":{"type":"string","description":"Search order forms by number."}},{"name":"created_at_from","in":"query","required":false,"description":"Filter order forms created from a specific date and time, in UTC (ISO 8601).","schema":{"type":"string","description":"Filter order forms created from a specific date and time, in UTC (ISO 8601)."}},{"name":"created_at_to","in":"query","required":false,"description":"Filter order forms created up to a specific date and time, in UTC (ISO 8601).","schema":{"type":"string","description":"Filter order forms created up to a specific date and time, in UTC (ISO 8601)."}},{"name":"expires_at_from","in":"query","required":false,"description":"Filter order forms expiring from a specific date and time, in UTC (ISO 8601). Order forms that never expire are excluded.","schema":{"type":"string","description":"Filter order forms expiring from a specific date and time, in UTC (ISO 8601). Order forms that never expire are excluded."}},{"name":"expires_at_to","in":"query","required":false,"description":"Filter order forms expiring up to a specific date and time, in UTC (ISO 8601). Order forms that never expire are excluded.","schema":{"type":"string","description":"Filter order forms expiring up to a specific date and time, in UTC (ISO 8601). Order forms that never expire are excluded."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-order-form":{"get":{"operationId":"payments_lago_find_order_form","summary":"Retrieve an order form","description":"GET /order_forms/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the order form within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the order form within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/mark-order-form-as-signed":{"post":{"operationId":"payments_lago_mark_order_form_as_signed","summary":"Mark an order form as signed","description":"POST /order_forms/{lago_id}/mark_as_signed","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the order form within the Lago application. This ID is exclusively created by Lago and serves as a unique…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/void-order-form":{"post":{"operationId":"payments_lago_void_order_form","summary":"Void an order form","description":"POST /order_forms/{lago_id}/void","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the order form within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-orders":{"get":{"operationId":"payments_lago_find_all_orders","summary":"List all orders","description":"GET /orders","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"status[]","in":"query","required":false,"description":"Filter orders by status. Possible values are `created`, `executed` and `failed`.","schema":{"type":"array","description":"Filter orders by status. Possible values are `created`, `executed` and `failed`."}},{"name":"order_type[]","in":"query","required":false,"description":"Filter orders by the order type of the quote they come from. Possible values are `subscription_creation`, `subscription_amendment` and…","schema":{"type":"array","description":"Filter orders by the order type of the quote they come from. Possible values are `subscription_creation`, `subscription_amendment` and…"}},{"name":"execution_mode[]","in":"query","required":false,"description":"Filter orders by execution mode. Possible values are `execute_in_lago` and `order_only`.","schema":{"type":"array","description":"Filter orders by execution mode. Possible values are `execute_in_lago` and `order_only`."}},{"name":"customer_id[]","in":"query","required":false,"description":"Filter orders by the Lago identifiers of their customers.","schema":{"type":"array","description":"Filter orders by the Lago identifiers of their customers."}},{"name":"number[]","in":"query","required":false,"description":"Filter orders by their number, as assigned by Lago.","schema":{"type":"array","description":"Filter orders by their number, as assigned by Lago."}},{"name":"order_form_number[]","in":"query","required":false,"description":"Filter orders by the number of the order form they come from.","schema":{"type":"array","description":"Filter orders by the number of the order form they come from."}},{"name":"quote_number[]","in":"query","required":false,"description":"Filter orders by the number of the quote they come from.","schema":{"type":"array","description":"Filter orders by the number of the quote they come from."}},{"name":"owner_id[]","in":"query","required":false,"description":"Filter orders by the Lago identifiers of the users owning the quote they come from.","schema":{"type":"array","description":"Filter orders by the Lago identifiers of the users owning the quote they come from."}},{"name":"search_term","in":"query","required":false,"description":"Search orders by number.","schema":{"type":"string","description":"Search orders by number."}},{"name":"executed_at_from","in":"query","required":false,"description":"Filter orders executed from a specific date and time, in UTC (ISO 8601). Orders that have not been executed are excluded.","schema":{"type":"string","description":"Filter orders executed from a specific date and time, in UTC (ISO 8601). Orders that have not been executed are excluded."}},{"name":"executed_at_to","in":"query","required":false,"description":"Filter orders executed up to a specific date and time, in UTC (ISO 8601). Orders that have not been executed are excluded.","schema":{"type":"string","description":"Filter orders executed up to a specific date and time, in UTC (ISO 8601). Orders that have not been executed are excluded."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-order":{"get":{"operationId":"payments_lago_find_order","summary":"Retrieve an order","description":"GET /orders/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the order within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the order within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/execute-order":{"post":{"operationId":"payments_lago_execute_order","summary":"Execute an order","description":"POST /orders/{lago_id}/execute","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the order within the Lago application. This ID is exclusively created by Lago and serves as a unique…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-organization":{"get":{"operationId":"payments_lago_find_organization","summary":"Retrieve your organization","description":"GET /organizations","tags":["payments"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-organization":{"post":{"operationId":"payments_lago_update_organization","summary":"Update your organization","description":"PUT /organizations","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-payment-receipts":{"get":{"operationId":"payments_lago_find_all_payment_receipts","summary":"List all payment receipts","description":"GET /payment_receipts","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"invoice_id","in":"query","required":false,"description":"Filter payment receipts by invoice. It returns the receipts of the payments made on this invoice, including the payments made through a…","schema":{"type":"string","description":"Filter payment receipts by invoice. It returns the receipts of the payments made on this invoice, including the payments made through a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-payment-receipt":{"get":{"operationId":"payments_lago_find_payment_receipt","summary":"Retrieve a payment receipt","description":"GET /payment_receipts/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier of the payment receipt.","schema":{"type":"string","description":"Unique identifier of the payment receipt."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-payment-requests":{"get":{"operationId":"payments_lago_find_all_payment_requests","summary":"List all payment requests","description":"GET /payment_requests","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"currency","in":"query","required":false,"description":"Filter the results by currency, expressed as an ISO 4217 code.","schema":{"type":"string","description":"Filter the results by currency, expressed as an ISO 4217 code."}},{"name":"external_customer_id","in":"query","required":false,"description":"Unique identifier assigned to the customer in your application.","schema":{"type":"string","description":"Unique identifier assigned to the customer in your application."}},{"name":"payment_status","in":"query","required":false,"description":"Filter by payment status. Possible values are `pending`, `failed` or `succeeded`.","schema":{"type":"string","enum":["pending","failed","succeeded"],"description":"Filter by payment status. Possible values are `pending`, `failed` or `succeeded`."}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter payment requests by billing entity codes.","schema":{"type":"array","description":"Filter payment requests by billing entity codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-payment-request":{"post":{"operationId":"payments_lago_create_payment_request","summary":"Create a payment request","description":"POST /payment_requests","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-payment-request":{"get":{"operationId":"payments_lago_find_payment_request","summary":"Retrieve a payment request","description":"GET /payment_requests/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier of the payment request.","schema":{"type":"string","description":"Unique identifier of the payment request."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-payments":{"get":{"operationId":"payments_lago_find_all_payments","summary":"List all payments","description":"GET /payments","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"external_customer_id","in":"query","required":false,"description":"Unique identifier assigned to the customer in your application.","schema":{"type":"string","description":"Unique identifier assigned to the customer in your application."}},{"name":"invoice_id","in":"query","required":false,"description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the invoice within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-payment":{"post":{"operationId":"payments_lago_create_payment","summary":"Create a payment","description":"POST /payments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-payment":{"get":{"operationId":"payments_lago_find_payment","summary":"Retrieve a payment","description":"GET /payments/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier of the payment.","schema":{"type":"string","description":"Unique identifier of the payment."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-plans":{"get":{"operationId":"payments_lago_find_all_plans","summary":"List all plans","description":"GET /plans","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-plan":{"post":{"operationId":"payments_lago_create_plan","summary":"Create a plan","description":"POST /plans","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-plan":{"get":{"operationId":"payments_lago_find_plan","summary":"Retrieve a plan","description":"GET /plans/{code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or…","schema":{"type":"string","description":"The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-plan":{"post":{"operationId":"payments_lago_update_plan","summary":"Update a plan","description":"PUT /plans/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-plan":{"post":{"operationId":"payments_lago_destroy_plan","summary":"Delete a plan","description":"DELETE /plans/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-entitlements":{"get":{"operationId":"payments_lago_find_all_entitlements","summary":"List all entitlements","description":"GET /plans/{code}/entitlements","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing plan.","schema":{"type":"string","description":"Code of the existing plan."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-entitlement":{"post":{"operationId":"payments_lago_create_entitlement","summary":"Create an entitlement","description":"POST /plans/{code}/entitlements","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/update-entitlement":{"post":{"operationId":"payments_lago_update_entitlement","summary":"Partial update of an entitlement","description":"PATCH /plans/{code}/entitlements","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-entitlement":{"get":{"operationId":"payments_lago_find_entitlement","summary":"Retrieve an entitlement","description":"GET /plans/{code}/entitlements/{feature_code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing plan.","schema":{"type":"string","description":"Code of the existing plan."}},{"name":"feature_code","in":"query","required":true,"description":"Code of the existing feature.","schema":{"type":"string","description":"Code of the existing feature."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-entitlement":{"post":{"operationId":"payments_lago_destroy_entitlement","summary":"Delete an entitlement","description":"DELETE /plans/{code}/entitlements/{feature_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","feature_code"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"feature_code":{"type":"string","description":"Code of the existing feature."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/remove-entitlement-privilege":{"post":{"operationId":"payments_lago_remove_entitlement_privilege","summary":"Remove a privilege from an entitlement","description":"DELETE /plans/{code}/entitlements/{feature_code}/privileges/{privilege_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","feature_code","privilege_code"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"feature_code":{"type":"string","description":"Code of the existing feature."},"privilege_code":{"type":"string","description":"Code of the privilege to remove from the entitlement."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/replace-plan-metadata":{"post":{"operationId":"payments_lago_replace_plan_metadata","summary":"Replace plan metadata","description":"POST /plans/{code}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"The code of the plan."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/merge-plan-metadata":{"post":{"operationId":"payments_lago_merge_plan_metadata","summary":"Merge plan metadata","description":"PATCH /plans/{code}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"The code of the plan."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-all-plan-metadata":{"post":{"operationId":"payments_lago_delete_all_plan_metadata","summary":"Delete all plan metadata","description":"DELETE /plans/{code}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"The code of the plan."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-plan-metadata-key":{"post":{"operationId":"payments_lago_delete_plan_metadata_key","summary":"Delete a metadata key","description":"DELETE /plans/{code}/metadata/{key}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","key"],"properties":{"code":{"type":"string","description":"The code of the plan."},"key":{"type":"string","description":"The metadata key to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-plan-charges":{"get":{"operationId":"payments_lago_find_all_plan_charges","summary":"List all charges for a plan","description":"GET /plans/{code}/charges","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing plan.","schema":{"type":"string","description":"Code of the existing plan."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-plan-charge":{"post":{"operationId":"payments_lago_create_plan_charge","summary":"Create a charge","description":"POST /plans/{code}/charges","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-plan-charge":{"get":{"operationId":"payments_lago_find_plan_charge","summary":"Retrieve a charge","description":"GET /plans/{code}/charges/{charge_code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing plan.","schema":{"type":"string","description":"Code of the existing plan."}},{"name":"charge_code","in":"query","required":true,"description":"Code of the existing charge.","schema":{"type":"string","description":"Code of the existing charge."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-plan-charge":{"post":{"operationId":"payments_lago_update_plan_charge","summary":"Update a charge","description":"PUT /plans/{code}/charges/{charge_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","charge_code","body"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"charge_code":{"type":"string","description":"Code of the existing charge."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-plan-charge":{"post":{"operationId":"payments_lago_destroy_plan_charge","summary":"Delete a charge","description":"DELETE /plans/{code}/charges/{charge_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","charge_code"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"charge_code":{"type":"string","description":"Code of the existing charge."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-plan-charge-filters":{"get":{"operationId":"payments_lago_find_all_plan_charge_filters","summary":"List all filters for a charge","description":"GET /plans/{code}/charges/{charge_code}/filters","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing plan.","schema":{"type":"string","description":"Code of the existing plan."}},{"name":"charge_code","in":"query","required":true,"description":"Code of the existing charge.","schema":{"type":"string","description":"Code of the existing charge."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-plan-charge-filter":{"post":{"operationId":"payments_lago_create_plan_charge_filter","summary":"Create a charge filter","description":"POST /plans/{code}/charges/{charge_code}/filters","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","charge_code","body"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"charge_code":{"type":"string","description":"Code of the existing charge."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-plan-charge-filter":{"get":{"operationId":"payments_lago_find_plan_charge_filter","summary":"Retrieve a charge filter","description":"GET /plans/{code}/charges/{charge_code}/filters/{filter_id}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing plan.","schema":{"type":"string","description":"Code of the existing plan."}},{"name":"charge_code","in":"query","required":true,"description":"Code of the existing charge.","schema":{"type":"string","description":"Code of the existing charge."}},{"name":"filter_id","in":"query","required":true,"description":"Unique identifier of the charge filter.","schema":{"type":"string","description":"Unique identifier of the charge filter."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-plan-charge-filter":{"post":{"operationId":"payments_lago_update_plan_charge_filter","summary":"Update a charge filter","description":"PUT /plans/{code}/charges/{charge_code}/filters/{filter_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","charge_code","filter_id","body"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"charge_code":{"type":"string","description":"Code of the existing charge."},"filter_id":{"type":"string","description":"Unique identifier of the charge filter."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-plan-charge-filter":{"post":{"operationId":"payments_lago_destroy_plan_charge_filter","summary":"Delete a charge filter","description":"DELETE /plans/{code}/charges/{charge_code}/filters/{filter_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","charge_code","filter_id"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"charge_code":{"type":"string","description":"Code of the existing charge."},"filter_id":{"type":"string","description":"Unique identifier of the charge filter."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-plan-fixed-charges":{"get":{"operationId":"payments_lago_find_all_plan_fixed_charges","summary":"List all fixed charges for a plan","description":"GET /plans/{code}/fixed_charges","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing plan.","schema":{"type":"string","description":"Code of the existing plan."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-plan-fixed-charge":{"post":{"operationId":"payments_lago_create_plan_fixed_charge","summary":"Create a fixed charge","description":"POST /plans/{code}/fixed_charges","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-plan-fixed-charge":{"get":{"operationId":"payments_lago_find_plan_fixed_charge","summary":"Retrieve a fixed charge","description":"GET /plans/{code}/fixed_charges/{fixed_charge_code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"Code of the existing plan.","schema":{"type":"string","description":"Code of the existing plan."}},{"name":"fixed_charge_code","in":"query","required":true,"description":"Code of the existing fixed charge.","schema":{"type":"string","description":"Code of the existing fixed charge."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-plan-fixed-charge":{"post":{"operationId":"payments_lago_update_plan_fixed_charge","summary":"Update a fixed charge","description":"PUT /plans/{code}/fixed_charges/{fixed_charge_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","fixed_charge_code","body"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"fixed_charge_code":{"type":"string","description":"Code of the existing fixed charge."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-plan-fixed-charge":{"post":{"operationId":"payments_lago_destroy_plan_fixed_charge","summary":"Delete a fixed charge","description":"DELETE /plans/{code}/fixed_charges/{fixed_charge_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","fixed_charge_code"],"properties":{"code":{"type":"string","description":"Code of the existing plan."},"fixed_charge_code":{"type":"string","description":"Code of the existing fixed charge."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-quotes":{"get":{"operationId":"payments_lago_find_all_quotes","summary":"List all quotes","description":"GET /quotes","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"status[]","in":"query","required":false,"description":"Filter quotes by the status of their current version. Possible values are `draft`, `approved` and `voided`.","schema":{"type":"array","description":"Filter quotes by the status of their current version. Possible values are `draft`, `approved` and `voided`."}},{"name":"order_type[]","in":"query","required":false,"description":"Filter quotes by order type. Possible values are `subscription_creation`, `subscription_amendment` and `one_off`.","schema":{"type":"array","description":"Filter quotes by order type. Possible values are `subscription_creation`, `subscription_amendment` and `one_off`."}},{"name":"number[]","in":"query","required":false,"description":"Filter quotes by their number, as assigned by Lago.","schema":{"type":"array","description":"Filter quotes by their number, as assigned by Lago."}},{"name":"owner_id[]","in":"query","required":false,"description":"Filter quotes by the Lago identifiers of the users owning them.","schema":{"type":"array","description":"Filter quotes by the Lago identifiers of the users owning them."}},{"name":"external_customer_id[]","in":"query","required":false,"description":"Filter quotes by the external unique identifiers of their customers (provided by your own application).","schema":{"type":"array","description":"Filter quotes by the external unique identifiers of their customers (provided by your own application)."}},{"name":"from_date","in":"query","required":false,"description":"Filter quotes created from a specific date.","schema":{"type":"string","description":"Filter quotes created from a specific date."}},{"name":"to_date","in":"query","required":false,"description":"Filter quotes created up to a specific date.","schema":{"type":"string","description":"Filter quotes created up to a specific date."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-quote":{"get":{"operationId":"payments_lago_find_quote","summary":"Retrieve a quote","description":"GET /quotes/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the quote within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the quote within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-quote-versions":{"get":{"operationId":"payments_lago_find_all_quote_versions","summary":"List all versions of a quote","description":"GET /quotes/{lago_id}/versions","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the quote within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the quote within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-quote-version":{"get":{"operationId":"payments_lago_find_quote_version","summary":"Retrieve a quote version","description":"GET /quote_versions/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the quote version within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the quote version within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/approve-quote-version":{"post":{"operationId":"payments_lago_approve_quote_version","summary":"Approve a quote version","description":"POST /quote_versions/{lago_id}/approve","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the quote version within the Lago application. This ID is exclusively created by Lago and serves as a unique…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/void-quote-version":{"post":{"operationId":"payments_lago_void_quote_version","summary":"Void a quote version","description":"POST /quote_versions/{lago_id}/void","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the quote version within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/clone-quote-version":{"post":{"operationId":"payments_lago_clone_quote_version","summary":"Clone a quote version","description":"POST /quote_versions/{lago_id}/clone","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the quote version within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-subscriptions":{"get":{"operationId":"payments_lago_find_all_subscriptions","summary":"List all subscriptions","description":"GET /subscriptions","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"currency","in":"query","required":false,"description":"Filter the results by currency, expressed as an ISO 4217 code.","schema":{"type":"string","description":"Filter the results by currency, expressed as an ISO 4217 code."}},{"name":"external_customer_id","in":"query","required":false,"description":"The customer external unique identifier (provided by your own application)","schema":{"type":"string","description":"The customer external unique identifier (provided by your own application)"}},{"name":"external_id","in":"query","required":false,"description":"Filter subscriptions by their external unique identifier (provided by your own application).","schema":{"type":"string","description":"Filter subscriptions by their external unique identifier (provided by your own application)."}},{"name":"plan_code","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"overridden","in":"query","required":false,"description":"When set, filters subscriptions by whether their plan is an override of a parent plan. `true` returns only subscriptions on overridden…","schema":{"type":"boolean","description":"When set, filters subscriptions by whether their plan is an override of a parent plan. `true` returns only subscriptions on overridden…"}},{"name":"status[]","in":"query","required":false,"description":"If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status…","schema":{"type":"array","description":"If the field is not defined, Lago will return only `active` subscriptions. However, if you wish to fetch subscriptions by different status…"}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter subscriptions by billing entity codes.","schema":{"type":"array","description":"Filter subscriptions by billing entity codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-subscription":{"post":{"operationId":"payments_lago_create_subscription","summary":"Assign a plan to a customer","description":"POST /subscriptions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-subscription":{"get":{"operationId":"payments_lago_find_subscription","summary":"Retrieve a subscription","description":"GET /subscriptions/{external_id}","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription","schema":{"type":"string","description":"External ID of the existing subscription"}},{"name":"status","in":"query","required":false,"description":"By default, this endpoint only returns `active` subscriptions. If you want to retrieve a subscription with a different `status`, you can…","schema":{"type":"string","enum":["active","terminated","pending","canceled","incomplete"],"default":"active","description":"By default, this endpoint only returns `active` subscriptions. If you want to retrieve a subscription with a different `status`, you can…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-subscription":{"post":{"operationId":"payments_lago_update_subscription","summary":"Update a subscription","description":"PUT /subscriptions/{external_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"status":{"type":"string","enum":["active","pending"],"default":"active","description":"By default, this endpoint only updates `active` subscriptions. If you want to update a subscription with a different `status`, you can…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-subscription":{"post":{"operationId":"payments_lago_destroy_subscription","summary":"Terminate a subscription","description":"DELETE /subscriptions/{external_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"status":{"type":"string","default":"active","description":"Selects which subscription to terminate for the given `external_id`, based on its status. If the field is not defined, Lago targets only…"},"on_termination_credit_note":{"type":"string","enum":["credit","refund","offset","skip"],"description":"When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused…"},"on_termination_invoice":{"type":"string","enum":["generate","skip"],"description":"When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage. This field allows…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/get-subscription-lifetime-usage":{"get":{"operationId":"payments_lago_get_subscription_lifetime_usage","summary":"Retrieve subscription lifetime usage","description":"GET /subscriptions/{external_id}/lifetime_usage","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription","schema":{"type":"string","description":"External ID of the existing subscription"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-subscription-lifetime-usage":{"post":{"operationId":"payments_lago_update_subscription_lifetime_usage","summary":"Update a subscription lifetime usage","description":"PUT /subscriptions/{external_id}/lifetime_usage","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/get-subscription-alerts":{"get":{"operationId":"payments_lago_get_subscription_alerts","summary":"List subscription alerts","description":"GET /subscriptions/{external_id}/alerts","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription","schema":{"type":"string","description":"External ID of the existing subscription"}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-subscription-alert":{"post":{"operationId":"payments_lago_create_subscription_alert","summary":"Create subscription alert(s)","description":"POST /subscriptions/{external_id}/alerts","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-all-subscription-alerts":{"post":{"operationId":"payments_lago_delete_all_subscription_alerts","summary":"Delete all subscription alerts","description":"DELETE /subscriptions/{external_id}/alerts","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/get-subscription-alert":{"get":{"operationId":"payments_lago_get_subscription_alert","summary":"Retrieve a subscription alert","description":"GET /subscriptions/{external_id}/alerts/{code}","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription","schema":{"type":"string","description":"External ID of the existing subscription"}},{"name":"code","in":"query","required":true,"description":"Unique code of the alert","schema":{"type":"string","description":"Unique code of the alert"}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-subscription-alert":{"post":{"operationId":"payments_lago_update_subscription_alert","summary":"Update a subscription alert","description":"PUT /subscriptions/{external_id}/alerts/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","code","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"code":{"type":"string","description":"Unique code of the alert"},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-subscription-alert":{"post":{"operationId":"payments_lago_delete_subscription_alert","summary":"Delete a subscription alert","description":"DELETE /subscriptions/{external_id}/alerts/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","code"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"code":{"type":"string","description":"Unique code of the alert"},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-subscription-entitlements":{"get":{"operationId":"payments_lago_find_all_subscription_entitlements","summary":"List all subscription entitlements","description":"GET /subscriptions/{external_id}/entitlements","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription","schema":{"type":"string","description":"External ID of the existing subscription"}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-subscription-entitlements":{"post":{"operationId":"payments_lago_update_subscription_entitlements","summary":"Update subscription entitlements","description":"PATCH /subscriptions/{external_id}/entitlements","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-subscription-entitlement":{"post":{"operationId":"payments_lago_destroy_subscription_entitlement","summary":"Remove an entitlement from a subscription","description":"DELETE /subscriptions/{external_id}/entitlements/{feature_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","feature_code"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"feature_code":{"type":"string","description":"Code of the existing feature"},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-subscription-entitlement-privilege":{"post":{"operationId":"payments_lago_destroy_subscription_entitlement_privilege","summary":"Remove a privilege from a subscription entitlement override","description":"DELETE /subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","feature_code","privilege_code"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription"},"feature_code":{"type":"string","description":"Code of the existing feature."},"privilege_code":{"type":"string","description":"Code of the privilege to remove from the subscription entitlement override."},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-subscription-fixed-charges":{"get":{"operationId":"payments_lago_find_all_subscription_fixed_charges","summary":"List all fixed charges for a subscription","description":"GET /subscriptions/{external_id}/fixed_charges","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription.","schema":{"type":"string","description":"External ID of the existing subscription."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-subscription-charges":{"get":{"operationId":"payments_lago_find_all_subscription_charges","summary":"List all charges for a subscription","description":"GET /subscriptions/{external_id}/charges","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription.","schema":{"type":"string","description":"External ID of the existing subscription."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-subscription-charge":{"get":{"operationId":"payments_lago_find_subscription_charge","summary":"Retrieve a charge for a subscription","description":"GET /subscriptions/{external_id}/charges/{charge_code}","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription.","schema":{"type":"string","description":"External ID of the existing subscription."}},{"name":"charge_code","in":"query","required":true,"description":"Code of the existing charge.","schema":{"type":"string","description":"Code of the existing charge."}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/override-subscription-charge":{"post":{"operationId":"payments_lago_override_subscription_charge","summary":"Override a charge for a subscription","description":"PUT /subscriptions/{external_id}/charges/{charge_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","charge_code","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription."},"charge_code":{"type":"string","description":"Code of the existing charge."},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-subscription-charge-filters":{"get":{"operationId":"payments_lago_find_all_subscription_charge_filters","summary":"List all filters for a charge","description":"GET /subscriptions/{external_id}/charges/{charge_code}/filters","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription.","schema":{"type":"string","description":"External ID of the existing subscription."}},{"name":"charge_code","in":"query","required":true,"description":"Code of the existing charge.","schema":{"type":"string","description":"Code of the existing charge."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-subscription-charge-filter":{"post":{"operationId":"payments_lago_create_subscription_charge_filter","summary":"Create a charge filter","description":"POST /subscriptions/{external_id}/charges/{charge_code}/filters","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","charge_code","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription."},"charge_code":{"type":"string","description":"Code of the existing charge."},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-subscription-charge-filter":{"get":{"operationId":"payments_lago_find_subscription_charge_filter","summary":"Retrieve a charge filter","description":"GET /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription.","schema":{"type":"string","description":"External ID of the existing subscription."}},{"name":"charge_code","in":"query","required":true,"description":"Code of the existing charge.","schema":{"type":"string","description":"Code of the existing charge."}},{"name":"filter_id","in":"query","required":true,"description":"Unique identifier of the charge filter.","schema":{"type":"string","description":"Unique identifier of the charge filter."}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-subscription-charge-filter":{"post":{"operationId":"payments_lago_update_subscription_charge_filter","summary":"Update a charge filter","description":"PUT /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","charge_code","filter_id","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription."},"charge_code":{"type":"string","description":"Code of the existing charge."},"filter_id":{"type":"string","description":"Unique identifier of the charge filter."},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-subscription-charge-filter":{"post":{"operationId":"payments_lago_destroy_subscription_charge_filter","summary":"Delete a charge filter","description":"DELETE /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","charge_code","filter_id"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription."},"charge_code":{"type":"string","description":"Code of the existing charge."},"filter_id":{"type":"string","description":"Unique identifier of the charge filter."},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-subscription-fixed-charge":{"get":{"operationId":"payments_lago_find_subscription_fixed_charge","summary":"Retrieve a fixed charge for a subscription","description":"GET /subscriptions/{external_id}/fixed_charges/{fixed_charge_code}","tags":["payments"],"parameters":[{"name":"external_id","in":"query","required":true,"description":"External ID of the existing subscription.","schema":{"type":"string","description":"External ID of the existing subscription."}},{"name":"fixed_charge_code","in":"query","required":true,"description":"Code of the existing fixed charge.","schema":{"type":"string","description":"Code of the existing fixed charge."}},{"name":"subscription_status","in":"query","required":false,"description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…","schema":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/override-subscription-fixed-charge":{"post":{"operationId":"payments_lago_override_subscription_fixed_charge","summary":"Override a fixed charge for a subscription","description":"PUT /subscriptions/{external_id}/fixed_charges/{fixed_charge_code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["external_id","fixed_charge_code","body"],"properties":{"external_id":{"type":"string","description":"External ID of the existing subscription."},"fixed_charge_code":{"type":"string","description":"Code of the existing fixed charge."},"subscription_status":{"type":"string","enum":["pending","active","terminated","canceled","incomplete"],"default":"active","description":"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-taxes":{"get":{"operationId":"payments_lago_find_all_taxes","summary":"List all taxes","description":"GET /taxes","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-tax":{"post":{"operationId":"payments_lago_create_tax","summary":"Create a tax","description":"POST /taxes","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-tax":{"get":{"operationId":"payments_lago_find_tax","summary":"Retrieve a tax","description":"GET /taxes/{code}","tags":["payments"],"parameters":[{"name":"code","in":"query","required":true,"description":"The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or…","schema":{"type":"string","description":"The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-tax":{"post":{"operationId":"payments_lago_update_tax","summary":"Update a tax","description":"PUT /taxes/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","body"],"properties":{"code":{"type":"string","description":"The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-tax":{"post":{"operationId":"payments_lago_destroy_tax","summary":"Delete a tax","description":"DELETE /taxes/{code}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"The code of the tax. It serves as a unique identifier associated with a particular tax. The code is typically used for internal or…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-wallets":{"get":{"operationId":"payments_lago_find_all_wallets","summary":"List all wallets","description":"GET /wallets","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"currency","in":"query","required":false,"description":"Filter the results by currency, expressed as an ISO 4217 code.","schema":{"type":"string","description":"Filter the results by currency, expressed as an ISO 4217 code."}},{"name":"external_customer_id","in":"query","required":false,"description":"Filter wallets by customer external unique identifier (provided by your own application). When omitted, all wallets for the organization…","schema":{"type":"string","description":"Filter wallets by customer external unique identifier (provided by your own application). When omitted, all wallets for the organization…"}},{"name":"billing_entity_codes[]","in":"query","required":false,"description":"Filter wallets by billing entity codes.","schema":{"type":"array","description":"Filter wallets by billing entity codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-wallet":{"post":{"operationId":"payments_lago_create_wallet","summary":"Create a wallet","description":"POST /wallets","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-wallet":{"get":{"operationId":"payments_lago_find_wallet","summary":"Retrieve a wallet","description":"GET /wallets/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-wallet":{"post":{"operationId":"payments_lago_update_wallet","summary":"Update a wallet","description":"PUT /wallets/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-wallet":{"post":{"operationId":"payments_lago_destroy_wallet","summary":"Terminate a wallet","description":"DELETE /wallets/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/replace-wallet-metadata":{"post":{"operationId":"payments_lago_replace_wallet_metadata","summary":"Replace wallet metadata","description":"POST /wallets/{lago_id}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the wallet within the Lago application."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/merge-wallet-metadata":{"post":{"operationId":"payments_lago_merge_wallet_metadata","summary":"Merge wallet metadata","description":"PATCH /wallets/{lago_id}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the wallet within the Lago application."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-all-wallet-metadata":{"post":{"operationId":"payments_lago_delete_all_wallet_metadata","summary":"Delete all wallet metadata","description":"DELETE /wallets/{lago_id}/metadata","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the wallet within the Lago application."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/delete-wallet-metadata-key":{"post":{"operationId":"payments_lago_delete_wallet_metadata_key","summary":"Delete a metadata key","description":"DELETE /wallets/{lago_id}/metadata/{key}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","key"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the wallet within the Lago application."},"key":{"type":"string","description":"The metadata key to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/create-wallet-transaction":{"post":{"operationId":"payments_lago_create_wallet_transaction","summary":"Top up a wallet","description":"POST /wallet_transactions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-wallet-transaction":{"get":{"operationId":"payments_lago_find_wallet_transaction","summary":"Retrieve a wallet transaction","description":"GET /wallet_transactions/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a…","schema":{"type":"string","description":"Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/wallet-transaction-payment-url":{"post":{"operationId":"payments_lago_wallet_transaction_payment_url","summary":"Generate a payment URL","description":"POST /wallet_transactions/{lago_id}/payment_url","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"ID of the wallet transaction."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-wallet-transaction-consumptions":{"get":{"operationId":"payments_lago_find_all_wallet_transaction_consumptions","summary":"List all consumptions for a wallet transaction","description":"GET /wallet_transactions/{lago_id}/consumptions","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the wallet transaction within the Lago application. Must be an inbound wallet transaction.","schema":{"type":"string","description":"Unique identifier assigned to the wallet transaction within the Lago application. Must be an inbound wallet transaction."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-wallet-transaction-fundings":{"get":{"operationId":"payments_lago_find_all_wallet_transaction_fundings","summary":"List all fundings for a wallet transaction","description":"GET /wallet_transactions/{lago_id}/fundings","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the wallet transaction within the Lago application. Must be an outbound wallet transaction.","schema":{"type":"string","description":"Unique identifier assigned to the wallet transaction within the Lago application. Must be an outbound wallet transaction."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-wallet-transactions":{"get":{"operationId":"payments_lago_find_all_wallet_transactions","summary":"List all wallet transactions","description":"GET /wallets/{lago_id}/wallet_transactions","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique…","schema":{"type":"string","description":"Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique…"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}},{"name":"status","in":"query","required":false,"description":"The status of the wallet transaction. Possible values are `pending`, `settled` or `failed`.","schema":{"type":"string","description":"The status of the wallet transaction. Possible values are `pending`, `settled` or `failed`."}},{"name":"transaction_status","in":"query","required":false,"description":"The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without…","schema":{"type":"string","description":"The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without…"}},{"name":"transaction_type","in":"query","required":false,"description":"The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing…","schema":{"type":"string","description":"The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing…"}},{"name":"metadata[key]","in":"query","required":false,"description":"Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value.…","schema":{"type":"string","description":"Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/fetch-json-public-key":{"get":{"operationId":"payments_lago_fetch_json_public_key","summary":"Retrieve webhook public key (JSON)","description":"GET /webhooks/json_public_key","tags":["payments"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/find-all-webhook-endpoints":{"get":{"operationId":"payments_lago_find_all_webhook_endpoints","summary":"List all webhook endpoints","description":"GET /webhook_endpoints","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","description":"Page number."}},{"name":"per_page","in":"query","required":false,"description":"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`.","schema":{"type":"integer","description":"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`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/create-webhook-endpoint":{"post":{"operationId":"payments_lago_create_webhook_endpoint","summary":"Create a webhook endpoint","description":"POST /webhook_endpoints","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/find-webhook-endpoint":{"get":{"operationId":"payments_lago_find_webhook_endpoint","summary":"Retrieve a webhook endpoint","description":"GET /webhook_endpoints/{lago_id}","tags":["payments"],"parameters":[{"name":"lago_id","in":"query","required":true,"description":"Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a…","schema":{"type":"string","description":"Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:lago/update-webhook-endpoint":{"post":{"operationId":"payments_lago_update_webhook_endpoint","summary":"Update a webhook endpoint","description":"PUT /webhook_endpoints/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id","body"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:lago/destroy-webhook-endpoint":{"post":{"operationId":"payments_lago_destroy_webhook_endpoint","summary":"Delete a webhook endpoint","description":"DELETE /webhook_endpoints/{lago_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["lago_id"],"properties":{"lago_id":{"type":"string","description":"Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}