diff --git a/docs/reference/lago_add-ons_create.md b/docs/reference/lago_add-ons_create.md index 13d21d8..8bfb136 100644 --- a/docs/reference/lago_add-ons_create.md +++ b/docs/reference/lago_add-ons_create.md @@ -21,7 +21,7 @@ lago add-ons create [flags] ``` --amount-cents string The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value. - --amount-currency string The currency of the add-on.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --amount-currency string The currency of the add-on.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --code string Unique code used to identify the add-on. --description string The description of the add-on. -h, --help help for create diff --git a/docs/reference/lago_add-ons_update.md b/docs/reference/lago_add-ons_update.md index e34c60e..57d47f3 100644 --- a/docs/reference/lago_add-ons_update.md +++ b/docs/reference/lago_add-ons_update.md @@ -21,7 +21,7 @@ lago add-ons update [flags] ``` --amount-cents string The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value. - --amount-currency string The currency of the add-on.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --amount-currency string The currency of the add-on.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --code string Unique code used to identify the add-on. --description string The description of the add-on. -h, --help help for update diff --git a/docs/reference/lago_analytics_gross-revenue.md b/docs/reference/lago_analytics_gross-revenue.md index adfa003..9800e40 100644 --- a/docs/reference/lago_analytics_gross-revenue.md +++ b/docs/reference/lago_analytics_gross-revenue.md @@ -19,7 +19,7 @@ lago analytics gross-revenue [flags] ### Options ``` - --currency string Currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string Currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --external-customer-id string The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. -h, --help help for gross-revenue --months string Show data only for given number of months. diff --git a/docs/reference/lago_analytics_invoice-collection.md b/docs/reference/lago_analytics_invoice-collection.md index 05e4730..8f29e75 100644 --- a/docs/reference/lago_analytics_invoice-collection.md +++ b/docs/reference/lago_analytics_invoice-collection.md @@ -19,7 +19,7 @@ lago analytics invoice-collection [flags] ### Options ``` - --currency string The currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string The currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW -h, --help help for invoice-collection --months string Show data only for given number of months. --watch Poll and re-render when the response changes diff --git a/docs/reference/lago_analytics_invoiced-usage.md b/docs/reference/lago_analytics_invoiced-usage.md index 461cfca..26d4df4 100644 --- a/docs/reference/lago_analytics_invoiced-usage.md +++ b/docs/reference/lago_analytics_invoiced-usage.md @@ -19,7 +19,7 @@ lago analytics invoiced-usage [flags] ### Options ``` - --currency string The currency of invoiced usage analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string The currency of invoiced usage analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW -h, --help help for invoiced-usage --months string Show data only for given number of months. --watch Poll and re-render when the response changes diff --git a/docs/reference/lago_analytics_mrr.md b/docs/reference/lago_analytics_mrr.md index c8c272d..8002a93 100644 --- a/docs/reference/lago_analytics_mrr.md +++ b/docs/reference/lago_analytics_mrr.md @@ -25,7 +25,7 @@ lago analytics mrr [flags] - Revenue from 'quarterly' subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing). - Revenue from 'yearly' subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). - Revenue from 'semiannual' subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). - - Revenue from 'weekly' subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + - Revenue from 'weekly' subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW -h, --help help for mrr --months string Show data only for given number of months. --watch Poll and re-render when the response changes diff --git a/docs/reference/lago_analytics_overdue-balance.md b/docs/reference/lago_analytics_overdue-balance.md index 18ebb32..a838099 100644 --- a/docs/reference/lago_analytics_overdue-balance.md +++ b/docs/reference/lago_analytics_overdue-balance.md @@ -19,7 +19,7 @@ lago analytics overdue-balance [flags] ### Options ``` - --currency string Currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string Currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --external-customer-id string The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level. -h, --help help for overdue-balance --months string Show data only for given number of months. diff --git a/docs/reference/lago_analytics_usage.md b/docs/reference/lago_analytics_usage.md index 6476ad9..9c0639e 100644 --- a/docs/reference/lago_analytics_usage.md +++ b/docs/reference/lago_analytics_usage.md @@ -20,7 +20,7 @@ lago analytics usage [flags] ``` --billable-metric-code string The code of the usage-based billable metrics for which the usage analytics is calculated. - --currency string The currency of usage analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string The currency of usage analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --customer-country string The country of the customer for which the usage analytics is calculated.; one of: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW --customer-type string The type of customer for which the usage analytics is calculated. Possible values are 'individual', 'company'.; one of: individual, company --external-customer-id string The external identifier of the customer for which the usage analytics is calculated. diff --git a/docs/reference/lago_billing-entities_create.md b/docs/reference/lago_billing-entities_create.md index 442365a..009dacb 100644 --- a/docs/reference/lago_billing-entities_create.md +++ b/docs/reference/lago_billing-entities_create.md @@ -30,7 +30,7 @@ lago billing-entities create [flags] --city string The city of the billing address --code string The unique code of the billing entity --country string The country code of the billing address; one of: , AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW - --default-currency string The default currency of the billing entity; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --default-currency string The default currency of the billing entity; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --document-number-prefix string The prefix used in document numbers for this billing entity --document-numbering string The type of document numbering for this billing entity: - 'per_customer': document numbers are unique per customer diff --git a/docs/reference/lago_billing-entities_update.md b/docs/reference/lago_billing-entities_update.md index 1759ce4..6e10afe 100644 --- a/docs/reference/lago_billing-entities_update.md +++ b/docs/reference/lago_billing-entities_update.md @@ -29,7 +29,7 @@ lago billing-entities update [flags] --billing-configuration-subscription-invoice-issuing-date-anchor string Defines whether the issuing date follows the current billing period's end date or the next period starting date.; one of: current_period_end, next_period_start --city string The city of the billing address --country string The country code of the billing address; one of: , AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW - --default-currency string The default currency of the billing entity; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --default-currency string The default currency of the billing entity; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --document-number-prefix string The prefix used in document numbers for this billing entity --document-numbering string The type of document numbering for this billing entity: - 'per_customer': document numbers are unique per customer diff --git a/docs/reference/lago_coupons_apply.md b/docs/reference/lago_coupons_apply.md index feb3512..abd7d6f 100644 --- a/docs/reference/lago_coupons_apply.md +++ b/docs/reference/lago_coupons_apply.md @@ -21,7 +21,7 @@ lago coupons apply [flags] ``` --amount-cents string The amount of the coupon in cents. This field is required only for coupon with 'fixed_amount' type. - --amount-currency string The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --amount-currency string The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --coupon-code string Unique code used to identify the coupon. --external-customer-id string The customer external unique identifier (provided by your own application) --frequency string The type of frequency for the coupon. It can have three possible values: 'once', 'recurring' or 'forever'. diff --git a/docs/reference/lago_coupons_create.md b/docs/reference/lago_coupons_create.md index 7a1cb3e..2018ecd 100644 --- a/docs/reference/lago_coupons_create.md +++ b/docs/reference/lago_coupons_create.md @@ -21,7 +21,7 @@ lago coupons create [flags] ``` --amount-cents string The amount of the coupon in cents. This field is required only for coupon with 'fixed_amount' type. - --amount-currency string The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --amount-currency string The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --applies-to-billable-metric-codes string An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only. --applies-to-plan-codes string An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only. --code string Unique code used to identify the coupon. diff --git a/docs/reference/lago_coupons_update.md b/docs/reference/lago_coupons_update.md index 2cd2496..44c5475 100644 --- a/docs/reference/lago_coupons_update.md +++ b/docs/reference/lago_coupons_update.md @@ -21,7 +21,7 @@ lago coupons update [flags] ``` --amount-cents string The amount of the coupon in cents. This field is required only for coupon with 'fixed_amount' type. - --amount-currency string The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --amount-currency string The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --applies-to-billable-metric-codes string An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only. --applies-to-plan-codes string An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only. --code string Unique code used to identify the coupon. diff --git a/docs/reference/lago_customers_create.md b/docs/reference/lago_customers_create.md index 24bacdf..5bd70d2 100644 --- a/docs/reference/lago_customers_create.md +++ b/docs/reference/lago_customers_create.md @@ -41,7 +41,7 @@ lago customers create [flags] --billing-entity-code string The unique code of the billing entity to associate with the customer. If not provided, the default billing entity will be used. --city string The city of the customer's billing address --country string Country code of the customer's billing address. Format must be ISO 3166 (alpha-2); one of: , AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW - --currency string Currency of the customer. Format must be ISO 4217; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string Currency of the customer. Format must be ISO 4217; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --customer-type string The type of the customer. It can have one of the following values: - 'company': the customer is a company. - 'individual': the customer is an individual.; one of: company, individual, diff --git a/docs/reference/lago_customers_payment-requests.md b/docs/reference/lago_customers_payment-requests.md index 63c60a1..ce417ef 100644 --- a/docs/reference/lago_customers_payment-requests.md +++ b/docs/reference/lago_customers_payment-requests.md @@ -21,6 +21,7 @@ lago customers payment-requests [flags] ``` --all Fetch every page --billing-entity-codes string Filter payment requests by billing entity codes. + --currency string Filter the results by currency, expressed as an ISO 4217 code. -h, --help help for payment-requests --limit string Results per page (1-1000) --page string Page number. diff --git a/docs/reference/lago_customers_subscriptions.md b/docs/reference/lago_customers_subscriptions.md index f511430..9503b98 100644 --- a/docs/reference/lago_customers_subscriptions.md +++ b/docs/reference/lago_customers_subscriptions.md @@ -21,6 +21,7 @@ lago customers subscriptions [flags] ``` --all Fetch every page --billing-entity-codes string Filter subscriptions by billing entity codes. + --external-id string The subscription external unique identifier (provided by your own application). -h, --help help for subscriptions --limit string Results per page (1-1000) --page string Page number. diff --git a/docs/reference/lago_fees_list.md b/docs/reference/lago_fees_list.md index 2e6cde9..6813a75 100644 --- a/docs/reference/lago_fees_list.md +++ b/docs/reference/lago_fees_list.md @@ -23,7 +23,7 @@ lago fees list [flags] --billable-metric-code string Filter results by the 'code' of the billable metric attached to the fee. Only applies to 'charge' types. --created-at-from string Filter results created at or after this date and time in UTC. --created-at-to string Filter results created at or before this date and time in UTC. - --currency string Filter results by the fee's currency.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string Filter results by the fee's currency.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --event-transaction-id string Filter results by event transaction ID --external-customer-id string Unique identifier assigned to the customer in your application. --external-subscription-id string External subscription ID diff --git a/docs/reference/lago_invoices_create.md b/docs/reference/lago_invoices_create.md index ee117b0..6c57cd4 100644 --- a/docs/reference/lago_invoices_create.md +++ b/docs/reference/lago_invoices_create.md @@ -21,7 +21,7 @@ lago invoices create [flags] ``` --billing-entity-code string The code of the billing entity to issue the invoice from. If not provided, the customer's billing entity is used. - --currency string The currency of the invoice.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string The currency of the invoice.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --external-customer-id string Unique identifier assigned to the customer in your application. --fees string API field (array) -h, --help help for create diff --git a/docs/reference/lago_invoices_preview.md b/docs/reference/lago_invoices_preview.md index cf1eada..9458151 100644 --- a/docs/reference/lago_invoices_preview.md +++ b/docs/reference/lago_invoices_preview.md @@ -26,7 +26,7 @@ lago invoices preview [flags] --city string The city of the customer's billing address --country string Country code of the customer's billing address. Format must be ISO 3166 (alpha-2); one of: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW --coupons string API field (array) - --currency string The currency of the invoice.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string The currency of the invoice.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --external-id string Unique identifier assigned to the customer in your application. -h, --help help for preview --input string Complete JSON request body or @file.json diff --git a/docs/reference/lago_organizations_update.md b/docs/reference/lago_organizations_update.md index 097c4a6..be73d46 100644 --- a/docs/reference/lago_organizations_update.md +++ b/docs/reference/lago_organizations_update.md @@ -27,7 +27,7 @@ lago organizations update [flags] --billing-configuration-invoice-grace-period string The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer's grace period. --city string The city of your organization's billing address. --country string The country of your organization.; one of: , AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW - --default-currency string The default currency of an organization.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --default-currency string The default currency of an organization.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --document-number-prefix string Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago. --document-numbering string This parameter configures the method of incrementing invoice numbers for your customers. diff --git a/docs/reference/lago_payment-methods_payment-method-set-as-default.md b/docs/reference/lago_payment-methods_payment-method-set-as-default.md index beb1116..2b07870 100644 --- a/docs/reference/lago_payment-methods_payment-method-set-as-default.md +++ b/docs/reference/lago_payment-methods_payment-method-set-as-default.md @@ -4,7 +4,7 @@ Set the payment method as default ### Synopsis -Use the payment method as default when not selected a payment method +This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset. ``` lago payment-methods payment-method-set-as-default [flags] diff --git a/docs/reference/lago_payment-requests_create.md b/docs/reference/lago_payment-requests_create.md index 2850dd3..4332510 100644 --- a/docs/reference/lago_payment-requests_create.md +++ b/docs/reference/lago_payment-requests_create.md @@ -20,7 +20,7 @@ lago payment-requests create [flags] ### Options ``` - --email string The customer's email address used for sending dunning notifications + --email string The email address used for sending dunning notifications. When omitted, the customer's own email address is used. --external-customer-id string The customer external unique identifier (provided by your own application) -h, --help help for create --input string Complete JSON request body or @file.json diff --git a/docs/reference/lago_plans_create.md b/docs/reference/lago_plans_create.md index e78aff7..d1f9090 100644 --- a/docs/reference/lago_plans_create.md +++ b/docs/reference/lago_plans_create.md @@ -21,7 +21,7 @@ lago plans create [flags] ``` --amount-cents string The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. - --amount-currency string The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --amount-currency string The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --bill-charges-monthly string This field, when set to 'true', enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is 'yearly' or 'semiannual'. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is 'yearly' or 'semiannual'. --bill-fixed-charges-monthly string This field, when set to 'true', enables to invoice fixed charges on monthly basis, even if the cadence of the plan is 'yearly' or 'semiannual'. This allows customers to pay fixed charges on a monthly basis. This can be set to true only if the plan's interval is 'yearly' or 'semiannual'. --charges string Additional usage-based charges for this plan. diff --git a/docs/reference/lago_plans_update.md b/docs/reference/lago_plans_update.md index cdd55fd..72271df 100644 --- a/docs/reference/lago_plans_update.md +++ b/docs/reference/lago_plans_update.md @@ -21,7 +21,7 @@ lago plans update [flags] ``` --amount-cents string The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. - --amount-currency string The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --amount-currency string The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --bill-charges-monthly string This field, when set to 'true', enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly or semiannual. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is 'yearly' or 'semiannual'. --bill-fixed-charges-monthly string This field, when set to 'true', enables to invoice fixed charges on monthly basis, even if the cadence of the plan is 'yearly' or 'semiannual'. This allows customers to pay fixed charges on a monthly basis. This can be set to true only if the plan's interval is 'yearly' or 'semiannual'. --cascade-updates string This field determines whether the changes made to the plan should be cascaded to the children plans. When set to 'true', the changes will be cascaded into children. Conversely, when set to 'false', the changes will only be applied to the plan itself. If not defined in the request, default value is 'false'. diff --git a/docs/reference/lago_subscriptions_alerts.md b/docs/reference/lago_subscriptions_alerts.md index 8e20dfa..6ef2f91 100644 --- a/docs/reference/lago_subscriptions_alerts.md +++ b/docs/reference/lago_subscriptions_alerts.md @@ -19,7 +19,11 @@ lago subscriptions alerts [flags] ### Options ``` + --all Fetch every page -h, --help help for alerts + --limit string Results per page (1-1000) + --page string Page number. + --per-page string Number of records per page. --subscription-status string Filter by subscription status. When provided, the subscription is looked up with this status instead of the default 'active' status. Possible values are 'pending', 'active', 'terminated', or 'canceled'.; one of: pending, active, terminated, canceled --watch Poll and re-render when the response changes --watch-interval duration Polling interval used with --watch (default 2s) diff --git a/docs/reference/lago_subscriptions_create.md b/docs/reference/lago_subscriptions_create.md index 63cb978..cc0d26e 100644 --- a/docs/reference/lago_subscriptions_create.md +++ b/docs/reference/lago_subscriptions_create.md @@ -41,7 +41,7 @@ lago subscriptions create [flags] --payment-method-payment-method-type string The type of payment method to use.; one of: provider, manual --plan-code string 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 plans. --plan-overrides-amount-cents string The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. - --plan-overrides-amount-currency string The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --plan-overrides-amount-currency string The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --plan-overrides-charges string Additional usage-based charges for this plan. --plan-overrides-description string The description on the plan. --plan-overrides-fixed-charges string Fixed charge overrides for the subscription. When 'plan_overrides' contains only 'fixed_charges' and every entry contains only 'id', 'units', and optionally 'apply_units_immediately', the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or 'plan_overrides' contains any other key, the request is applied as a full plan override for the subscription instead. diff --git a/docs/reference/lago_subscriptions_update.md b/docs/reference/lago_subscriptions_update.md index bbf8be6..a54921c 100644 --- a/docs/reference/lago_subscriptions_update.md +++ b/docs/reference/lago_subscriptions_update.md @@ -35,7 +35,7 @@ lago subscriptions update [flags] --payment-method-payment-method-id string The unique identifier of the payment method (required when using a specific provider payment method). --payment-method-payment-method-type string The type of payment method to use.; one of: provider, manual --plan-overrides-amount-cents string The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan. - --plan-overrides-amount-currency string The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --plan-overrides-amount-currency string The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --plan-overrides-charges string Additional usage-based charges for this plan. --plan-overrides-description string The description on the plan. --plan-overrides-fixed-charges string Fixed charge overrides for the subscription. When 'plan_overrides' contains only 'fixed_charges' and every entry contains only 'id', 'units', and optionally 'apply_units_immediately', the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or 'plan_overrides' contains any other key, the request is applied as a full plan override for the subscription instead. diff --git a/docs/reference/lago_wallets_create-customer-wallet.md b/docs/reference/lago_wallets_create-customer-wallet.md index 1235e4a..f6ab6e5 100644 --- a/docs/reference/lago_wallets_create-customer-wallet.md +++ b/docs/reference/lago_wallets_create-customer-wallet.md @@ -24,7 +24,7 @@ lago wallets create-customer-wallet [flags] --applies-to-fee-types string An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only. --billing-entity-code string The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used. --code string The code of the wallet. - --currency string The currency of the wallet.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string The currency of the wallet.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --expiration-at string The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). --external-customer-id string The customer external unique identifier (provided by your own application) --granted-credits string The number of free granted credits. Required only if there is no paid credits. @@ -47,6 +47,7 @@ lago wallets create-customer-wallet [flags] --recurring-transaction-rules string List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. --transaction-metadata string This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process. --transaction-name string The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either 'Prepaid credits - {{wallet_name}}' if the wallet name is set, or 'Prepaid credits'. + --transaction-priority string The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. ``` ### Options inherited from parent commands diff --git a/docs/reference/lago_wallets_create-wallet-transaction.md b/docs/reference/lago_wallets_create-wallet-transaction.md index 4145515..d9d282f 100644 --- a/docs/reference/lago_wallets_create-wallet-transaction.md +++ b/docs/reference/lago_wallets_create-wallet-transaction.md @@ -34,8 +34,10 @@ lago wallets create-wallet-transaction [flags] --paid-credits string The number of paid credits. --payment-method-payment-method-id string The unique identifier of the payment method (required when using a specific provider payment method). --payment-method-payment-method-type string The type of payment method to use.; one of: provider, manual + --priority string The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. --purchase-order-number string The purchase order number associated with this wallet transaction. It will be added to invoices generated for the resulting wallet top-up. If not set, falls back to the wallet's 'purchase_order_number'. --voided-credits string The number of voided credits. + --voided-transaction-id string Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount. --wallet-id string Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system. ``` diff --git a/docs/reference/lago_wallets_create.md b/docs/reference/lago_wallets_create.md index 96f20b1..32bb229 100644 --- a/docs/reference/lago_wallets_create.md +++ b/docs/reference/lago_wallets_create.md @@ -24,7 +24,7 @@ lago wallets create [flags] --applies-to-fee-types string An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only. --billing-entity-code string The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used. --code string The code of the wallet. - --currency string The currency of the wallet.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + --currency string The currency of the wallet.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW --expiration-at string The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). --external-customer-id string The customer external unique identifier (provided by your own application) --granted-credits string The number of free granted credits. Required only if there is no paid credits. @@ -47,6 +47,7 @@ lago wallets create [flags] --recurring-transaction-rules string List of recurring transaction rules. Currently, we only allow one recurring rule per wallet. --transaction-metadata string This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process. --transaction-name string The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either 'Prepaid credits - {{wallet_name}}' if the wallet name is set, or 'Prepaid credits'. + --transaction-priority string The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. ``` ### Options inherited from parent commands diff --git a/docs/reference/lago_wallets_get-customer-wallet-alerts.md b/docs/reference/lago_wallets_get-customer-wallet-alerts.md index 60ae790..a8dda44 100644 --- a/docs/reference/lago_wallets_get-customer-wallet-alerts.md +++ b/docs/reference/lago_wallets_get-customer-wallet-alerts.md @@ -19,7 +19,11 @@ lago wallets get-customer-wallet-alerts [fl ### Options ``` + --all Fetch every page -h, --help help for get-customer-wallet-alerts + --limit string Results per page (1-1000) + --page string Page number. + --per-page string Number of records per page. --watch Poll and re-render when the response changes --watch-interval duration Polling interval used with --watch (default 2s) ``` diff --git a/docs/reference/lago_wallets_list-customer-wallets.md b/docs/reference/lago_wallets_list-customer-wallets.md index f309e89..53a7b9d 100644 --- a/docs/reference/lago_wallets_list-customer-wallets.md +++ b/docs/reference/lago_wallets_list-customer-wallets.md @@ -21,6 +21,7 @@ lago wallets list-customer-wallets [flags] ``` --all Fetch every page --billing-entity-codes string Filter wallets by billing entity codes. + --currency string Filter the results by currency, expressed as an ISO 4217 code. -h, --help help for list-customer-wallets --limit string Results per page (1-1000) --page string Page number. diff --git a/docs/reference/lago_wallets_update-customer-wallet.md b/docs/reference/lago_wallets_update-customer-wallet.md index 2f661d9..1d2a3c8 100644 --- a/docs/reference/lago_wallets_update-customer-wallet.md +++ b/docs/reference/lago_wallets_update-customer-wallet.md @@ -32,6 +32,8 @@ lago wallets update-customer-wallet [flags] --invoice-requires-successful-payment string A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false. --metadata string Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null. --name string The name of the wallet. + --paid-top-up-max-amount-cents string Maximum amount of cents that can be top-up with a single paid transaction. + --paid-top-up-min-amount-cents string Minimum amount of cents that can be top-up with a single paid transaction. --payment-method-payment-method-id string The unique identifier of the payment method (required when using a specific provider payment method). --payment-method-payment-method-type string The type of payment method to use.; one of: provider, manual --priority string Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. diff --git a/docs/reference/lago_wallets_update.md b/docs/reference/lago_wallets_update.md index 572003b..fb6bf85 100644 --- a/docs/reference/lago_wallets_update.md +++ b/docs/reference/lago_wallets_update.md @@ -32,6 +32,8 @@ lago wallets update [flags] --invoice-requires-successful-payment string A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false. --metadata string Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null. --name string The name of the wallet. + --paid-top-up-max-amount-cents string Maximum amount of cents that can be top-up with a single paid transaction. + --paid-top-up-min-amount-cents string Minimum amount of cents that can be top-up with a single paid transaction. --payment-method-payment-method-id string The unique identifier of the payment method (required when using a specific provider payment method). --payment-method-payment-method-type string The type of payment method to use.; one of: provider, manual --priority string Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. diff --git a/docs/reference/lago_wallets_wallet-transactions.md b/docs/reference/lago_wallets_wallet-transactions.md index b67536c..07b260c 100644 --- a/docs/reference/lago_wallets_wallet-transactions.md +++ b/docs/reference/lago_wallets_wallet-transactions.md @@ -22,6 +22,7 @@ lago wallets wallet-transactions [flags] --all Fetch every page -h, --help help for wallet-transactions --limit string Results per page (1-1000) + --metadata[key] string Filter wallet transactions by metadata. Replace 'key' with the actual metadata key you want to match, and provide the corresponding value. For example, 'metadata[color]=blue'. --page string Page number. --per-page string Number of records per page. --status string The status of the wallet transaction. Possible values are 'pending' or 'settled'. diff --git a/internal/generated/spec_gen.go b/internal/generated/spec_gen.go index f3e760e..aee69c2 100644 --- a/internal/generated/spec_gen.go +++ b/internal/generated/spec_gen.go @@ -4,8 +4,8 @@ package generated import "encoding/json" -const SpecVersion = "1.52.1" -const SpecSHA256 = "ce82ac3701caa4ab59bb35557a4e592adb0b81ce69fa37549fde391fc241aa1a" +const SpecVersion = "1.53.0" +const SpecSHA256 = "f41f86039f834a9b7594d5043ddb0a733a931b6cdc8927c706e51e3cae23ea6b" var Operations []Operation @@ -15,4 +15,4 @@ func init() { } } -const operationsJSON = "[{\"resource\":\"activity-logs\",\"action\":\"get\",\"operation_id\":\"findActivityLog\",\"method\":\"GET\",\"path\":\"/activity_logs/{activity_id}\",\"summary\":\"Retrieve an activity log\",\"description\":\"This endpoint retrieves an existing activity log that represents an action performed on some resource. The activity log is identified by its unique activity_id.\",\"docs_url\":\"https://getlago.com/docs/api-reference/audit-logs/activity-logs-object\",\"parameters\":[{\"name\":\"activity_id\",\"flag\":\"activity-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The Activity Id of the existing activity log.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"activity-logs\",\"action\":\"list\",\"operation_id\":\"findAllActivityLogs\",\"method\":\"GET\",\"path\":\"/activity_logs\",\"summary\":\"List all activity logs\",\"description\":\"This endpoint retrieves all existing activity logs that represent actions performed on application resources.\",\"docs_url\":\"https://getlago.com/docs/api-reference/audit-logs/activity-logs-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"from_date\",\"flag\":\"from-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter activity logs from a specific date.\"},{\"name\":\"to_date\",\"flag\":\"to-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter activity logs up to a specific date.\"},{\"name\":\"activity_types[]\",\"flag\":\"activity-types\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by activity types\"},{\"name\":\"activity_sources[]\",\"flag\":\"activity-sources\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by activity sources\"},{\"name\":\"user_emails[]\",\"flag\":\"user-emails\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by user emails\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"External subscription ID\"},{\"name\":\"resource_ids[]\",\"flag\":\"resource-ids\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by resources unique identifiers\"},{\"name\":\"resource_types[]\",\"flag\":\"resource-types\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by resource class types\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"add-ons\",\"action\":\"create\",\"operation_id\":\"createAddOn\",\"method\":\"POST\",\"path\":\"/add_ons\",\"summary\":\"Create an add-on\",\"description\":\"This endpoint is used to create an add-on that can be then attached to a one-off invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"body\":{\"wrapper\":\"add_on\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":true,\"complex\":false,\"description\":\"The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The currency of the add-on.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the add-on.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The description of the add-on.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The name of the add-on.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"add-ons\",\"action\":\"delete\",\"operation_id\":\"destroyAddOn\",\"method\":\"DELETE\",\"path\":\"/add_ons/{code}\",\"summary\":\"Delete an add-on\",\"description\":\"This endpoint is used to delete an existing add-on.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the add-on.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"add-ons\",\"action\":\"get\",\"operation_id\":\"findAddOn\",\"method\":\"GET\",\"path\":\"/add_ons/{code}\",\"summary\":\"Retrieve an add-on\",\"description\":\"This endpoint is used to retrieve a specific add-on.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the add-on.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"add-ons\",\"action\":\"list\",\"operation_id\":\"findAllAddOns\",\"method\":\"GET\",\"path\":\"/add_ons\",\"summary\":\"List all add-ons\",\"description\":\"This endpoint is used to list all existing add-ons.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"add-ons\",\"action\":\"update\",\"operation_id\":\"updateAddOn\",\"method\":\"PUT\",\"path\":\"/add_ons/{code}\",\"summary\":\"Update an add-on\",\"description\":\"This endpoint is used to update an existing add-on.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the add-on.\"}],\"body\":{\"wrapper\":\"add_on\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the add-on.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the add-on.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The description of the add-on.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the add-on.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"analytics\",\"action\":\"gross-revenue\",\"operation_id\":\"findAllGrossRevenues\",\"method\":\"GET\",\"path\":\"/analytics/gross_revenue\",\"summary\":\"List gross revenue\",\"description\":\"Gross revenue is the sum of monthly `finalized` invoice payments and fees paid in advance that are not invoiceable. This total is calculated after deducting taxes and discounts.\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Currency of revenue analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.\"},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"invoice-collection\",\"operation_id\":\"findAllInvoiceCollections\",\"method\":\"GET\",\"path\":\"/analytics/invoice_collection\",\"summary\":\"List of finalized invoices\",\"description\":\"Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The currency of revenue analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"invoiced-usage\",\"operation_id\":\"findAllInvoicedUsages\",\"method\":\"GET\",\"path\":\"/analytics/invoiced_usage\",\"summary\":\"List usage revenue\",\"description\":\"Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The currency of invoiced usage analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"mrr\",\"operation_id\":\"findAllMrrs\",\"method\":\"GET\",\"path\":\"/analytics/mrr\",\"summary\":\"List MRR\",\"description\":\"This endpoint is used to list MRR.\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle:\\n\\n- Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued.\\n- Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing).\\n- Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).\\n- Revenue from `semiannual` subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).\\n- Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"overdue-balance\",\"operation_id\":\"findAllOverdueBalances\",\"method\":\"GET\",\"path\":\"/analytics/overdue_balance\",\"summary\":\"List overdue balance\",\"description\":\"Overdue balance is the total amount associated with overdue invoices (invoices with pending or failed payments which are past their due dates).\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Currency of revenue analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.\"},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"usage\",\"operation_id\":\"findAllUsages\",\"method\":\"GET\",\"path\":\"/analytics/usage\",\"summary\":\"List usage\",\"description\":\"Returns usages.\",\"parameters\":[{\"name\":\"time_granularity\",\"flag\":\"time-granularity\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The time granularity of usage analytics. Possible values are 'daily', 'weekly', 'monthly', 'yearly'.\",\"enum\":[\"daily\",\"weekly\",\"monthly\"]},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The currency of usage analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"from_date\",\"flag\":\"from-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The start date of the period for which the usage analytics is calculated.\"},{\"name\":\"to_date\",\"flag\":\"to-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The end date of the period for which the usage analytics is calculated.\"},{\"name\":\"customer_type\",\"flag\":\"customer-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The type of customer for which the usage analytics is calculated. Possible values are 'individual', 'company'.\",\"enum\":[\"individual\",\"company\"]},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The external identifier of the customer for which the usage analytics is calculated.\"},{\"name\":\"customer_country\",\"flag\":\"customer-country\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The country of the customer for which the usage analytics is calculated.\",\"enum\":[\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The external identifier of the subscription for which the usage analytics is calculated.\"},{\"name\":\"is_billable_metric_recurring\",\"flag\":\"is-billable-metric-recurring\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Indicates whether the billable metric associated with the usage is recurring.\"},{\"name\":\"plan_code\",\"flag\":\"plan-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The code of the plan for which the usage analytics is calculated.\"},{\"name\":\"billable_metric_code\",\"flag\":\"billable-metric-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The code of the usage-based billable metrics for which the usage analytics is calculated.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"api-logs\",\"action\":\"get\",\"operation_id\":\"findApiLog\",\"method\":\"GET\",\"path\":\"/api_logs/{request_id}\",\"summary\":\"Retrieve an api log\",\"description\":\"This endpoint retrieves an existing api log that represents a request made to the API. The api log is identified by its unique request_id.\",\"docs_url\":\"https://getlago.com/docs/api-reference/audit-logs/api-logs-object\",\"parameters\":[{\"name\":\"request_id\",\"flag\":\"request-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The Request Id of the existing api log.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"api-logs\",\"action\":\"list\",\"operation_id\":\"findAllApiLogs\",\"method\":\"GET\",\"path\":\"/api_logs\",\"summary\":\"List all api logs\",\"description\":\"This endpoint retrieves all existing api logs that represent requests performed to Lago's API.\",\"docs_url\":\"https://getlago.com/docs/api-reference/audit-logs/api-logs-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"from_date\",\"flag\":\"from-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter api logs from a specific date.\"},{\"name\":\"to_date\",\"flag\":\"to-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter api logs up to a specific date.\"},{\"name\":\"http_methods[]\",\"flag\":\"http-methods\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by HTTP methods\"},{\"name\":\"http_statuses[]\",\"flag\":\"http-statuses\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by HTTP status or by generic request status\"},{\"name\":\"api_version\",\"flag\":\"api-version\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by API version\"},{\"name\":\"request_paths\",\"flag\":\"request-paths\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by the path of the request\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"billable-metrics\",\"action\":\"create\",\"operation_id\":\"createBillableMetric\",\"method\":\"POST\",\"path\":\"/billable_metrics\",\"summary\":\"Create a billable metric\",\"description\":\"This endpoint creates a new billable metric representing a pricing component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"body\":{\"wrapper\":\"billable_metric\",\"fields\":[{\"path\":[\"aggregation_type\"],\"flag\":\"aggregation-type\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Aggregation method used to compute usage for this billable metric.\",\"enum\":[\"count_agg\",\"sum_agg\",\"max_agg\",\"unique_count_agg\",\"weighted_sum_agg\",\"latest_agg\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the billable metric.\"},{\"path\":[\"expression\"],\"flag\":\"expression\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.\\nAccepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\\\\` and `*` operations.\\nRound is accepting an optional second parameter to specify the number of decimal.\\n\"},{\"path\":[\"field_name\"],\"flag\":\"field-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Name of the billable metric.\"},{\"path\":[\"recurring\"],\"flag\":\"recurring\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Defines if the billable metric is persisted billing period over billing period.\\n\\n- If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period.\\n- If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period.\\n- If not defined in the request, default value is `false`.\"},{\"path\":[\"rounding_function\"],\"flag\":\"rounding-function\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Refers to the numeric value or mathematical expression that will be rounded based on the calculated number of billing units. Possible values are `round`, `ceil` and `floor`.\",\"enum\":[\"ceil\",\"floor\",\"round\",\"\"]},{\"path\":[\"rounding_precision\"],\"flag\":\"rounding-precision\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of decimal places to which the `rounding_function` will be rounded. It can be a positive or negative value.\"},{\"path\":[\"weighted_interval\"],\"flag\":\"weighted-interval\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.\",\"enum\":[\"seconds\",\"\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"billable-metrics\",\"action\":\"delete\",\"operation_id\":\"destroyBillableMetric\",\"method\":\"DELETE\",\"path\":\"/billable_metrics/{code}\",\"summary\":\"Delete a billable metric\",\"description\":\"This endpoint deletes an existing billable metric representing a pricing component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing billable metric.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"billable-metrics\",\"action\":\"evaluate-expression\",\"operation_id\":\"evaluateBillableMetricExpression\",\"method\":\"POST\",\"path\":\"/billable_metrics/evaluate_expression\",\"summary\":\"Evaluate an expression for a billable metric\",\"description\":\"Evaluate an expression for a billable metric creation by providing the expression and test data\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"body\":{\"fields\":[{\"path\":[\"event\",\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The code that identifies a targeted billable metric.\"},{\"path\":[\"event\",\"properties\"],\"flag\":\"properties\",\"type\":\"object\",\"required\":true,\"complex\":true,\"description\":\"This field represents additional properties associated with the event. They can be used when evaluating the expression.\"},{\"path\":[\"event\",\"timestamp\"],\"flag\":\"timestamp\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).\\nIf this timestamp is not provided, the API will automatically set it to the time of event reception.\\n\"},{\"path\":[\"expression\"],\"flag\":\"expression\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.\\nAccepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\\\\` and `*` operations.\\nRound is accepting an optional second parameter to specify the number of decimal.\\n\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"billable-metrics\",\"action\":\"get\",\"operation_id\":\"findBillableMetric\",\"method\":\"GET\",\"path\":\"/billable_metrics/{code}\",\"summary\":\"Retrieve a billable metric\",\"description\":\"This endpoint retrieves an existing billable metric that represents a pricing component of your application. The billable metric is identified by its unique code.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing billable metric.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"billable-metrics\",\"action\":\"list\",\"operation_id\":\"findAllBillableMetrics\",\"method\":\"GET\",\"path\":\"/billable_metrics\",\"summary\":\"List all billable metrics\",\"description\":\"This endpoint retrieves all existing billable metrics that represent pricing components of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"billable-metrics\",\"action\":\"update\",\"operation_id\":\"updateBillableMetric\",\"method\":\"PUT\",\"path\":\"/billable_metrics/{code}\",\"summary\":\"Update a billable metric\",\"description\":\"This endpoint updates an existing billable metric representing a pricing component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing billable metric.\"}],\"body\":{\"wrapper\":\"billable_metric\",\"fields\":[{\"path\":[\"aggregation_type\"],\"flag\":\"aggregation-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Aggregation method used to compute usage for this billable metric.\",\"enum\":[\"count_agg\",\"sum_agg\",\"max_agg\",\"unique_count_agg\",\"weighted_sum_agg\",\"latest_agg\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the billable metric.\"},{\"path\":[\"expression\"],\"flag\":\"expression\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.\\nAccepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\\\\` and `*` operations.\\nRound is accepting an optional second parameter to specify the number of decimal.\\n\"},{\"path\":[\"field_name\"],\"flag\":\"field-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Name of the billable metric.\"},{\"path\":[\"recurring\"],\"flag\":\"recurring\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Defines if the billable metric is persisted billing period over billing period.\\n\\n- If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period.\\n- If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period.\\n- If not defined in the request, default value is `false`.\"},{\"path\":[\"rounding_function\"],\"flag\":\"rounding-function\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Refers to the numeric value or mathematical expression that will be rounded based on the calculated number of billing units. Possible values are `round`, `ceil` and `floor`.\",\"enum\":[\"ceil\",\"floor\",\"round\",\"\"]},{\"path\":[\"rounding_precision\"],\"flag\":\"rounding-precision\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of decimal places to which the `rounding_function` will be rounded. It can be a positive or negative value.\"},{\"path\":[\"weighted_interval\"],\"flag\":\"weighted-interval\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.\",\"enum\":[\"seconds\",\"\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"billing-entities\",\"action\":\"create\",\"operation_id\":\"createBillingEntity\",\"method\":\"POST\",\"path\":\"/billing_entities\",\"summary\":\"Create a billing entity\",\"description\":\"This endpoint is used to create a new billing entity\",\"docs_url\":\"https://getlago.com/docs/api-reference/billing-entities/object\",\"body\":{\"wrapper\":\"billing_entity\",\"fields\":[{\"path\":[\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"billing_configuration\",\"document_locale\"],\"flag\":\"billing-configuration-document-locale\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The language of the documents generated for this billing entity\"},{\"path\":[\"billing_configuration\",\"invoice_footer\"],\"flag\":\"billing-configuration-invoice-footer\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The footer text to be displayed on invoices for this billing entity\"},{\"path\":[\"billing_configuration\",\"invoice_grace_period\"],\"flag\":\"billing-configuration-invoice-grace-period\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The grace period (in days) for invoice finalization\"},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_adjustment\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-adjustment\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.\",\"enum\":[\"align_with_finalization_date\",\"keep_anchor\"]},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_anchor\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-anchor\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Defines whether the issuing date follows the current billing period's end date or the next period starting date.\",\"enum\":[\"current_period_end\",\"next_period_start\"]},{\"path\":[\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the billing address\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique code of the billing entity\"},{\"path\":[\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The country code of the billing address\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"default_currency\"],\"flag\":\"default-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The default currency of the billing entity\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"document_number_prefix\"],\"flag\":\"document-number-prefix\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The prefix used in document numbers for this billing entity\"},{\"path\":[\"document_numbering\"],\"flag\":\"document-numbering\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of document numbering for this billing entity:\\n- `per_customer`: document numbers are unique per customer\\n- `per_billing_entity`: document numbers are unique per billing entity\",\"enum\":[\"per_customer\",\"per_billing_entity\"]},{\"path\":[\"einvoicing\"],\"flag\":\"einvoicing\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether e-invoicing is enabled for this billing entity\"},{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The email address of the billing entity\"},{\"path\":[\"email_settings\"],\"flag\":\"email-settings\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The email notification settings for this billing entity\"},{\"path\":[\"eu_tax_management\"],\"flag\":\"eu-tax-management\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether EU tax management is enabled for this billing entity\"},{\"path\":[\"finalize_zero_amount_invoice\"],\"flag\":\"finalize-zero-amount-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether to finalize invoices with zero amount for this billing entity\"},{\"path\":[\"legal_name\"],\"flag\":\"legal-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal name of the billing entity\"},{\"path\":[\"legal_number\"],\"flag\":\"legal-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal registration number of the billing entity\"},{\"path\":[\"logo\"],\"flag\":\"logo\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The base64 encoded logo image for the billing entity\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The name of the billing entity\"},{\"path\":[\"net_payment_term\"],\"flag\":\"net-payment-term\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The net payment term (in days) for this billing entity\"},{\"path\":[\"phone\"],\"flag\":\"phone\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The phone number of the billing entity\"},{\"path\":[\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the billing address\"},{\"path\":[\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The tax identification number of the billing entity\"},{\"path\":[\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The timezone of the billing entity\",\"enum\":[\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Nuuk\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"zipcode\"],\"flag\":\"zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the billing address\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"billing-entities\",\"action\":\"get\",\"operation_id\":\"getBillingEntity\",\"method\":\"GET\",\"path\":\"/billing_entities/{code}\",\"summary\":\"Retrieve a billing entity\",\"description\":\"This endpoint returns a specific billing entity by its code\",\"docs_url\":\"https://getlago.com/docs/api-reference/billing-entities/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The unique code of the billing entity\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"billing-entities\",\"action\":\"list\",\"operation_id\":\"listBillingEntities\",\"method\":\"GET\",\"path\":\"/billing_entities\",\"summary\":\"List all billing entities\",\"description\":\"This endpoint returns a list of all billing entities in the organization\",\"docs_url\":\"https://getlago.com/docs/api-reference/billing-entities/object\",\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"billing-entities\",\"action\":\"update\",\"operation_id\":\"updateBillingEntity\",\"method\":\"PUT\",\"path\":\"/billing_entities/{code}\",\"summary\":\"Update a billing entity\",\"description\":\"This endpoint is used to update an existing billing entity\",\"docs_url\":\"https://getlago.com/docs/api-reference/billing-entities/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The unique code of the billing entity\"}],\"body\":{\"wrapper\":\"billing_entity\",\"fields\":[{\"path\":[\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"billing_configuration\",\"document_locale\"],\"flag\":\"billing-configuration-document-locale\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The language of the documents generated for this billing entity\"},{\"path\":[\"billing_configuration\",\"invoice_footer\"],\"flag\":\"billing-configuration-invoice-footer\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The footer text to be displayed on invoices for this billing entity\"},{\"path\":[\"billing_configuration\",\"invoice_grace_period\"],\"flag\":\"billing-configuration-invoice-grace-period\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The grace period (in days) for invoice finalization\"},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_adjustment\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-adjustment\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.\",\"enum\":[\"align_with_finalization_date\",\"keep_anchor\"]},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_anchor\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-anchor\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Defines whether the issuing date follows the current billing period's end date or the next period starting date.\",\"enum\":[\"current_period_end\",\"next_period_start\"]},{\"path\":[\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the billing address\"},{\"path\":[\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The country code of the billing address\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"default_currency\"],\"flag\":\"default-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The default currency of the billing entity\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"document_number_prefix\"],\"flag\":\"document-number-prefix\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The prefix used in document numbers for this billing entity\"},{\"path\":[\"document_numbering\"],\"flag\":\"document-numbering\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of document numbering for this billing entity:\\n- `per_customer`: document numbers are unique per customer\\n- `per_billing_entity`: document numbers are unique per billing entity\",\"enum\":[\"per_customer\",\"per_billing_entity\"]},{\"path\":[\"einvoicing\"],\"flag\":\"einvoicing\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether e-invoicing is enabled for this billing entity\"},{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The email address of the billing entity\"},{\"path\":[\"email_settings\"],\"flag\":\"email-settings\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The email notification settings for this billing entity\"},{\"path\":[\"eu_tax_management\"],\"flag\":\"eu-tax-management\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether EU tax management is enabled for this billing entity\"},{\"path\":[\"finalize_zero_amount_invoice\"],\"flag\":\"finalize-zero-amount-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether to finalize invoices with zero amount for this billing entity\"},{\"path\":[\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The codes of the invoice custom section that should be associated with this billing entity\"},{\"path\":[\"legal_name\"],\"flag\":\"legal-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal name of the billing entity\"},{\"path\":[\"legal_number\"],\"flag\":\"legal-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal registration number of the billing entity\"},{\"path\":[\"logo\"],\"flag\":\"logo\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The base64 encoded logo image for the billing entity. Sending \\\"null\\\" will remove the logo, if any exist.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the billing entity\"},{\"path\":[\"net_payment_term\"],\"flag\":\"net-payment-term\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The net payment term (in days) for this billing entity\"},{\"path\":[\"phone\"],\"flag\":\"phone\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The phone number of the billing entity\"},{\"path\":[\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the billing address\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The tax codes that should be associated with this billing entity\"},{\"path\":[\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The tax identification number of the billing entity\"},{\"path\":[\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The timezone of the billing entity\",\"enum\":[\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Nuuk\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"zipcode\"],\"flag\":\"zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the billing address\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"apply\",\"operation_id\":\"applyCoupon\",\"method\":\"POST\",\"path\":\"/applied_coupons\",\"summary\":\"Apply a coupon to a customer\",\"description\":\"This endpoint is used to apply a specific coupon to a customer, before or during a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"body\":{\"wrapper\":\"applied_coupon\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The currency of the coupon. This field is required only for coupon with `fixed_amount` type.\",\"enum\":[\"\",\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"coupon_code\"],\"flag\":\"coupon-code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the coupon.\"},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"frequency\"],\"flag\":\"frequency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.\\n\\n- If set to `once`, the coupon is applicable only for a single use.\\n- If set to `recurring`, the coupon can be used multiple times for recurring billing periods.\\n- If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.\",\"enum\":[\"once\",\"recurring\",\"forever\",\"\"]},{\"path\":[\"frequency_duration\"],\"flag\":\"frequency-duration\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type\"},{\"path\":[\"percentage_rate\"],\"flag\":\"percentage-rate\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"create\",\"operation_id\":\"createCoupon\",\"method\":\"POST\",\"path\":\"/coupons\",\"summary\":\"Create a coupon\",\"description\":\"This endpoint is used to create a coupon that can be then attached to a customer to create a discount.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"body\":{\"wrapper\":\"coupon\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The currency of the coupon. This field is required only for coupon with `fixed_amount` type.\",\"enum\":[\"\",\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"plan_codes\"],\"flag\":\"applies-to-plan-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the coupon.\"},{\"path\":[\"coupon_type\"],\"flag\":\"coupon-type\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.\\n\\n- If set to `fixed_amount`, the coupon represents a fixed amount discount.\\n- If set to `percentage`, the coupon represents a percentage-based discount.\",\"enum\":[\"fixed_amount\",\"percentage\"]},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Description of the coupon.\"},{\"path\":[\"expiration\"],\"flag\":\"expiration\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.\\n\\n- If set to `time_limit`, the coupon has an expiration based on a specified time limit.\\n- If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely.\",\"enum\":[\"no_expiration\",\"time_limit\"]},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid.\"},{\"path\":[\"frequency\"],\"flag\":\"frequency\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.\\n\\n- If set to `once`, the coupon is applicable only for a single use.\\n- If set to `recurring`, the coupon can be used multiple times for recurring billing periods.\\n- If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.\",\"enum\":[\"once\",\"recurring\",\"forever\"]},{\"path\":[\"frequency_duration\"],\"flag\":\"frequency-duration\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The name of the coupon.\"},{\"path\":[\"percentage_rate\"],\"flag\":\"percentage-rate\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.\"},{\"path\":[\"reusable\"],\"flag\":\"reusable\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"delete\",\"operation_id\":\"destroyCoupon\",\"method\":\"DELETE\",\"path\":\"/coupons/{code}\",\"summary\":\"Delete a coupon\",\"description\":\"This endpoint is used to delete a coupon.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the coupon.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"delete-applied-coupon\",\"operation_id\":\"deleteAppliedCoupon\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/applied_coupons/{applied_coupon_id}\",\"summary\":\"Delete an applied coupon\",\"description\":\"This endpoint is used to delete a specific coupon that has been applied to a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"applied_coupon_id\",\"flag\":\"applied-coupon-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the applied coupon, created by Lago.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"get\",\"operation_id\":\"findCoupon\",\"method\":\"GET\",\"path\":\"/coupons/{code}\",\"summary\":\"Retrieve a coupon\",\"description\":\"This endpoint is used to retrieve a specific coupon.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the coupon.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"coupons\",\"action\":\"list\",\"operation_id\":\"findAllCoupons\",\"method\":\"GET\",\"path\":\"/coupons\",\"summary\":\"List all coupons\",\"description\":\"This endpoint is used to list all existing coupons.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"coupons\",\"action\":\"list-applied-coupons\",\"operation_id\":\"findAllAppliedCoupons\",\"method\":\"GET\",\"path\":\"/applied_coupons\",\"summary\":\"List all applied coupons\",\"description\":\"This endpoint is used to list all applied coupons. You can filter by coupon status and by customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The status of the coupon. Can be either `active` or `terminated`.\",\"enum\":[\"active\",\"terminated\"]},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"coupon_code[]\",\"flag\":\"coupon-code\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"The code of the coupon applied to the customer. Use it to filter applied coupons by their code.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"coupons\",\"action\":\"update\",\"operation_id\":\"updateCoupon\",\"method\":\"PUT\",\"path\":\"/coupons/{code}\",\"summary\":\"Update a coupon\",\"description\":\"This endpoint is used to update a coupon that can be then attached to a customer to create a discount.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the coupon.\"}],\"body\":{\"wrapper\":\"coupon\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The currency of the coupon. This field is required only for coupon with `fixed_amount` type.\",\"enum\":[\"\",\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"plan_codes\"],\"flag\":\"applies-to-plan-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the coupon.\"},{\"path\":[\"coupon_type\"],\"flag\":\"coupon-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.\\n\\n- If set to `fixed_amount`, the coupon represents a fixed amount discount.\\n- If set to `percentage`, the coupon represents a percentage-based discount.\",\"enum\":[\"fixed_amount\",\"percentage\"]},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Description of the coupon.\"},{\"path\":[\"expiration\"],\"flag\":\"expiration\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.\\n\\n- If set to `time_limit`, the coupon has an expiration based on a specified time limit.\\n- If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely.\",\"enum\":[\"no_expiration\",\"time_limit\"]},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid.\"},{\"path\":[\"frequency\"],\"flag\":\"frequency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.\\n\\n- If set to `once`, the coupon is applicable only for a single use.\\n- If set to `recurring`, the coupon can be used multiple times for recurring billing periods.\\n- If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.\",\"enum\":[\"once\",\"recurring\",\"forever\"]},{\"path\":[\"frequency_duration\"],\"flag\":\"frequency-duration\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the coupon.\"},{\"path\":[\"percentage_rate\"],\"flag\":\"percentage-rate\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.\"},{\"path\":[\"reusable\"],\"flag\":\"reusable\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"create\",\"operation_id\":\"createCreditNote\",\"method\":\"POST\",\"path\":\"/credit_notes\",\"summary\":\"Create a credit note\",\"description\":\"This endpoint creates a new credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"body\":{\"wrapper\":\"credit_note\",\"fields\":[{\"path\":[\"credit_amount_cents\"],\"flag\":\"credit-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The total amount to be credited to the customer balance for discounts on future invoices. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The description of the credit note.\"},{\"path\":[\"invoice_id\"],\"flag\":\"invoice-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The invoice unique identifier, created by Lago.\"},{\"path\":[\"items\"],\"flag\":\"items\",\"type\":\"array\",\"required\":true,\"complex\":true,\"description\":\"The list of credit note's items.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"offset_amount_cents\"],\"flag\":\"offset-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The total amount to be immediately deducted from the invoice balance. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.\"},{\"path\":[\"reason\"],\"flag\":\"reason\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The reason of the credit note creation.\\nPossible values are `duplicated_charge`, `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge` or `other`.\",\"enum\":[\"duplicated_charge\",\"product_unsatisfactory\",\"order_change\",\"order_cancellation\",\"fraudulent_charge\",\"other\",\"\"]},{\"path\":[\"refund_amount_cents\"],\"flag\":\"refund-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The total amount to be refunded immediately to the payment method used by the customer. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"delete-all-credit-note-metadata\",\"operation_id\":\"deleteAllCreditNoteMetadata\",\"method\":\"DELETE\",\"path\":\"/credit_notes/{lago_id}/metadata\",\"summary\":\"Delete all credit note metadata\",\"description\":\"This endpoint removes all metadata from a credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"delete-credit-note-metadata-key\",\"operation_id\":\"deleteCreditNoteMetadataKey\",\"method\":\"DELETE\",\"path\":\"/credit_notes/{lago_id}/metadata/{key}\",\"summary\":\"Delete a metadata key\",\"description\":\"This endpoint removes a single metadata key from a credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"},{\"name\":\"key\",\"flag\":\"key\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The metadata key to delete.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"download\",\"operation_id\":\"downloadCreditNote\",\"method\":\"POST\",\"path\":\"/credit_notes/{lago_id}/download\",\"summary\":\"Download a credit note PDF\",\"description\":\"This endpoint downloads the PDF of an existing credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"credit-notes\",\"action\":\"estimate\",\"operation_id\":\"estimateCreditNote\",\"method\":\"POST\",\"path\":\"/credit_notes/estimate\",\"summary\":\"Estimate amounts for a new credit note\",\"description\":\"This endpoint allows you to retrieve amounts for a new credit note creation.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"body\":{\"wrapper\":\"credit_note\",\"fields\":[{\"path\":[\"invoice_id\"],\"flag\":\"invoice-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The invoice unique identifier, created by Lago.\"},{\"path\":[\"items\"],\"flag\":\"items\",\"type\":\"array\",\"required\":true,\"complex\":true,\"description\":\"The list of credit note's items.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"credit-notes\",\"action\":\"get\",\"operation_id\":\"findCreditNote\",\"method\":\"GET\",\"path\":\"/credit_notes/{lago_id}\",\"summary\":\"Retrieve a credit note\",\"description\":\"This endpoint retrieves an existing credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"credit-notes\",\"action\":\"list\",\"operation_id\":\"findAllCreditNotes\",\"method\":\"GET\",\"path\":\"/credit_notes\",\"summary\":\"List all credit notes\",\"description\":\"This endpoint list all existing credit notes.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"issuing_date_from\",\"flag\":\"issuing-date-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes starting from a specific date.\"},{\"name\":\"issuing_date_to\",\"flag\":\"issuing-date-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes up to a specific date.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search credit notes by id, number, customer name, customer external_id or customer email.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by currency. Possible values ISO 4217 currency codes.\"},{\"name\":\"reason\",\"flag\":\"reason\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`.\",\"enum\":[\"product_unsatisfactory\",\"order_change\",\"order_cancellation\",\"fraudulent_charge\",\"duplicated_charge\",\"other\"]},{\"name\":\"credit_status\",\"flag\":\"credit-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`.\",\"enum\":[\"available\",\"consumed\",\"voided\"]},{\"name\":\"refund_status\",\"flag\":\"refund-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\"]},{\"name\":\"invoice_number\",\"flag\":\"invoice-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by their related invoice number.\"},{\"name\":\"purchase_order_number\",\"flag\":\"purchase-order-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by the invoice purchase order number. The match is exact but case-insensitive.\"},{\"name\":\"amount_from\",\"flag\":\"amount-from\",\"in\":\"query\",\"type\":\"integer\",\"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 types.\"},{\"name\":\"amount_to\",\"flag\":\"amount-to\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"types[]\",\"flag\":\"types\",\"in\":\"query\",\"type\":\"array\",\"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 amount and `offset` those with an amount deducted from the invoice balance. A credit note can match several types.\"},{\"name\":\"self_billed\",\"flag\":\"self-billed\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter credit notes by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"credit-notes\",\"action\":\"merge-credit-note-metadata\",\"operation_id\":\"mergeCreditNoteMetadata\",\"method\":\"PATCH\",\"path\":\"/credit_notes/{lago_id}/metadata\",\"summary\":\"Merge credit note metadata\",\"description\":\"This endpoint merges the provided metadata with existing metadata on the credit note.\\nExisting keys not in the request are preserved. New keys are added, existing keys are updated.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"metadata\",\"operation_id\":\"replaceCreditNoteMetadata\",\"method\":\"POST\",\"path\":\"/credit_notes/{lago_id}/metadata\",\"summary\":\"Replace credit note metadata\",\"description\":\"This endpoint replaces all existing metadata on a credit note with the provided key-value pairs.\\nAny existing metadata keys not included in the request will be removed.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"update\",\"operation_id\":\"updateCreditNote\",\"method\":\"PUT\",\"path\":\"/credit_notes/{lago_id}\",\"summary\":\"Update a credit note\",\"description\":\"This endpoint updates an existing credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"body\":{\"wrapper\":\"credit_note\",\"fields\":[{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"refund_status\"],\"flag\":\"refund-status\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:\\n\\n- `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.\\n- `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.\\n- `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.\",\"enum\":[\"pending\",\"succeeded\",\"failed\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"void\",\"operation_id\":\"voidCreditNote\",\"method\":\"PUT\",\"path\":\"/credit_notes/{lago_id}/void\",\"summary\":\"Void available credit\",\"description\":\"This endpoint voids the available credit linked to a specific credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"customers\",\"action\":\"applied-coupons\",\"operation_id\":\"findAllCustomerAppliedCoupons\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/applied_coupons\",\"summary\":\"List all customer's applied coupons\",\"description\":\"This endpoint is used to list all applied coupons for a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The status of the coupon. Can be either `active` or `terminated`.\",\"enum\":[\"active\",\"terminated\"]},{\"name\":\"coupon_code[]\",\"flag\":\"coupon-code\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"The code of the coupon applied to the customer. Use it to filter applied coupons by their code.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"checkout-url\",\"operation_id\":\"generateCustomerCheckoutURL\",\"method\":\"POST\",\"path\":\"/customers/{external_customer_id}/checkout_url\",\"summary\":\"Generate a Customer Payment Provider Checkout URL\",\"description\":\"This endpoint regenerates the Payment Provider Checkout URL of a Customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application).\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"create\",\"operation_id\":\"createCustomer\",\"method\":\"POST\",\"path\":\"/customers\",\"summary\":\"Create a customer\",\"description\":\"This endpoint creates a new customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"body\":{\"wrapper\":\"customer\",\"fields\":[{\"path\":[\"account_type\"],\"flag\":\"account-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of the account. It can have one of the following values:\\n- `customer`: the account is a customer, default value.\\n- `partner`: the account is a partner.\\n\\nThis field is only applied when revenue share is enabled on your organization; otherwise it is ignored.\",\"enum\":[\"customer\",\"partner\"]},{\"path\":[\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"billing_configuration\",\"document_locale\"],\"flag\":\"billing-configuration-document-locale\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago\"},{\"path\":[\"billing_configuration\",\"invoice_grace_period\"],\"flag\":\"billing-configuration-invoice-grace-period\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items\"},{\"path\":[\"billing_configuration\",\"payment_provider\"],\"flag\":\"billing-configuration-payment-provider\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The payment provider utilized to initiate payments for invoices issued by Lago.\\nAccepted values: `stripe`, `adyen`, `cashfree`, `flutterwave`, `gocardless`, `moneyhash` or null. This field is required if you intend to assign a `provider_customer_id`.\",\"enum\":[\"stripe\",\"adyen\",\"cashfree\",\"flutterwave\",\"gocardless\",\"moneyhash\"]},{\"path\":[\"billing_configuration\",\"payment_provider_code\"],\"flag\":\"billing-configuration-payment-provider-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify a payment provider connection.\"},{\"path\":[\"billing_configuration\",\"provider_customer_id\"],\"flag\":\"billing-configuration-provider-customer-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer\"},{\"path\":[\"billing_configuration\",\"provider_payment_methods\"],\"flag\":\"billing-configuration-provider-payment-methods\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit`, `boleto`, `link`, `crypto` and `customer_balance`. Note that when `link` is selected, `card` should also be provided in the array. When `customer_balance` is selected, no other payment can be selected.\"},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_adjustment\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-adjustment\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.\",\"enum\":[\"align_with_finalization_date\",\"keep_anchor\",\"\"]},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_anchor\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-anchor\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Defines whether the issuing date follows the current billing period's end date or the next period starting date.\",\"enum\":[\"current_period_end\",\"next_period_start\",\"\"]},{\"path\":[\"billing_configuration\",\"sync\"],\"flag\":\"billing-configuration-sync\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set this field to `true` if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the `provider_customer_id` is `null` and the customer is automatically created in the payment provider through Lago. By default, the value is set to `false`\"},{\"path\":[\"billing_configuration\",\"sync_with_provider\"],\"flag\":\"billing-configuration-sync-with-provider\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set this field to `true` if you want to create a customer record in the payment provider's system. This option is applicable only when the `provider_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The unique code of the billing entity to associate with the customer. If not provided, the default billing entity will be used.\"},{\"path\":[\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the customer's billing address\"},{\"path\":[\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Currency of the customer. Format must be ISO 4217\",\"enum\":[\"\",\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"customer_type\"],\"flag\":\"customer-type\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The type of the customer. It can have one of the following values:\\n- `company`: the customer is a company.\\n- `individual`: the customer is an individual.\",\"enum\":[\"company\",\"individual\",\"\"]},{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The email of the customer\"},{\"path\":[\"external_id\"],\"flag\":\"external-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"external_salesforce_id\"],\"flag\":\"external-salesforce-id\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The customer ID within the Salesforce system\"},{\"path\":[\"finalize_zero_amount_invoice\"],\"flag\":\"finalize-zero-amount-invoice\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies how invoices with a zero total amount should be handled:\\n- `inherit`: (Default) Follows the organization-level configuration.\\n- `finalize`: Invoices are issued and finalized even if the total amount is zero.\\n- `skip`: Invoices with a total amount of zero are not finalized.\",\"enum\":[\"inherit\",\"skip\",\"finalize\"]},{\"path\":[\"firstname\"],\"flag\":\"firstname\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"First name of the customer\"},{\"path\":[\"integration_customers\"],\"flag\":\"integration-customers\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections.\"},{\"path\":[\"lastname\"],\"flag\":\"lastname\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Last name of the customer\"},{\"path\":[\"legal_name\"],\"flag\":\"legal-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal company name of the customer\"},{\"path\":[\"legal_number\"],\"flag\":\"legal-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal company number of the customer\"},{\"path\":[\"logo_url\"],\"flag\":\"logo-url\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The logo URL of the customer\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The full name of the customer (255 characters max).\"},{\"path\":[\"net_payment_term\"],\"flag\":\"net-payment-term\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.\"},{\"path\":[\"phone\"],\"flag\":\"phone\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The phone number of the customer\"},{\"path\":[\"shipping_address\",\"address_line1\"],\"flag\":\"shipping-address-address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"shipping_address\",\"address_line2\"],\"flag\":\"shipping-address-address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"shipping_address\",\"city\"],\"flag\":\"shipping-address-city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the customer's billing address\"},{\"path\":[\"shipping_address\",\"country\"],\"flag\":\"shipping-address-country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"shipping_address\",\"state\"],\"flag\":\"shipping-address-state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the customer's billing address\"},{\"path\":[\"shipping_address\",\"zipcode\"],\"flag\":\"shipping-address-zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the customer's billing address\"},{\"path\":[\"skip_invoice_custom_sections\"],\"flag\":\"skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for this customer only. False by default\"},{\"path\":[\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the customer's billing address\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The tax identification number of the customer\"},{\"path\":[\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone\",\"enum\":[\"\",\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Godthab\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"url\"],\"flag\":\"url\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The custom website URL of the customer\"},{\"path\":[\"zipcode\"],\"flag\":\"zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the customer's billing address\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"customers\",\"action\":\"credit-notes\",\"operation_id\":\"findAllCustomerCreditNotes\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/credit_notes\",\"summary\":\"List all customer's credit notes\",\"description\":\"This endpoint list all existing credit notes for a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"issuing_date_from\",\"flag\":\"issuing-date-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes starting from a specific date.\"},{\"name\":\"issuing_date_to\",\"flag\":\"issuing-date-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes up to a specific date.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search credit notes by id, number, customer name, customer external_id or customer email.\"},{\"name\":\"reason\",\"flag\":\"reason\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`.\",\"enum\":[\"product_unsatisfactory\",\"order_change\",\"order_cancellation\",\"fraudulent_charge\",\"duplicated_charge\",\"other\"]},{\"name\":\"credit_status\",\"flag\":\"credit-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`.\",\"enum\":[\"available\",\"consumed\",\"voided\"]},{\"name\":\"refund_status\",\"flag\":\"refund-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\"]},{\"name\":\"invoice_number\",\"flag\":\"invoice-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by their related invoice number.\"},{\"name\":\"purchase_order_number\",\"flag\":\"purchase-order-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by the invoice purchase order number. The match is exact but case-insensitive.\"},{\"name\":\"amount_from\",\"flag\":\"amount-from\",\"in\":\"query\",\"type\":\"integer\",\"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 types.\"},{\"name\":\"amount_to\",\"flag\":\"amount-to\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"self_billed\",\"flag\":\"self-billed\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"current-usage\",\"operation_id\":\"findCustomerCurrentUsage\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/current_usage\",\"summary\":\"Retrieve customer current usage\",\"description\":\"This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application).\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":true,\"description\":\"The unique identifier of the subscription within your application.\"},{\"name\":\"apply_taxes\",\"flag\":\"apply-taxes\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.\\n\"},{\"name\":\"charge_id\",\"flag\":\"charge-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter usage to a specific charge by its Lago ID (UUID). Replaces deprecated `filter_by_charge_id`.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter usage to a specific charge by its code. Replaces deprecated `filter_by_charge_code`.\"},{\"name\":\"billable_metric_code\",\"flag\":\"billable-metric-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter usage to a specific billable metric by its code.\"},{\"name\":\"group\",\"flag\":\"group\",\"in\":\"query\",\"type\":\"object\",\"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`.\\n\"},{\"name\":\"filter_by_charge_id\",\"flag\":\"filter-by-charge-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"**Deprecated.** Filter usage to a specific charge by its Lago ID (UUID).\"},{\"name\":\"filter_by_charge_code\",\"flag\":\"filter-by-charge-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"**Deprecated.** Filter usage to a specific charge by its code.\"},{\"name\":\"filter_by_group\",\"flag\":\"filter-by-group\",\"in\":\"query\",\"type\":\"object\",\"required\":false,\"description\":\"**Deprecated.** Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.\\n\"},{\"name\":\"full_usage\",\"flag\":\"full-usage\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"When `true`, returns usage since subscription start instead of the current billing period. Requires one of `charge_id`, `charge_code`, `group` (or their deprecated `filter_by_*` equivalents) to be set.\\n\"},{\"name\":\"filter_by_presentation\",\"flag\":\"filter-by-presentation\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values will be returned. Pass an empty array to disable `presentation_breakdowns` entirely.\\n\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"delete\",\"operation_id\":\"destroyCustomer\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}\",\"summary\":\"Delete a customer\",\"description\":\"This endpoint deletes an existing customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"customers\",\"action\":\"get\",\"operation_id\":\"findCustomer\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}\",\"summary\":\"Retrieve a customer\",\"description\":\"This endpoint retrieves an existing customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"invoices\",\"operation_id\":\"findAllCustomerInvoices\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/invoices\",\"summary\":\"List all customer's invoices\",\"description\":\"This endpoint is used for retrieving all invoices of a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"amount_from\",\"flag\":\"amount-from\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"amount_to\",\"flag\":\"amount-to\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"issuing_date_from\",\"flag\":\"issuing-date-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices starting from a specific date.\"},{\"name\":\"issuing_date_to\",\"flag\":\"issuing-date-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices up to a specific date.\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by status. Possible values are `draft` or `finalized`.\",\"enum\":[\"draft\",\"finalized\"]},{\"name\":\"payment_status\",\"flag\":\"payment-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`.\",\"enum\":[\"pending\",\"failed\",\"succeeded\"]},{\"name\":\"payment_overdue\",\"flag\":\"payment-overdue\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices by payment_overdue. Possible values are `true` or `false`.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search invoices by id, number, customer name, customer external_id or customer email.\"},{\"name\":\"payment_dispute_lost\",\"flag\":\"payment-dispute-lost\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices with a payment dispute lost. Possible values are `true` or `false`.\"},{\"name\":\"invoice_type\",\"flag\":\"invoice-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`.\",\"enum\":[\"subscription\",\"add_on\",\"credit\",\"one_off\",\"advance_charges\",\"progressive_billing\"]},{\"name\":\"self_billed\",\"flag\":\"self-billed\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices by self billed. Possible values are `true` or `false`.\"},{\"name\":\"metadata[key]\",\"flag\":\"metadata[key]\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for invoice without given metadata key. For example, `metadata[color]=blue`.\"},{\"name\":\"purchase_order_number\",\"flag\":\"purchase-order-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by the invoice purchase order number. The match is exact but case-insensitive.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"list\",\"operation_id\":\"findAllCustomers\",\"method\":\"GET\",\"path\":\"/customers\",\"summary\":\"List all customers\",\"description\":\"This endpoint retrieves all existing customers.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter customers by external ID.\"},{\"name\":\"account_type[]\",\"flag\":\"account-type\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by account type.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by billing entity codes.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter customers by search term. This will filter all customers whose name, firstname, lastname, legal name, external id or email contain the search term.\"},{\"name\":\"countries[]\",\"flag\":\"countries\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by countries. Possible values are the ISO 3166-1 alpha-2 codes.\"},{\"name\":\"states[]\",\"flag\":\"states\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by states.\"},{\"name\":\"zipcodes[]\",\"flag\":\"zipcodes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by zipcodes.\"},{\"name\":\"currencies[]\",\"flag\":\"currencies\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by currencies.\"},{\"name\":\"has_tax_identification_number\",\"flag\":\"has-tax-identification-number\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter customers by whether they have a tax identification number or not.\"},{\"name\":\"metadata[key]\",\"flag\":\"metadata[key]\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter customers by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for customers without given metadata key. For example, `metadata[is_synced]=true\\u0026metadata[last_synced_at]=`.\"},{\"name\":\"customer_type\",\"flag\":\"customer-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter customers by customer type.\",\"enum\":[\"company\",\"individual\"]},{\"name\":\"has_customer_type\",\"flag\":\"has-customer-type\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter customers by whether they have a customer type or not.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"past-usage\",\"operation_id\":\"findAllCustomerPastUsage\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/past_usage\",\"summary\":\"Retrieve customer past usage\",\"description\":\"This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application).\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":true,\"description\":\"The unique identifier of the subscription within your application.\"},{\"name\":\"billable_metric_code\",\"flag\":\"billable-metric-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Billable metric code filter to apply to the charge usage\"},{\"name\":\"periods_count\",\"flag\":\"periods-count\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of past billing period to returns in the result\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"payment-requests\",\"operation_id\":\"findAllCustomerPaymentRequests\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/payment_requests\",\"summary\":\"List all customer's payment requests\",\"description\":\"This endpoint is used to list all existing payment requests of a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"payment_status\",\"flag\":\"payment-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by payment status. Possible values are `pending`, `failed` or `succeeded`.\",\"enum\":[\"pending\",\"failed\",\"succeeded\"]},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter payment requests by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"payments\",\"operation_id\":\"findAllCustomerPayments\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/payments\",\"summary\":\"List all customer's payments\",\"description\":\"This endpoint is used to list all payments of a customer\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"invoice_id\",\"flag\":\"invoice-id\",\"in\":\"query\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"portal-url\",\"operation_id\":\"getCustomerPortalUrl\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/portal_url\",\"summary\":\"Get a customer portal URL\",\"description\":\"Retrieves an embeddable link for displaying a customer portal.\\n\\nThis endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing customer\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"projected-usage\",\"operation_id\":\"findCustomerProjectedUsage\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/projected_usage\",\"summary\":\"Retrieve customer current and projected usage\",\"description\":\"This endpoint enables the retrieval of the usage-based billing data for a customer within the current period. It also returns the projected usage for the current period based on the current usage.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application).\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":true,\"description\":\"The unique identifier of the subscription within your application.\"},{\"name\":\"apply_taxes\",\"flag\":\"apply-taxes\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.\\n\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"subscriptions\",\"operation_id\":\"findAllCustomerSubscriptions\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/subscriptions\",\"summary\":\"List all customer's subscriptions\",\"description\":\"This endpoint retrieves all active subscriptions for a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"plan_code\",\"flag\":\"plan-code\",\"in\":\"query\",\"type\":\"string\",\"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 plans.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"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 you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter subscriptions by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"entitlements\",\"action\":\"create\",\"operation_id\":\"createEntitlement\",\"method\":\"POST\",\"path\":\"/plans/{code}/entitlements\",\"summary\":\"Create an entitlement\",\"description\":\"This endpoint creates new entitlements by adding features to a plan. Note that all existing entitlements will be deleted and replaced by the ones provided. To add a new entitlement without removing the existing ones, use PATCH. The feature must exist and all privileges must be valid for the feature.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"body\":{\"wrapper\":\"entitlements\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"destroy\",\"operation_id\":\"destroyEntitlement\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/entitlements/{feature_code}\",\"summary\":\"Delete an entitlement\",\"description\":\"This endpoint deletes an existing entitlement by removing the feature from the plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"destroy-subscription-entitlement\",\"operation_id\":\"destroySubscriptionEntitlement\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/entitlements/{feature_code}\",\"summary\":\"Remove an entitlement from a subscription\",\"description\":\"This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"destroy-subscription-entitlement-privilege\",\"operation_id\":\"destroySubscriptionEntitlementPrivilege\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}\",\"summary\":\"Remove a privilege from a subscription entitlement override\",\"description\":\"This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"},{\"name\":\"privilege_code\",\"flag\":\"privilege-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the privilege to remove from the subscription entitlement override.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"get\",\"operation_id\":\"findEntitlement\",\"method\":\"GET\",\"path\":\"/plans/{code}/entitlements/{feature_code}\",\"summary\":\"Retrieve an entitlement\",\"description\":\"This endpoint retrieves a specific entitlement for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"entitlements\",\"action\":\"list\",\"operation_id\":\"findAllEntitlements\",\"method\":\"GET\",\"path\":\"/plans/{code}/entitlements\",\"summary\":\"List all entitlements\",\"description\":\"This endpoint retrieves all entitlements for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"entitlements\",\"action\":\"list-subscription-entitlements\",\"operation_id\":\"findAllSubscriptionEntitlements\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/entitlements\",\"summary\":\"List all subscription entitlements\",\"description\":\"This endpoint retrieves all entitlements for a specific subscription, including both plan entitlements and any subscription-specific overrides.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"entitlements\",\"action\":\"remove-entitlement-privilege\",\"operation_id\":\"removeEntitlementPrivilege\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/entitlements/{feature_code}/privileges/{privilege_code}\",\"summary\":\"Remove a privilege from an entitlement\",\"description\":\"This endpoint removes a specific privilege and its value from an entitlement. The privilege remains untouched on the original feature.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"},{\"name\":\"privilege_code\",\"flag\":\"privilege-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the privilege to remove from the entitlement.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"update\",\"operation_id\":\"updateEntitlement\",\"method\":\"PATCH\",\"path\":\"/plans/{code}/entitlements\",\"summary\":\"Partial update of an entitlement\",\"description\":\"This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"body\":{\"wrapper\":\"entitlements\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"update-subscription-entitlements\",\"operation_id\":\"updateSubscriptionEntitlements\",\"method\":\"PATCH\",\"path\":\"/subscriptions/{external_id}/entitlements\",\"summary\":\"Update subscription entitlements\",\"description\":\"This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"entitlements\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"events\",\"action\":\"batch\",\"operation_id\":\"createBatchEvents\",\"method\":\"POST\",\"path\":\"/events/batch\",\"summary\":\"Batch multiple events\",\"description\":\"This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"fields\":[{\"path\":[\"events\"],\"flag\":\"events\",\"type\":\"array\",\"required\":true,\"complex\":true}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"batch-estimate-instant-fees\",\"operation_id\":\"eventBatchEstimateInstantFees\",\"method\":\"POST\",\"path\":\"/events/batch_estimate_instant_fees\",\"summary\":\"Batch estimate instant fees for a pay in advance charge\",\"description\":\"Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance standard or percentage charges\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"fields\":[{\"path\":[\"events\"],\"flag\":\"events\",\"type\":\"array\",\"required\":true,\"complex\":true}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"estimate-fees\",\"operation_id\":\"eventEstimateFees\",\"method\":\"POST\",\"path\":\"/events/estimate_fees\",\"summary\":\"Estimate fees for a pay in advance charge\",\"description\":\"Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"wrapper\":\"event\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.\"},{\"path\":[\"external_subscription_id\"],\"flag\":\"external-subscription-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique identifier of the subscription within your application.\"},{\"path\":[\"properties\"],\"flag\":\"properties\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. Any property of the targeted billable metric can be sent here, in addition to the documented fields below.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"estimate-instant-fees\",\"operation_id\":\"eventEstimateInstantFees\",\"method\":\"POST\",\"path\":\"/events/estimate_instant_fees\",\"summary\":\"Estimate instant fees for a pay in advance charge\",\"description\":\"Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance standard or percentage charges\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"wrapper\":\"event\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.\"},{\"path\":[\"external_subscription_id\"],\"flag\":\"external-subscription-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique identifier of the subscription within your application.\"},{\"path\":[\"properties\"],\"flag\":\"properties\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.\"},{\"path\":[\"transaction_id\"],\"flag\":\"transaction-id\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field represents a unique identifier for the event.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"get\",\"operation_id\":\"findEvent\",\"method\":\"GET\",\"path\":\"/events/{transaction_id}\",\"summary\":\"Retrieve a specific event\",\"description\":\"This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.\\n\\nNote that transaction_id is unique per external_subscription_id so multiple subscriptions can share the same transaction_id. This endpoint will only return the first event found with the given transaction_id.\\n\\nWARNING: If your Lago organization is configured to use the Clickhouse-based event pipeline, multiple events can share the same `transaction_id` (with different timestamps). This endpoint will only return the first event found.\\n\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"parameters\":[{\"name\":\"transaction_id\",\"flag\":\"transaction-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"This field represents the unique identifier sent for this specific event (must be URL encoded).\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"list\",\"operation_id\":\"findAllEvents\",\"method\":\"GET\",\"path\":\"/events\",\"summary\":\"List all events\",\"description\":\"This endpoint is used for retrieving all events.\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"External subscription ID\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter events by its code.\"},{\"name\":\"timestamp_from_started_at\",\"flag\":\"timestamp-from-started-at\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Requires `external_subscription_id` to be set. Filter events by timestamp after the subscription started at datetime.\"},{\"name\":\"timestamp_from\",\"flag\":\"timestamp-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter events by timestamp starting from a specific date.\"},{\"name\":\"timestamp_to\",\"flag\":\"timestamp-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter events by timestamp up to a specific date.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"events\",\"action\":\"send\",\"operation_id\":\"createEvent\",\"method\":\"POST\",\"path\":\"/events\",\"summary\":\"Send usage events\",\"description\":\"This endpoint is used for transmitting usage measurement events to either a designated customer or a specific subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"wrapper\":\"event\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.\"},{\"path\":[\"external_subscription_id\"],\"flag\":\"external-subscription-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique identifier of the subscription in your application. This field is mandatory in order to link events to the correct customer subscription.\"},{\"path\":[\"precise_total_amount_cents\"],\"flag\":\"precise-total-amount-cents\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The precise total amount in cents with precision used by the `dynamic` pricing model to compute the usage amount.\"},{\"path\":[\"properties\"],\"flag\":\"properties\",\"type\":\"object\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.\"},{\"path\":[\"timestamp\"],\"flag\":\"timestamp\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).\\nIf this timestamp is not provided, the API will automatically set it to the time of event reception.\\nYou can also provide miliseconds precision by appending decimals to the timestamp.\\n\"},{\"path\":[\"transaction_id\"],\"flag\":\"transaction-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"This field represents a unique identifier for the event.\\nIt is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.\\n\\nWARNING: If the Lago organization is configured to use the new Clickhouse-based event pipeline (designed for high-volume processing), the idempotency logic is handled differently.\\nEvent uniqueness is maintained with both `transaction_id` and `timestamp` fields.\\nIf a new event arrives with identical values for these two fields as an existing event, the new one will overwrite the previous event rather than being rejected.\\n\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"features\",\"action\":\"create\",\"operation_id\":\"createFeature\",\"method\":\"POST\",\"path\":\"/features\",\"summary\":\"Create a feature\",\"description\":\"This endpoint creates a new feature representing an entitlement component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"body\":{\"wrapper\":\"feature\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the feature.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the feature.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Name of the feature.\"},{\"path\":[\"privileges\"],\"flag\":\"privileges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Privileges associated with this feature. Can be empty.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"features\",\"action\":\"delete\",\"operation_id\":\"destroyFeature\",\"method\":\"DELETE\",\"path\":\"/features/{code}\",\"summary\":\"Delete a feature\",\"description\":\"This endpoint deletes an existing feature representing an entitlement component of your application. Deleting a feature will remove it from all plans and subscriptions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"features\",\"action\":\"delete-feature-privilege\",\"operation_id\":\"deleteFeaturePrivilege\",\"method\":\"DELETE\",\"path\":\"/features/{code}/privileges/{privilege_code}\",\"summary\":\"Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.\",\"description\":\"Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"},{\"name\":\"privilege_code\",\"flag\":\"privilege-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing privilege.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"features\",\"action\":\"get\",\"operation_id\":\"findFeature\",\"method\":\"GET\",\"path\":\"/features/{code}\",\"summary\":\"Retrieve a feature\",\"description\":\"This endpoint retrieves an existing feature that represents an entitlement component of your application. The feature is identified by its unique code.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"features\",\"action\":\"list\",\"operation_id\":\"findAllFeatures\",\"method\":\"GET\",\"path\":\"/features\",\"summary\":\"List all features\",\"description\":\"This endpoint retrieves all existing features that represent entitlement components of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search in name, code and description.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"features\",\"action\":\"update\",\"operation_id\":\"updateFeature\",\"method\":\"PUT\",\"path\":\"/features/{code}\",\"summary\":\"Update a feature\",\"description\":\"This endpoint updates an existing feature representing an entitlement component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"body\":{\"wrapper\":\"feature\",\"fields\":[{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the feature.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Name of the feature.\"},{\"path\":[\"privileges\"],\"flag\":\"privileges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Privileges associated with this feature. Can be empty.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"fees\",\"action\":\"delete\",\"operation_id\":\"deleteFee\",\"method\":\"DELETE\",\"path\":\"/fees/{lago_id}\",\"summary\":\"Delete a fee\",\"description\":\"This endpoint is used for deleting a specific fee that has not yet been invoiced\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the fee's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"fees\",\"action\":\"get\",\"operation_id\":\"findFee\",\"method\":\"GET\",\"path\":\"/fees/{lago_id}\",\"summary\":\"Retrieve a specific fee\",\"description\":\"This endpoint is used for retrieving a specific fee that has been issued.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the fee's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"fees\",\"action\":\"list\",\"operation_id\":\"findAllFees\",\"method\":\"GET\",\"path\":\"/fees\",\"summary\":\"List all fees\",\"description\":\"This endpoint is used for retrieving all fees that have been issued.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"External subscription ID\"},{\"name\":\"event_transaction_id\",\"flag\":\"event-transaction-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by event transaction ID\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by the fee's currency.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"fee_type\",\"flag\":\"fee-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`.\",\"enum\":[\"charge\",\"fixed_charge\",\"add_on\",\"subscription\",\"credit\",\"commitment\"]},{\"name\":\"billable_metric_code\",\"flag\":\"billable-metric-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by the `code` of the billable metric attached to the fee. Only applies to `charge` types.\"},{\"name\":\"payment_status\",\"flag\":\"payment-status\",\"in\":\"query\",\"type\":\"string\",\"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 this field are `pending`, `succeeded`, `failed` and `refunded`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\",\"refunded\"]},{\"name\":\"created_at_from\",\"flag\":\"created-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results created at or after this date and time in UTC.\"},{\"name\":\"created_at_to\",\"flag\":\"created-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results created at or before this date and time in UTC.\"},{\"name\":\"succeeded_at_from\",\"flag\":\"succeeded-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment success at or after this date and time in UTC.\"},{\"name\":\"succeeded_at_to\",\"flag\":\"succeeded-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment success at or before this date and time in UTC.\"},{\"name\":\"failed_at_from\",\"flag\":\"failed-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment failure at or after this date and time in UTC.\"},{\"name\":\"failed_at_to\",\"flag\":\"failed-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment failure at or before this date and time in UTC.\"},{\"name\":\"refunded_at_from\",\"flag\":\"refunded-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment refund at or after this date and time in UTC.\"},{\"name\":\"refunded_at_to\",\"flag\":\"refunded-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment refund at or before this date and time in UTC.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"fees\",\"action\":\"update\",\"operation_id\":\"updateFee\",\"method\":\"PUT\",\"path\":\"/fees/{lago_id}\",\"summary\":\"Update a fee\",\"description\":\"This endpoint is used for updating a specific fee that has been issued.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the fee's record within the Lago system.\"}],\"body\":{\"wrapper\":\"fee\",\"fields\":[{\"path\":[\"payment_status\"],\"flag\":\"payment-status\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The payment status of the fee. Possible values are `pending`, `succeeded`, `failed` or `refunded`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\",\"refunded\"]}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"create\",\"operation_id\":\"createInvoice\",\"method\":\"POST\",\"path\":\"/invoices\",\"summary\":\"Create a one-off invoice\",\"description\":\"This endpoint is used for issuing a one-off invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"body\":{\"wrapper\":\"invoice\",\"fields\":[{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity to issue the invoice from. If not provided, the customer's billing entity is used.\"},{\"path\":[\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the invoice.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"path\":[\"fees\"],\"flag\":\"fees\",\"type\":\"array\",\"required\":true,\"complex\":true},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number to associate with the invoice.\"},{\"path\":[\"skip_psp\"],\"flag\":\"skip-psp\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"If true, the invoice will be created but not sent to the payment provider.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"delete\",\"operation_id\":\"deleteInvoice\",\"method\":\"DELETE\",\"path\":\"/invoices/{lago_id}\",\"summary\":\"Delete a draft invoice\",\"description\":\"This endpoint is used for permanently deleting a `draft` invoice. Deleting a draft invoice removes it entirely: it never becomes accounts receivable, consumes no invoice number, and disappears from every list, export, and analytics surface. Only invoices in the `draft` status can be deleted; for a `finalized` invoice, void it instead.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"download\",\"operation_id\":\"downloadInvoice\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/download\",\"summary\":\"Download an invoice PDF\",\"description\":\"This endpoint is used for downloading a specific invoice PDF document.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"finalize\",\"operation_id\":\"finalizeInvoice\",\"method\":\"PUT\",\"path\":\"/invoices/{lago_id}/finalize\",\"summary\":\"Finalize a draft invoice\",\"description\":\"This endpoint is used for finalizing a draft invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"get\",\"operation_id\":\"findInvoice\",\"method\":\"GET\",\"path\":\"/invoices/{lago_id}\",\"summary\":\"Retrieve an invoice\",\"description\":\"This endpoint is used for retrieving a specific invoice that has been issued.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"list\",\"operation_id\":\"findAllInvoices\",\"method\":\"GET\",\"path\":\"/invoices\",\"summary\":\"List all invoices\",\"description\":\"This endpoint is used for retrieving all invoices.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"amount_from\",\"flag\":\"amount-from\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"amount_to\",\"flag\":\"amount-to\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"issuing_date_from\",\"flag\":\"issuing-date-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices starting from a specific date.\"},{\"name\":\"issuing_date_to\",\"flag\":\"issuing-date-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices up to a specific date.\"},{\"name\":\"statuses[]\",\"flag\":\"statuses\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`.\"},{\"name\":\"payment_statuses[]\",\"flag\":\"payment-statuses\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`.\"},{\"name\":\"payment_overdue\",\"flag\":\"payment-overdue\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices by payment_overdue. Possible values are `true` or `false`.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search invoices by id, number, customer name, customer external_id or customer email.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by currency. Possible values ISO 4217 currency codes.\"},{\"name\":\"payment_dispute_lost\",\"flag\":\"payment-dispute-lost\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices with a payment dispute lost. Possible values are `true` or `false`.\"},{\"name\":\"partially_paid\",\"flag\":\"partially-paid\",\"in\":\"query\",\"type\":\"boolean\",\"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. When `false`, those invoices are excluded.\"},{\"name\":\"settlements[]\",\"flag\":\"settlements\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note` matches invoices settled by a credit note.\"},{\"name\":\"invoice_type\",\"flag\":\"invoice-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`.\",\"enum\":[\"subscription\",\"add_on\",\"credit\",\"one_off\",\"advance_charges\",\"progressive_billing\"]},{\"name\":\"self_billed\",\"flag\":\"self-billed\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices by self billed. Possible values are `true` or `false`.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter invoices by billing entity codes. Possible values are the billing entity codes you have created.\"},{\"name\":\"metadata[key]\",\"flag\":\"metadata[key]\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for invoice without given metadata key. For example, `metadata[color]=blue`.\"},{\"name\":\"purchase_order_number\",\"flag\":\"purchase-order-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by the invoice purchase order number. The match is exact but case-insensitive.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"lose-dispute\",\"operation_id\":\"loseDisputeInvoice\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/lose_dispute\",\"summary\":\"Mark an invoice payment dispute as lost\",\"description\":\"This endpoint is used for setting invoice's payment dispute as lost.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"payment-url\",\"operation_id\":\"invoicePaymentUrl\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/payment_url\",\"summary\":\"Generate a payment URL\",\"description\":\"This endpoint generates a checkout link for a specific invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"preview\",\"operation_id\":\"invoicePreview\",\"method\":\"POST\",\"path\":\"/invoices/preview\",\"summary\":\"Create an invoice preview\",\"description\":\"This endpoint is used for generating invoice preview.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"body\":{\"fields\":[{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity to which will be associated a customer if the external_id is not provided. If billing_entity_code is not provided, default billing_entity of organization will be used.\"},{\"path\":[\"billing_time\"],\"flag\":\"billing-time\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).\",\"enum\":[\"calendar\",\"anniversary\"]},{\"path\":[\"coupons\"],\"flag\":\"coupons\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"customer\",\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"customer\",\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"customer\",\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The city of the customer's billing address\"},{\"path\":[\"customer\",\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)\",\"enum\":[\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"customer\",\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the invoice.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"customer\",\"external_id\"],\"flag\":\"external-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"path\":[\"customer\",\"integration_customers\"],\"flag\":\"integration-customers\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"customer\",\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The full name of the customer\"},{\"path\":[\"customer\",\"shipping_address\",\"address_line1\"],\"flag\":\"shipping-address-address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"customer\",\"shipping_address\",\"address_line2\"],\"flag\":\"shipping-address-address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"customer\",\"shipping_address\",\"city\"],\"flag\":\"shipping-address-city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the customer's billing address\"},{\"path\":[\"customer\",\"shipping_address\",\"country\"],\"flag\":\"shipping-address-country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"customer\",\"shipping_address\",\"state\"],\"flag\":\"shipping-address-state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the customer's billing address\"},{\"path\":[\"customer\",\"shipping_address\",\"zipcode\"],\"flag\":\"shipping-address-zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the customer's billing address\"},{\"path\":[\"customer\",\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The state of the customer's billing address\"},{\"path\":[\"customer\",\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The tax identification number of the customer\"},{\"path\":[\"customer\",\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone\",\"enum\":[\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Nuuk\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"plan_code\"],\"flag\":\"plan-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"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 system-level identification purposes, like assigning a subscription, for instance.\"},{\"path\":[\"subscription_at\"],\"flag\":\"subscription-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"subscriptions\",\"external_ids\"],\"flag\":\"subscriptions-external-ids\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"subscriptions\",\"plan_code\"],\"flag\":\"subscriptions-plan-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the plan. It serves as a unique identifier associated with the new plan to which the customer is upgrading or downgrading.\"},{\"path\":[\"subscriptions\",\"terminated_at\"],\"flag\":\"subscriptions-terminated-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The date and time when the subscription is terminated. It should defined in the future.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"refresh\",\"operation_id\":\"refreshInvoice\",\"method\":\"PUT\",\"path\":\"/invoices/{lago_id}/refresh\",\"summary\":\"Refresh a draft invoice\",\"description\":\"This endpoint is used for refreshing a draft invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"retry\",\"operation_id\":\"retryInvoice\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/retry\",\"summary\":\"Retry generation of a failed invoice\",\"description\":\"This endpoint is used for retrying to generate a failed invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"retry-payment\",\"operation_id\":\"retryPayment\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/retry_payment\",\"summary\":\"Retry an invoice payment\",\"description\":\"This endpoint resends an invoice for collection and retry a payment.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"body\":{\"wrapper\":\"payment_method\",\"fields\":[{\"path\":[\"payment_method_id\"],\"flag\":\"payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method_type\"],\"flag\":\"payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"update\",\"operation_id\":\"updateInvoice\",\"method\":\"PUT\",\"path\":\"/invoices/{lago_id}\",\"summary\":\"Update an invoice\",\"description\":\"This endpoint is used for updating an existing invoice. A voided invoice cannot be updated and returns a `405` error.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"body\":{\"wrapper\":\"invoice\",\"fields\":[{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"payment_status\"],\"flag\":\"payment-status\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The payment status of the invoice. Possible values are `pending`, `failed` or `succeeded`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"void\",\"operation_id\":\"voidInvoice\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/void\",\"summary\":\"Void an invoice\",\"description\":\"This endpoint is used for voiding an invoice.\\n• When no body parameters are provided, the invoice can be voided only if it is in a `finalized` status and its payment status is NOT `succeeded`.\\n• When `generate_credit_note` is provided (optionally with `refund_amount` and/or `credit_amount`), this validation is bypassed: the invoice is forcibly voided and a credit note is generated. If the specified refund/credit amounts do not cover the full invoice total, the remainder is issued on a second credit note that is created and immediately voided.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"body\":{\"fields\":[{\"path\":[\"credit_amount\"],\"flag\":\"credit-amount\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Portion of the invoice amount (in cents) to be credited to the customer's balance in the generated credit note.\"},{\"path\":[\"generate_credit_note\"],\"flag\":\"generate-credit-note\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to force voiding the invoice and generate a credit note.\"},{\"path\":[\"refund_amount\"],\"flag\":\"refund-amount\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Portion of the invoice amount (in cents) to be refunded to the customer in the generated credit note.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"order-forms\",\"action\":\"get\",\"operation_id\":\"findOrderForm\",\"method\":\"GET\",\"path\":\"/order_forms/{lago_id}\",\"summary\":\"Retrieve an order form\",\"description\":\"This endpoint retrieves a specific order form.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order form's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"order-forms\",\"action\":\"list\",\"operation_id\":\"findAllOrderForms\",\"method\":\"GET\",\"path\":\"/order_forms\",\"summary\":\"List all order forms\",\"description\":\"This endpoint is used to list all existing order forms.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by status. Possible values are `generated`, `signed`, `expired` and `voided`.\"},{\"name\":\"customer_id[]\",\"flag\":\"customer-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by the Lago identifiers of their customers.\"},{\"name\":\"number[]\",\"flag\":\"number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by their number, as assigned by Lago.\"},{\"name\":\"quote_number[]\",\"flag\":\"quote-number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by the number of the quote they come from.\"},{\"name\":\"owner_id[]\",\"flag\":\"owner-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by the Lago identifiers of the users owning the quote they come from.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search order forms by number.\"},{\"name\":\"created_at_from\",\"flag\":\"created-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter order forms created from a specific date and time, in UTC (ISO 8601).\"},{\"name\":\"created_at_to\",\"flag\":\"created-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter order forms created up to a specific date and time, in UTC (ISO 8601).\"},{\"name\":\"expires_at_from\",\"flag\":\"expires-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"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\",\"flag\":\"expires-at-to\",\"in\":\"query\",\"type\":\"string\",\"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.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"order-forms\",\"action\":\"mark-as-signed\",\"operation_id\":\"markOrderFormAsSigned\",\"method\":\"POST\",\"path\":\"/order_forms/{lago_id}/mark_as_signed\",\"summary\":\"Mark an order form as signed\",\"description\":\"This endpoint records the customer's signature on an order form, and creates the order that carries the quoted deal out.\\nOnly a `generated` order form can be signed, so a `422` is returned once the order form has been signed, has expired or has been voided.\\nAn `execute_at` landing on or after the day the quoted deal stops being executable is rejected as well, so the order can never be scheduled past the term it bills.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order form's record within the Lago system.\"}],\"body\":{\"wrapper\":\"order_form\",\"fields\":[{\"path\":[\"execute_at\"],\"flag\":\"execute-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The date and time in UTC (ISO 8601) when Lago executes the order created from the order form. It must be in the future, requires `execution_mode` to be set, and must fall strictly before the day the quoted deal stops being executable, otherwise signing is rejected with a `422`. When it is omitted, the order is created but not scheduled, and waits to be executed on demand.\"},{\"path\":[\"execution_mode\"],\"flag\":\"execution-mode\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"How the order created from the order form is carried out. It becomes mandatory as soon as `execute_at` is provided.\",\"enum\":[\"execute_in_lago\",\"order_only\"]},{\"path\":[\"signed_document\"],\"flag\":\"signed-document\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The document signed by the customer, as a base64 data URI (`data:\\u003ccontent_type\\u003e;base64,\\u003cdata\\u003e`). Accepted content types are `application/pdf`, `image/jpeg` and `image/png`, for a maximum of 10 MB. Once attached, it is exposed as `signed_document_url` on the order form.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"order-forms\",\"action\":\"void\",\"operation_id\":\"voidOrderForm\",\"method\":\"POST\",\"path\":\"/order_forms/{lago_id}/void\",\"summary\":\"Void an order form\",\"description\":\"This endpoint voids an order form, with the `manual` reason, and cascades to the quote version it was generated from, which is voided with the `cascade_of_voided` reason.\\nOnly a `generated` order form can be voided, so a `422` is returned once the order form has been signed, has expired or has already been voided.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order form's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"orders\",\"action\":\"execute\",\"operation_id\":\"executeOrder\",\"method\":\"POST\",\"path\":\"/orders/{lago_id}/execute\",\"summary\":\"Execute an order\",\"description\":\"This endpoint carries out an order on demand, without waiting for its `execute_at` schedule. It runs synchronously, so the response carries the resulting status and, when the execution fails, the reason it failed.\\nAn `execute_in_lago` order applies the quoted deal, creating the subscriptions, coupons, wallets or one-off invoice it describes; an `order_only` order is simply marked as executed. What the execution produced is listed in `execution_record`.\\nExecuting is idempotent: an order that has already been executed is returned untouched. An order whose previous execution failed is executed again, and a `422` is returned when the order carries no execution mode and none is provided in the body.\\nRestating an `execution_mode` that differs from the one stored on the order updates it first, which only succeeds while the order is still `created`: a `failed` order can be retried, but not switched to another mode. That update also re-validates the order's own `execute_at` against the day the quoted deal stops being executable, so a `422` is possible even though no date was sent. An order carrying no `execute_at` is not bounded that way, and a deal whose term has passed then only fails when the execution runs.\\nA `404` is not limited to an unknown order: when the execution cannot find a catalog record the quote pinned, such as a deleted plan, charge, coupon or the subscription being amended, the missing resource is reported as a `404` and the order is left `failed`.\\nConcurrency is reported two ways. A mode change losing the race on the quote comes back as a `422` validation error, while the execution itself losing it comes back as a `422` carrying a lock code, because a scheduled execution relies on that error to be retried.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order's record within the Lago system.\"}],\"body\":{\"wrapper\":\"order\",\"fields\":[{\"path\":[\"execution_mode\"],\"flag\":\"execution-mode\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"How the order is carried out. It is only persisted when it differs from the mode already stored on the order, so restating the current mode never fails. Changing the mode of an order that has already been executed is rejected.\",\"enum\":[\"execute_in_lago\",\"order_only\"]}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"orders\",\"action\":\"get\",\"operation_id\":\"findOrder\",\"method\":\"GET\",\"path\":\"/orders/{lago_id}\",\"summary\":\"Retrieve an order\",\"description\":\"This endpoint retrieves a specific order, along with the `billing_snapshot` its execution applies and the `execution_record` of what it produced.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"orders\",\"action\":\"list\",\"operation_id\":\"findAllOrders\",\"method\":\"GET\",\"path\":\"/orders\",\"summary\":\"List all orders\",\"description\":\"This endpoint is used to list all existing orders.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by status. Possible values are `created`, `executed` and `failed`.\"},{\"name\":\"order_type[]\",\"flag\":\"order-type\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the order type of the quote they come from. Possible values are `subscription_creation`, `subscription_amendment` and `one_off`.\"},{\"name\":\"execution_mode[]\",\"flag\":\"execution-mode\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by execution mode. Possible values are `execute_in_lago` and `order_only`.\"},{\"name\":\"customer_id[]\",\"flag\":\"customer-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the Lago identifiers of their customers.\"},{\"name\":\"number[]\",\"flag\":\"number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by their number, as assigned by Lago.\"},{\"name\":\"order_form_number[]\",\"flag\":\"order-form-number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the number of the order form they come from.\"},{\"name\":\"quote_number[]\",\"flag\":\"quote-number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the number of the quote they come from.\"},{\"name\":\"owner_id[]\",\"flag\":\"owner-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the Lago identifiers of the users owning the quote they come from.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search orders by number.\"},{\"name\":\"executed_at_from\",\"flag\":\"executed-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"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\",\"flag\":\"executed-at-to\",\"in\":\"query\",\"type\":\"string\",\"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.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"organizations\",\"action\":\"get\",\"operation_id\":\"findOrganization\",\"method\":\"GET\",\"path\":\"/organizations\",\"summary\":\"Retrieve your organization\",\"description\":\"This endpoint retrieves your own organization's settings.\",\"docs_url\":\"https://getlago.com/docs/api-reference/organizations/organization-object\",\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"organizations\",\"action\":\"update\",\"operation_id\":\"updateOrganization\",\"method\":\"PUT\",\"path\":\"/organizations\",\"summary\":\"Update your organization\",\"description\":\"This endpoint is used to update your own organization's settings.\",\"docs_url\":\"https://getlago.com/docs/api-reference/organizations/organization-object\",\"body\":{\"wrapper\":\"organization\",\"fields\":[{\"path\":[\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of your organization's billing address.\"},{\"path\":[\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of your organization's billing address.\"},{\"path\":[\"billing_configuration\",\"document_locale\"],\"flag\":\"billing-configuration-document-locale\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The locale of the billing documents, expressed in the ISO 639-1 format. This field indicates the language or regional variant used for the documents content issued or the embeddable customer portal.\"},{\"path\":[\"billing_configuration\",\"invoice_footer\"],\"flag\":\"billing-configuration-invoice-footer\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The customer invoice message that appears at the bottom of each billing documents.\"},{\"path\":[\"billing_configuration\",\"invoice_grace_period\"],\"flag\":\"billing-configuration-invoice-grace-period\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer's grace period.\"},{\"path\":[\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of your organization's billing address.\"},{\"path\":[\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The country of your organization.\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"default_currency\"],\"flag\":\"default-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The default currency of an organization.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"document_number_prefix\"],\"flag\":\"document-number-prefix\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.\"},{\"path\":[\"document_numbering\"],\"flag\":\"document-numbering\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"This parameter configures the method of incrementing invoice numbers for your customers.\\n\\n- `per_customer`: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.\\n- `per_organization`: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.\\n\\nThe default value for `document_numbering` is set to `per_customer`, meaning that, unless changed, invoice numbers will increment uniquely for each customer.\",\"enum\":[\"per_customer\",\"per_organization\"]},{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The email address of your organization used to bill your customers.\"},{\"path\":[\"email_settings\"],\"flag\":\"email-settings\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values are `invoice.finalized`, `credit_note.created` and `payment_receipt.created`.\"},{\"path\":[\"finalize_zero_amount_invoice\"],\"flag\":\"finalize-zero-amount-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.\"},{\"path\":[\"legal_name\"],\"flag\":\"legal-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal name of your organization.\"},{\"path\":[\"legal_number\"],\"flag\":\"legal-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal number of your organization.\"},{\"path\":[\"net_payment_term\"],\"flag\":\"net-payment-term\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.\"},{\"path\":[\"slug\"],\"flag\":\"slug\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"A concise and unique identifier for your organization, used as a prefix in customer slugs.\"},{\"path\":[\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of your organization's billing address.\"},{\"path\":[\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The tax identification number of your organization.\"},{\"path\":[\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.\",\"enum\":[\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Nuuk\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"webhook_url\"],\"flag\":\"webhook-url\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner.\"},{\"path\":[\"zipcode\"],\"flag\":\"zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of your organization's billing address.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"payment-methods\",\"action\":\"destroy\",\"operation_id\":\"destroyPaymentMethod\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/payment_methods/{lago_id}\",\"summary\":\"Delete a payment method\",\"description\":\"This endpoint deletes a specific payment method for a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-methods/payment-method-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The payment method unique identifier, created by Lago.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"payment-methods\",\"action\":\"list-customers-payment-methods\",\"operation_id\":\"findAllCustomersPaymentMethods\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/payment_methods\",\"summary\":\"List all customer payment methods\",\"description\":\"This endpoint retrieves all payment methods of a Customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-methods/payment-method-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"payment-methods\",\"action\":\"payment-method-set-as-default\",\"operation_id\":\"paymentMethodSetAsDefault\",\"method\":\"PUT\",\"path\":\"/customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default\",\"summary\":\"Set the payment method as default\",\"description\":\"Use the payment method as default when not selected a payment method\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-methods/payment-method-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The payment method unique identifier, created by Lago.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"payment-receipts\",\"action\":\"get\",\"operation_id\":\"findPaymentReceipt\",\"method\":\"GET\",\"path\":\"/payment_receipts/{lago_id}\",\"summary\":\"Retrieve a payment receipt\",\"description\":\"This endpoint retrieves a specific payment receipt.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-receipts/payment-receipt-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Payment receipt ID\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"payment-receipts\",\"action\":\"list\",\"operation_id\":\"findAllPaymentReceipts\",\"method\":\"GET\",\"path\":\"/payment_receipts\",\"summary\":\"List all payment receipts\",\"description\":\"This endpoint is used to list all existing payment receipts.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-receipts/payment-receipt-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"invoice_id\",\"flag\":\"invoice-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter payment receipts by invoice id.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"payment-requests\",\"action\":\"create\",\"operation_id\":\"createPaymentRequest\",\"method\":\"POST\",\"path\":\"/payment_requests\",\"summary\":\"Create a payment request\",\"description\":\"This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-requests/payment-request-object\",\"body\":{\"wrapper\":\"payment_request\",\"fields\":[{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer's email address used for sending dunning notifications\"},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"lago_invoice_ids\"],\"flag\":\"lago-invoice-ids\",\"type\":\"array\",\"required\":true,\"complex\":true,\"description\":\"A list of Lago IDs for the customer's overdue invoices to start the dunning process\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"payment-requests\",\"action\":\"get\",\"operation_id\":\"findPaymentRequest\",\"method\":\"GET\",\"path\":\"/payment_requests/{lago_id}\",\"summary\":\"Retrieve a payment request\",\"description\":\"This endpoint retrieves a specific payment request by its ID.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-requests/payment-request-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the payment request.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"payment-requests\",\"action\":\"list\",\"operation_id\":\"findAllPaymentRequests\",\"method\":\"GET\",\"path\":\"/payment_requests\",\"summary\":\"List all payment requests\",\"description\":\"This endpoint is used to list all existing payment requests.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-requests/payment-request-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter the results by currency, expressed as an ISO 4217 code.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"payment_status\",\"flag\":\"payment-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by payment status. Possible values are `pending`, `failed` or `succeeded`.\",\"enum\":[\"pending\",\"failed\",\"succeeded\"]},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter payment requests by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"payments\",\"action\":\"create\",\"operation_id\":\"createPayment\",\"method\":\"POST\",\"path\":\"/payments\",\"summary\":\"Create a payment\",\"description\":\"This endpoint is used to create a manual payment\",\"docs_url\":\"https://getlago.com/docs/api-reference/payments/payment-object\",\"body\":{\"wrapper\":\"payment\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":true,\"complex\":false,\"description\":\"The payment amount in cents\"},{\"path\":[\"invoice_id\"],\"flag\":\"invoice-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique identifier assigned to the invoice\"},{\"path\":[\"paid_at\"],\"flag\":\"paid-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The date the payment was made\"},{\"path\":[\"reference\"],\"flag\":\"reference\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Reference for the payment\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"payments\",\"action\":\"get\",\"operation_id\":\"findPayment\",\"method\":\"GET\",\"path\":\"/payments/{lago_id}\",\"summary\":\"Retrieve a payment\",\"description\":\"This endpoint retrieves a specific payment by its ID.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payments/payment-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the payment.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"payments\",\"action\":\"list\",\"operation_id\":\"findAllPayments\",\"method\":\"GET\",\"path\":\"/payments\",\"summary\":\"List all payments\",\"description\":\"This endpoint is used to list all payments\",\"docs_url\":\"https://getlago.com/docs/api-reference/payments/payment-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"invoice_id\",\"flag\":\"invoice-id\",\"in\":\"query\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"charges\",\"operation_id\":\"findAllPlanCharges\",\"method\":\"GET\",\"path\":\"/plans/{code}/charges\",\"summary\":\"List all charges for a plan\",\"description\":\"This endpoint retrieves all charges for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"create\",\"operation_id\":\"createPlan\",\"method\":\"POST\",\"path\":\"/plans\",\"summary\":\"Create a plan\",\"description\":\"This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"body\":{\"wrapper\":\"plan\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":true,\"complex\":false,\"description\":\"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"bill_charges_monthly\"],\"flag\":\"bill-charges-monthly\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is `yearly` or `semiannual`. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`.\"},{\"path\":[\"bill_fixed_charges_monthly\"],\"flag\":\"bill-fixed-charges-monthly\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field, when set to `true`, enables to invoice fixed charges on monthly basis, even if the cadence of the plan is `yearly` or `semiannual`. This allows customers to pay fixed charges on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`.\"},{\"path\":[\"charges\"],\"flag\":\"charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional usage-based charges for this plan.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"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 system-level identification purposes, like assigning a subscription, for instance.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The description on the plan.\"},{\"path\":[\"fixed_charges\"],\"flag\":\"fixed-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional fixed charges for this plan.\"},{\"path\":[\"interval\"],\"flag\":\"interval\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `semiannual`, `quarterly`, `monthly`, or `weekly`.\",\"enum\":[\"weekly\",\"monthly\",\"quarterly\",\"semiannual\",\"yearly\"]},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"minimum_commitment\",\"amount_cents\"],\"flag\":\"minimum-commitment-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the minimum commitment in cents.\"},{\"path\":[\"minimum_commitment\",\"invoice_display_name\"],\"flag\":\"minimum-commitment-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.\"},{\"path\":[\"minimum_commitment\",\"tax_codes\"],\"flag\":\"minimum-commitment-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The name of the plan.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":true,\"complex\":false,\"description\":\"This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"trial_period\"],\"flag\":\"trial-period\",\"type\":\"number\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The duration in days during which the base cost of the plan is offered for free.\"},{\"path\":[\"usage_thresholds\"],\"flag\":\"usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of usage thresholds to apply to the plan.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"create-plan-charge\",\"operation_id\":\"createPlanCharge\",\"method\":\"POST\",\"path\":\"/plans/{code}/charges\",\"summary\":\"Create a charge\",\"description\":\"This endpoint creates a new charge for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"body\":{\"wrapper\":\"charge\",\"fields\":[{\"path\":[\"accepts_target_wallet\"],\"flag\":\"accepts-target-wallet\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies whether the charge accepts a target wallet for prepaid credits deduction.\\nWhen set to `true`, events may include a `target_wallet_code` in their `properties` to direct credit deduction to a specific wallet.\\nIf no `target_wallet_code` is provided on the event, the standard wallet selection logic is applied.\\nIf the `target_wallet_code` does not match an existing wallet, no credits will be applied for that event.\\n\\nThis field requires a premium integration.\"},{\"path\":[\"applied_pricing_unit\",\"code\"],\"flag\":\"applied-pricing-unit-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the pricing unit.\"},{\"path\":[\"applied_pricing_unit\",\"conversion_rate\"],\"flag\":\"applied-pricing-unit-conversion-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The conversion rate from pricing units to the plan's currency.\\nThis rate determines how many currency units (in the plan's base currency) equal one pricing unit.\\nFor example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50.\"},{\"path\":[\"billable_metric_id\"],\"flag\":\"billable-metric-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique identifier of the billable metric created by Lago.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the creation of the charge should be cascaded to the children plans. When set to `true`, the charge will be created in children plans. Conversely, when set to `false`, the charge will only be created in the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charge_model\"],\"flag\":\"charge-model\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:\\n - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)\\n - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)\\n - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)\\n - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)\\n - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)\\n - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)\\n - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)\\n\",\"enum\":[\"dynamic\",\"graduated\",\"graduated_percentage\",\"package\",\"percentage\",\"standard\",\"volume\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying the charge within the plan.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of filters used to apply differentiated pricing based on additional event properties.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"invoiceable\"],\"flag\":\"invoiceable\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.\"},{\"path\":[\"min_amount_cents\"],\"flag\":\"min-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"presentation_group_keys\"],\"flag\":\"properties-presentation-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Groups usage into sub-items on invoices for display only, without affecting pricing or aggregation.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"prorated\"],\"flag\":\"prorated\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.\\n\\n- If set to `true`, the charge is prorated based on the remaining days in the current billing period.\\n- If set to `false`, the charge is billed in full.\\n- If not defined in the request, default value is `false`.\"},{\"path\":[\"regroup_paid_fees\"],\"flag\":\"regroup-paid-fees\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.\\nThis field determines whether and when the charge fee should be included in\\nthe invoice. If `null`, no invoice will be issued for this charge fee.\\nIf `invoice`, an invoice will be generated at the end of the period,\\nconsolidating all charge fees with a succeeded payment status.\",\"enum\":[\"\",\"invoice\"]},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"create-plan-charge-filter\",\"operation_id\":\"createPlanChargeFilter\",\"method\":\"POST\",\"path\":\"/plans/{code}/charges/{charge_code}/filters\",\"summary\":\"Create a charge filter\",\"description\":\"This endpoint creates a new filter for a specific charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the creation of the filter should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"values\"],\"flag\":\"values\",\"type\":\"object\",\"required\":true,\"complex\":true,\"description\":\"List of possible filter values. The key and values must match one of the billable metric filters.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"create-plan-fixed-charge\",\"operation_id\":\"createPlanFixedCharge\",\"method\":\"POST\",\"path\":\"/plans/{code}/fixed_charges\",\"summary\":\"Create a fixed charge\",\"description\":\"This endpoint creates a new fixed charge for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"body\":{\"wrapper\":\"fixed_charge\",\"fields\":[{\"path\":[\"add_on_code\"],\"flag\":\"add-on-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying an add-on. Either add_on_id or add_on_code is required.\"},{\"path\":[\"add_on_id\"],\"flag\":\"add-on-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique identifier of the add-on. Either add_on_id or add_on_code is required.\"},{\"path\":[\"apply_units_immediately\"],\"flag\":\"apply-units-immediately\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the fixed charge units are applied immediately for active subscriptions. When set to `false`, the units are applied at the next billing period.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the creation of the fixed charge should be cascaded to the children plans. When set to `true`, the fixed charge will be created in children plans. Conversely, when set to `false`, the fixed charge will only be created in the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charge_model\"],\"flag\":\"charge-model\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the pricing model used for the calculation of the fixed charge fee. It can be any of the following values:\\n - `standard`\\n - `graduated`\\n - `volume`\\n\",\"enum\":[\"standard\",\"graduated\",\"volume\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying the fixed charge within the plan.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the add-on will be used as the default display name.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for this fixed charge. When set to `true`, the charge is due and invoiced immediately at the beginning of the billing period. When set to `false`, the charge is due and invoiced at the end of the billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"prorated\"],\"flag\":\"prorated\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Specifies whether a fixed charge is prorated based on the remaining number of days in the billing period or billed fully.\\n\\n- If set to `true`, the charge is prorated based on the remaining days in the current billing period.\\n- If set to `false`, the charge is billed in full.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"units\"],\"flag\":\"units\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units for the fixed charge.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"delete\",\"operation_id\":\"destroyPlan\",\"method\":\"DELETE\",\"path\":\"/plans/{code}\",\"summary\":\"Delete a plan\",\"description\":\"This endpoint deletes a specific plan. Note that this plan could be associated with active subscriptions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes, like assigning a subscription, for instance.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"delete-all-plan-metadata\",\"operation_id\":\"deleteAllPlanMetadata\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/metadata\",\"summary\":\"Delete all plan metadata\",\"description\":\"This endpoint removes all metadata from a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The code of the plan.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"delete-plan-metadata-key\",\"operation_id\":\"deletePlanMetadataKey\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/metadata/{key}\",\"summary\":\"Delete a metadata key\",\"description\":\"This endpoint removes a single metadata key from a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The code of the plan.\"},{\"name\":\"key\",\"flag\":\"key\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The metadata key to delete.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"destroy-plan-charge\",\"operation_id\":\"destroyPlanCharge\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/charges/{charge_code}\",\"summary\":\"Delete a charge\",\"description\":\"This endpoint deletes a specific charge from a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"}],\"body\":{\"wrapper\":\"charge\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the deletion will be cascaded to the children plans.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"destroy-plan-charge-filter\",\"operation_id\":\"destroyPlanChargeFilter\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Delete a charge filter\",\"description\":\"This endpoint deletes a specific filter from a charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the deletion will be cascaded to the children plans.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"destroy-plan-fixed-charge\",\"operation_id\":\"destroyPlanFixedCharge\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Delete a fixed charge\",\"description\":\"This endpoint deletes a specific fixed charge from a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"}],\"body\":{\"wrapper\":\"fixed_charge\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the deletion will be cascaded to the children plans.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"filters\",\"operation_id\":\"findAllPlanChargeFilters\",\"method\":\"GET\",\"path\":\"/plans/{code}/charges/{charge_code}/filters\",\"summary\":\"List all filters for a charge\",\"description\":\"This endpoint retrieves all filters for a specific charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"fixed-charges\",\"operation_id\":\"findAllPlanFixedCharges\",\"method\":\"GET\",\"path\":\"/plans/{code}/fixed_charges\",\"summary\":\"List all fixed charges for a plan\",\"description\":\"This endpoint retrieves all fixed charges for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"get\",\"operation_id\":\"findPlan\",\"method\":\"GET\",\"path\":\"/plans/{code}\",\"summary\":\"Retrieve a plan\",\"description\":\"This endpoint retrieves a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes, like assigning a subscription, for instance.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"get-plan-charge\",\"operation_id\":\"findPlanCharge\",\"method\":\"GET\",\"path\":\"/plans/{code}/charges/{charge_code}\",\"summary\":\"Retrieve a charge\",\"description\":\"This endpoint retrieves a specific charge for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"get-plan-charge-filter\",\"operation_id\":\"findPlanChargeFilter\",\"method\":\"GET\",\"path\":\"/plans/{code}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Retrieve a charge filter\",\"description\":\"This endpoint retrieves a specific filter for a charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"get-plan-fixed-charge\",\"operation_id\":\"findPlanFixedCharge\",\"method\":\"GET\",\"path\":\"/plans/{code}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Retrieve a fixed charge\",\"description\":\"This endpoint retrieves a specific fixed charge for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"list\",\"operation_id\":\"findAllPlans\",\"method\":\"GET\",\"path\":\"/plans\",\"summary\":\"List all plans\",\"description\":\"This endpoint retrieves all existing plans.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"merge-plan-metadata\",\"operation_id\":\"mergePlanMetadata\",\"method\":\"PATCH\",\"path\":\"/plans/{code}/metadata\",\"summary\":\"Merge plan metadata\",\"description\":\"This endpoint merges the provided metadata with existing metadata on the plan.\\nExisting keys not in the request are preserved. New keys are added, existing keys are updated.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The code of the plan.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"metadata\",\"operation_id\":\"replacePlanMetadata\",\"method\":\"POST\",\"path\":\"/plans/{code}/metadata\",\"summary\":\"Replace plan metadata\",\"description\":\"This endpoint replaces all existing metadata on a plan with the provided key-value pairs.\\nAny existing metadata keys not included in the request will be removed.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The code of the plan.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"update\",\"operation_id\":\"updatePlan\",\"method\":\"PUT\",\"path\":\"/plans/{code}\",\"summary\":\"Update a plan\",\"description\":\"This endpoint updates a specific plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes, like assigning a subscription, for instance.\"}],\"body\":{\"wrapper\":\"plan\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"bill_charges_monthly\"],\"flag\":\"bill-charges-monthly\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly or semiannual. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`.\"},{\"path\":[\"bill_fixed_charges_monthly\"],\"flag\":\"bill-fixed-charges-monthly\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field, when set to `true`, enables to invoice fixed charges on monthly basis, even if the cadence of the plan is `yearly` or `semiannual`. This allows customers to pay fixed charges on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the plan should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charges\"],\"flag\":\"charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional usage-based charges for this plan.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"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 system-level identification purposes, like assigning a subscription, for instance.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The description on the plan.\"},{\"path\":[\"fixed_charges\"],\"flag\":\"fixed-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional fixed charges for this plan.\"},{\"path\":[\"interval\"],\"flag\":\"interval\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `semiannual`, `quarterly`, `monthly`, or `weekly`.\",\"enum\":[\"weekly\",\"monthly\",\"quarterly\",\"semiannual\",\"yearly\"]},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"minimum_commitment\",\"amount_cents\"],\"flag\":\"minimum-commitment-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the minimum commitment in cents.\"},{\"path\":[\"minimum_commitment\",\"invoice_display_name\"],\"flag\":\"minimum-commitment-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.\"},{\"path\":[\"minimum_commitment\",\"tax_codes\"],\"flag\":\"minimum-commitment-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the plan.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"trial_period\"],\"flag\":\"trial-period\",\"type\":\"number\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The duration in days during which the base cost of the plan is offered for free.\"},{\"path\":[\"usage_thresholds\"],\"flag\":\"usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of usage thresholds to apply to the plan.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"update-plan-charge\",\"operation_id\":\"updatePlanCharge\",\"method\":\"PUT\",\"path\":\"/plans/{code}/charges/{charge_code}\",\"summary\":\"Update a charge\",\"description\":\"This endpoint updates a specific charge for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"}],\"body\":{\"wrapper\":\"charge\",\"fields\":[{\"path\":[\"accepts_target_wallet\"],\"flag\":\"accepts-target-wallet\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies whether the charge accepts a target wallet for prepaid credits deduction.\\nWhen set to `true`, events may include a `target_wallet_code` in their `properties` to direct credit deduction to a specific wallet.\\nIf no `target_wallet_code` is provided on the event, the standard wallet selection logic is applied.\\nIf the `target_wallet_code` does not match an existing wallet, no credits will be applied for that event.\\n\\nThis field requires a premium integration.\"},{\"path\":[\"applied_pricing_unit\",\"code\"],\"flag\":\"applied-pricing-unit-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the pricing unit.\"},{\"path\":[\"applied_pricing_unit\",\"conversion_rate\"],\"flag\":\"applied-pricing-unit-conversion-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The conversion rate from pricing units to the plan's currency.\\nThis rate determines how many currency units (in the plan's base currency) equal one pricing unit.\\nFor example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50.\"},{\"path\":[\"billable_metric_id\"],\"flag\":\"billable-metric-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique identifier of the billable metric created by Lago.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the charge should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charge_model\"],\"flag\":\"charge-model\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:\\n - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)\\n - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)\\n - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)\\n - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)\\n - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)\\n - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)\\n - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)\\n\",\"enum\":[\"dynamic\",\"graduated\",\"graduated_percentage\",\"package\",\"percentage\",\"standard\",\"volume\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying the charge within the plan.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of filters used to apply differentiated pricing based on additional event properties.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"invoiceable\"],\"flag\":\"invoiceable\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.\"},{\"path\":[\"min_amount_cents\"],\"flag\":\"min-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"presentation_group_keys\"],\"flag\":\"properties-presentation-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Groups usage into sub-items on invoices for display only, without affecting pricing or aggregation.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"prorated\"],\"flag\":\"prorated\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.\\n\\n- If set to `true`, the charge is prorated based on the remaining days in the current billing period.\\n- If set to `false`, the charge is billed in full.\\n- If not defined in the request, default value is `false`.\"},{\"path\":[\"regroup_paid_fees\"],\"flag\":\"regroup-paid-fees\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.\\nThis field determines whether and when the charge fee should be included in\\nthe invoice. If `null`, no invoice will be issued for this charge fee.\\nIf `invoice`, an invoice will be generated at the end of the period,\\nconsolidating all charge fees with a succeeded payment status.\",\"enum\":[\"\",\"invoice\"]},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"update-plan-charge-filter\",\"operation_id\":\"updatePlanChargeFilter\",\"method\":\"PUT\",\"path\":\"/plans/{code}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Update a charge filter\",\"description\":\"This endpoint updates a specific filter for a charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the filter should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"values\"],\"flag\":\"values\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"List of possible filter values. The key and values must match one of the billable metric filters.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"update-plan-fixed-charge\",\"operation_id\":\"updatePlanFixedCharge\",\"method\":\"PUT\",\"path\":\"/plans/{code}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Update a fixed charge\",\"description\":\"This endpoint updates a specific fixed charge for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"}],\"body\":{\"wrapper\":\"fixed_charge\",\"fields\":[{\"path\":[\"add_on_code\"],\"flag\":\"add-on-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying an add-on. Either add_on_id or add_on_code is required.\"},{\"path\":[\"add_on_id\"],\"flag\":\"add-on-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique identifier of the add-on. Either add_on_id or add_on_code is required.\"},{\"path\":[\"apply_units_immediately\"],\"flag\":\"apply-units-immediately\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the fixed charge units are applied immediately for active subscriptions. When set to `false`, the units are applied at the next billing period.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the fixed charge should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charge_model\"],\"flag\":\"charge-model\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the pricing model used for the calculation of the fixed charge fee. It can be any of the following values:\\n - `standard`\\n - `graduated`\\n - `volume`\\n\",\"enum\":[\"standard\",\"graduated\",\"volume\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying the fixed charge within the plan.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the add-on will be used as the default display name.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for this fixed charge. When set to `true`, the charge is due and invoiced immediately at the beginning of the billing period. When set to `false`, the charge is due and invoiced at the end of the billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"prorated\"],\"flag\":\"prorated\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Specifies whether a fixed charge is prorated based on the remaining number of days in the billing period or billed fully.\\n\\n- If set to `true`, the charge is prorated based on the remaining days in the current billing period.\\n- If set to `false`, the charge is billed in full.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"units\"],\"flag\":\"units\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units for the fixed charge.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"quotes\",\"action\":\"approve-quote-version\",\"operation_id\":\"approveQuoteVersion\",\"method\":\"POST\",\"path\":\"/quote_versions/{lago_id}/approve\",\"summary\":\"Approve a quote version\",\"description\":\"This endpoint approves a quote version and generates the order form to send to the customer for signature.\\nOnly a `draft` version can be approved, and its `billing_items` must be complete: approval validates them against the catalog and against the customer, and returns a `422` when the deal cannot be executed as quoted.\\nThe `expires_at` of the generated order form is bounded by the deal's own term, so a signing window reaching beyond the day the deal stops being executable is rejected.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote version's record within the Lago system.\"}],\"body\":{\"fields\":[{\"path\":[\"expires_at\"],\"flag\":\"expires-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The date and time in UTC (ISO 8601) when the order form generated by the approval expires. It must be in the future, and must fall strictly before the day the quoted deal stops being executable, otherwise the approval is rejected with a `422`. That boundary is the earliest of the `endDate` of any quoted plan and the `expirationAt` of any quoted wallet credit or recurring top-up rule. A `one_off` quote carries none of them, so its signing window is never bounded. When `expires_at` is omitted, the order form never expires.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"quotes\",\"action\":\"clone-quote-version\",\"operation_id\":\"cloneQuoteVersion\",\"method\":\"POST\",\"path\":\"/quote_versions/{lago_id}/clone\",\"summary\":\"Clone a quote version\",\"description\":\"This endpoint copies a quote version into a new `draft` version of the same quote, so that the deal can be renegotiated.\\nAny version of the quote can be cloned, but a quote can only carry one active version: the draft the quote currently holds, if any, is voided with the `superseded` reason. Cloning is therefore rejected with a `422` once a version of the quote has been approved.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote version's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"quotes\",\"action\":\"get\",\"operation_id\":\"findQuote\",\"method\":\"GET\",\"path\":\"/quotes/{lago_id}\",\"summary\":\"Retrieve a quote\",\"description\":\"This endpoint retrieves a specific quote, along with its owners and its current version.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"quotes\",\"action\":\"get-quote-version\",\"operation_id\":\"findQuoteVersion\",\"method\":\"GET\",\"path\":\"/quote_versions/{lago_id}\",\"summary\":\"Retrieve a quote version\",\"description\":\"This endpoint retrieves a specific quote version, along with its document `content` and its `billing_items`.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote version's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"quotes\",\"action\":\"list\",\"operation_id\":\"findAllQuotes\",\"method\":\"GET\",\"path\":\"/quotes\",\"summary\":\"List all quotes\",\"description\":\"This endpoint is used to list all existing quotes.\\nQuotes are ordered by creation date, from the most recent to the oldest.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by the status of their current version. Possible values are `draft`, `approved` and `voided`.\"},{\"name\":\"order_type[]\",\"flag\":\"order-type\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by order type. Possible values are `subscription_creation`, `subscription_amendment` and `one_off`.\"},{\"name\":\"number[]\",\"flag\":\"number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by their number, as assigned by Lago.\"},{\"name\":\"owner_id[]\",\"flag\":\"owner-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by the Lago identifiers of the users owning them.\"},{\"name\":\"external_customer_id[]\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by the external unique identifiers of their customers (provided by your own application).\"},{\"name\":\"from_date\",\"flag\":\"from-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter quotes created from a specific date.\"},{\"name\":\"to_date\",\"flag\":\"to-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter quotes created up to a specific date.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"quotes\",\"action\":\"versions\",\"operation_id\":\"findAllQuoteVersions\",\"method\":\"GET\",\"path\":\"/quotes/{lago_id}/versions\",\"summary\":\"List all versions of a quote\",\"description\":\"This endpoint is used to list all the versions of a specific quote, from the most recent to the oldest.\\nThe `content` and `billing_items` of each version are omitted; retrieve a version to get them.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote's record within the Lago system.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"quotes\",\"action\":\"void-quote-version\",\"operation_id\":\"voidQuoteVersion\",\"method\":\"POST\",\"path\":\"/quote_versions/{lago_id}/void\",\"summary\":\"Void a quote version\",\"description\":\"This endpoint voids a quote version, which makes it definitive: a voided version can neither be edited nor approved again.\\nOnly a `draft` version can be voided through this endpoint, and the resulting `void_reason` is `manual`. An `approved` version is voided by Lago itself, through the order form generated from it.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote version's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"alerts\",\"operation_id\":\"getSubscriptionAlerts\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/alerts\",\"summary\":\"List subscription alerts\",\"description\":\"This endpoint enables the retrieval of all alerts for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"charges\",\"operation_id\":\"findAllSubscriptionCharges\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/charges\",\"summary\":\"List all charges for a subscription\",\"description\":\"This endpoint retrieves all effective charges for a specific subscription.\\nIf the subscription has plan overrides with charge overrides, the overridden charges are returned.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"create\",\"operation_id\":\"createSubscription\",\"method\":\"POST\",\"path\":\"/subscriptions\",\"summary\":\"Assign a plan to a customer\",\"description\":\"This endpoint assigns a plan to a customer, creating or modifying a subscription. Ideal for initial subscriptions or plan changes (upgrades/downgrades).\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"body\":{\"fields\":[{\"path\":[\"authorization\",\"amount_cents\"],\"flag\":\"authorization-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the authorization in cents.\"},{\"path\":[\"authorization\",\"amount_currency\"],\"flag\":\"authorization-amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the authorization.\"},{\"path\":[\"subscription\",\"activation_rules\"],\"flag\":\"activation-rules\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Optional list of activation rules that gate the subscription activation. When a `payment` rule is provided and the plan is paid in advance (and the subscription is not in a trial), the subscription is created in the `incomplete` state and is only activated once the gating payment succeeds. If the payment fails or the rule's `timeout_hours` elapses, the subscription is canceled.\\n\"},{\"path\":[\"subscription\",\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity to be used for the subscription. If not provided, the default billing entity will be used.\"},{\"path\":[\"subscription\",\"billing_time\"],\"flag\":\"billing-time\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).\",\"enum\":[\"calendar\",\"anniversary\"]},{\"path\":[\"subscription\",\"consolidate_invoice\"],\"flag\":\"consolidate-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices.\\n\\n- `true` (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method).\\n- `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice.\\n\"},{\"path\":[\"subscription\",\"ending_at\"],\"flag\":\"ending-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).\"},{\"path\":[\"subscription\",\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"subscription\",\"external_id\"],\"flag\":\"external-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique external identifier for the subscription. This identifier serves as an idempotency key, ensuring that each subscription is unique.\"},{\"path\":[\"subscription\",\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"subscription\",\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"subscription\",\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.\"},{\"path\":[\"subscription\",\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"subscription\",\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"subscription\",\"plan_code\"],\"flag\":\"plan-code\",\"type\":\"string\",\"required\":true,\"complex\":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 plans.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"amount_cents\"],\"flag\":\"plan-overrides-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"amount_currency\"],\"flag\":\"plan-overrides-amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"subscription\",\"plan_overrides\",\"charges\"],\"flag\":\"plan-overrides-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional usage-based charges for this plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"description\"],\"flag\":\"plan-overrides-description\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The description on the plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"fixed_charges\"],\"flag\":\"plan-overrides-fixed-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"invoice_display_name\"],\"flag\":\"plan-overrides-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"metadata\"],\"flag\":\"plan-overrides-metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"amount_cents\"],\"flag\":\"plan-overrides-minimum-commitment-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the minimum commitment in cents.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"invoice_display_name\"],\"flag\":\"plan-overrides-minimum-commitment-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"tax_codes\"],\"flag\":\"plan-overrides-minimum-commitment-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"name\"],\"flag\":\"plan-overrides-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"tax_codes\"],\"flag\":\"plan-overrides-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"trial_period\"],\"flag\":\"plan-overrides-trial-period\",\"type\":\"number\",\"required\":false,\"complex\":false,\"description\":\"The duration in days during which the base cost of the plan is offered for free.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"usage_thresholds\"],\"flag\":\"plan-overrides-usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Managing usage thresholds through `plan_overrides` is deprecated and its behavior is inconsistent: an empty array does not reliably clear thresholds (it is ignored the first time a subscription is overridden), and it never affects thresholds inherited from a parent plan. Use the top-level `usage_thresholds` array on the subscription instead, or `progressive_billing_disabled` to switch progressive billing off.\\n\"},{\"path\":[\"subscription\",\"progressive_billing_disabled\"],\"flag\":\"progressive-billing-disabled\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Disables progressive billing for this subscription, regardless of any usage thresholds defined on the plan (including thresholds inherited from a parent plan when the subscription runs on a plan override).\\n\\nSet to `true` to switch progressive billing off for this subscription specifically, without changing the plan's thresholds.\\n\"},{\"path\":[\"subscription\",\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the subscription. It will be added to invoices generated for this subscription.\"},{\"path\":[\"subscription\",\"subscription_at\"],\"flag\":\"subscription-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The start date for the subscription, allowing for the creation of subscriptions that can begin in the past or future. Please note that it cannot be used to update the start date of a pending subscription or schedule an upgrade/downgrade. The start_date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"subscription\",\"usage_thresholds\"],\"flag\":\"usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Usage thresholds managed directly on the subscription. This is the recommended way to set progressive billing thresholds per subscription; when present, they take precedence over the thresholds defined on the plan.\\n\\nThis field cannot be combined with `plan_overrides.usage_thresholds` in the same request.\\n\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"create-subscription-alert\",\"operation_id\":\"createSubscriptionAlert\",\"method\":\"POST\",\"path\":\"/subscriptions/{external_id}/alerts\",\"summary\":\"Create subscription alert(s)\",\"description\":\"This endpoint allows you to create alerts for a subscription. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"create-subscription-charge-filter\",\"operation_id\":\"createSubscriptionChargeFilter\",\"method\":\"POST\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters\",\"summary\":\"Create a charge filter\",\"description\":\"This endpoint creates a new filter for a specific charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the creation of the filter should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"values\"],\"flag\":\"values\",\"type\":\"object\",\"required\":true,\"complex\":true,\"description\":\"List of possible filter values. The key and values must match one of the billable metric filters.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"delete-all-subscription-alerts\",\"operation_id\":\"deleteAllSubscriptionAlerts\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/alerts\",\"summary\":\"Delete all subscription alerts\",\"description\":\"This endpoint allows you to delete all alerts for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"delete-subscription-alert\",\"operation_id\":\"deleteSubscriptionAlert\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/alerts/{code}\",\"summary\":\"Delete a subscription alert\",\"description\":\"This endpoint allows you to delete an existing alert for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"destroy-subscription-charge-filter\",\"operation_id\":\"destroySubscriptionChargeFilter\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Delete a charge filter\",\"description\":\"This endpoint deletes a specific filter from a charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"filters\",\"operation_id\":\"findAllSubscriptionChargeFilters\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters\",\"summary\":\"List all filters for a charge\",\"description\":\"This endpoint retrieves all filters for a specific charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"fixed-charges\",\"operation_id\":\"findAllSubscriptionFixedCharges\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/fixed_charges\",\"summary\":\"List all fixed charges for a subscription\",\"description\":\"This endpoint retrieves all effective fixed charges for a specific subscription.\\nThe `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get\",\"operation_id\":\"findSubscription\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}\",\"summary\":\"Retrieve a subscription\",\"description\":\"This endpoint retrieves a specific subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"By default, this endpoint only return `active` subscriptions. If you want to retrieve a subscription with a different `status`, you can specify it here.\\n\\n_Note: As there may exists multiple `canceled` or `terminated` subscribtions for the same `external_id`, it is recommended to use the \\\"List all subscriptions\\\" endpoint to retrieve those subscriptions._\\n\",\"enum\":[\"active\",\"terminated\",\"pending\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get-subscription-alert\",\"operation_id\":\"getSubscriptionAlert\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/alerts/{code}\",\"summary\":\"Retrieve a subscription alert\",\"description\":\"This endpoint enables the retrieval of a specific alert for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get-subscription-charge\",\"operation_id\":\"findSubscriptionCharge\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}\",\"summary\":\"Retrieve a charge for a subscription\",\"description\":\"This endpoint retrieves a specific effective charge for a subscription.\\nIf the subscription has a plan override with a charge override, the overridden charge is returned.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get-subscription-charge-filter\",\"operation_id\":\"findSubscriptionChargeFilter\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Retrieve a charge filter\",\"description\":\"This endpoint retrieves a specific filter for a charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get-subscription-fixed-charge\",\"operation_id\":\"findSubscriptionFixedCharge\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Retrieve a fixed charge for a subscription\",\"description\":\"This endpoint retrieves a specific effective fixed charge for a subscription.\\nThe `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"lifetime-usage\",\"operation_id\":\"getSubscriptionLifetimeUsage\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/lifetime_usage\",\"summary\":\"Retrieve subscription lifetime usage\",\"description\":\"This endpoint enables the retrieval of the lifetime usage of a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"list\",\"operation_id\":\"findAllSubscriptions\",\"method\":\"GET\",\"path\":\"/subscriptions\",\"summary\":\"List all subscriptions\",\"description\":\"This endpoint retrieves all active subscriptions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter the results by currency, expressed as an ISO 4217 code.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter subscriptions by their external unique identifier (provided by your own application).\"},{\"name\":\"plan_code\",\"flag\":\"plan-code\",\"in\":\"query\",\"type\":\"string\",\"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 plans.\"},{\"name\":\"overridden\",\"flag\":\"overridden\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"When set, filters subscriptions by whether their plan is an override of a parent plan. `true` returns only subscriptions on overridden plans; `false` returns only those on standard (non-overridden) plans.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"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 you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter subscriptions by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"override-subscription-charge\",\"operation_id\":\"overrideSubscriptionCharge\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}\",\"summary\":\"Override a charge for a subscription\",\"description\":\"This endpoint creates or updates a charge override for a specific subscription.\\nIf the subscription does not have a plan override yet, one will be created automatically.\\nThe charge override allows customizing specific charge properties (invoice_display_name, min_amount_cents, properties, filters, taxes, applied_pricing_unit) without affecting the original plan charge.\\nThis is a premium feature.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"charge\",\"fields\":[{\"path\":[\"applied_pricing_unit\",\"code\"],\"flag\":\"applied-pricing-unit-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the pricing unit.\"},{\"path\":[\"applied_pricing_unit\",\"conversion_rate\"],\"flag\":\"applied-pricing-unit-conversion-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The conversion rate from pricing units to the plan's currency.\\nThis rate determines how many currency units (in the plan's base currency) equal one pricing unit.\\nFor example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of filters used to apply differentiated pricing based on additional event properties.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"min_amount_cents\"],\"flag\":\"min-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"presentation_group_keys\"],\"flag\":\"properties-presentation-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Groups usage into sub-items on invoices for display only, without affecting pricing or aggregation.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"override-subscription-fixed-charge\",\"operation_id\":\"overrideSubscriptionFixedCharge\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Override a fixed charge for a subscription\",\"description\":\"This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge.\\nWhen the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead.\\nWith `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period.\\nThis is a premium feature.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"fixed_charge\",\"fields\":[{\"path\":[\"apply_units_immediately\"],\"flag\":\"apply-units-immediately\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the fixed charge units are applied immediately for active subscriptions. When set to `false`, the units are applied at the next billing period.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the add-on will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"units\"],\"flag\":\"units\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units for the fixed charge.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"terminate\",\"operation_id\":\"destroySubscription\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}\",\"summary\":\"Terminate a subscription\",\"description\":\"This endpoint allows you to terminate a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Selects which subscription to terminate for the given `external_id`, based on its status. If the field is not defined, Lago targets only `active` subscriptions.\\n\\n- `pending`: cancel a subscription scheduled for a future activation (include `status=pending`).\\n- `incomplete`: cancel a payment-gated subscription that is still awaiting its activation payment (include `status=incomplete`). The subscription is canceled with `cancellation_reason: manual`, its invoice is closed and nothing is billed, and any pending payment is canceled on a best-effort basis with the payment provider (some provider statuses cannot be canceled). Applied coupons, credit notes and wallet credits are recredited. Termination behaviours (`on_termination_credit_note`, `on_termination_invoice`) are ignored, as an incomplete subscription has never been billed.\\n\"},{\"name\":\"on_termination_credit_note\",\"flag\":\"on-termination-credit-note\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused subscription time by default.\\nThis field allows you to control the behavior of the credit note generation:\\n\\n- `credit`: A credit note is generated for the unused subscription time. The unused amount is credited back to the customer.\\n- `refund`: A credit note is generated for the unused subscription time. If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is credited back to the customer.\\n- `skip`: No credit note is generated for the unused subscription time.\\n\\n_Note: This field is only applicable to pay-in-advance plans and is ignored for pay-in-arrears plans._\\n\",\"enum\":[\"credit\",\"refund\",\"skip\"]},{\"name\":\"on_termination_invoice\",\"flag\":\"on-termination-invoice\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage.\\nThis field allows you to control the behavior of the invoice generation:\\n\\n- `generate`: An invoice is generated for the unbilled usage.\\n- `skip`: No invoice is generated for the unbilled usage.\\n\",\"enum\":[\"generate\",\"skip\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"update\",\"operation_id\":\"updateSubscription\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}\",\"summary\":\"Update a subscription\",\"description\":\"This endpoint allows you to update a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"By default, this endpoint only return `active` subscriptions. If you want to update a subscription with a different `status`, you can specify it here.\\n\",\"enum\":[\"active\",\"pending\"]}],\"body\":{\"fields\":[{\"path\":[\"status\"],\"flag\":\"status\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"If the field is not defined and multiple `active` and `pending` subscriptions exists, Lago will update the `active` subscription. However, if you wish to update a `pending` subscription, please ensure that you include the `status` attribute with the `pending` value in your request body.\",\"enum\":[\"active\",\"pending\"]},{\"path\":[\"subscription\",\"activation_rules\"],\"flag\":\"activation-rules\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Optional list of activation rules that gate the subscription activation. Activation rules can only be set or modified while the subscription is `pending` (future-dated and not yet activated); the request is rejected for `incomplete`, `active`, or `terminated` subscriptions.\\n\"},{\"path\":[\"subscription\",\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the subscription. Updates take effect on future invoices only.\"},{\"path\":[\"subscription\",\"consolidate_invoice\"],\"flag\":\"consolidate-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices.\\n\\n- `true`: the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method).\\n- `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice.\\n\"},{\"path\":[\"subscription\",\"ending_at\"],\"flag\":\"ending-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).\"},{\"path\":[\"subscription\",\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"subscription\",\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"subscription\",\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.\"},{\"path\":[\"subscription\",\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"subscription\",\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"subscription\",\"plan_overrides\",\"amount_cents\"],\"flag\":\"plan-overrides-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"amount_currency\"],\"flag\":\"plan-overrides-amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"subscription\",\"plan_overrides\",\"charges\"],\"flag\":\"plan-overrides-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional usage-based charges for this plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"description\"],\"flag\":\"plan-overrides-description\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The description on the plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"fixed_charges\"],\"flag\":\"plan-overrides-fixed-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"invoice_display_name\"],\"flag\":\"plan-overrides-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"metadata\"],\"flag\":\"plan-overrides-metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"amount_cents\"],\"flag\":\"plan-overrides-minimum-commitment-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the minimum commitment in cents.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"invoice_display_name\"],\"flag\":\"plan-overrides-minimum-commitment-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"tax_codes\"],\"flag\":\"plan-overrides-minimum-commitment-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"name\"],\"flag\":\"plan-overrides-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"tax_codes\"],\"flag\":\"plan-overrides-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"trial_period\"],\"flag\":\"plan-overrides-trial-period\",\"type\":\"number\",\"required\":false,\"complex\":false,\"description\":\"The duration in days during which the base cost of the plan is offered for free.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"usage_thresholds\"],\"flag\":\"plan-overrides-usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Managing usage thresholds through `plan_overrides` is deprecated and its behavior is inconsistent: an empty array does not reliably clear thresholds (it is ignored the first time a subscription is overridden), and it never affects thresholds inherited from a parent plan. Use the top-level `usage_thresholds` array on the subscription instead, or `progressive_billing_disabled` to switch progressive billing off.\\n\"},{\"path\":[\"subscription\",\"progressive_billing_disabled\"],\"flag\":\"progressive-billing-disabled\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Disables progressive billing for this subscription, regardless of any usage thresholds defined on the plan (including thresholds inherited from a parent plan when the subscription runs on a plan override).\\n\\nSet to `true` to switch progressive billing off for this subscription specifically. This is the recommended way to stop progressive billing on a subscription that inherits thresholds from its plan, since clearing `usage_thresholds` only removes subscription-level thresholds and does not remove those defined on (or inherited from) the plan.\\n\"},{\"path\":[\"subscription\",\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the subscription. It will be added to invoices generated for this subscription.\"},{\"path\":[\"subscription\",\"subscription_at\"],\"flag\":\"subscription-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"subscription\",\"usage_thresholds\"],\"flag\":\"usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Usage thresholds managed directly on the subscription. This is the recommended way to set progressive billing thresholds per subscription; when present, they take precedence over the thresholds defined on the plan.\\n\\nSending an empty array removes all subscription-level thresholds. This field cannot be combined with `plan_overrides.usage_thresholds` in the same request. To fully disable progressive billing on a subscription that inherits thresholds from its plan, use `progressive_billing_disabled` instead.\\n\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"update-subscription-alert\",\"operation_id\":\"updateSubscriptionAlert\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/alerts/{code}\",\"summary\":\"Update a subscription alert\",\"description\":\"This endpoint allows you to update an existing alert for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"alert\",\"fields\":[{\"path\":[\"billable_metric_code\"],\"flag\":\"billable-metric-code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the billable metric associated with the alert. Only for alerts based on a billable metric.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the alert.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the alert.\"},{\"path\":[\"thresholds\"],\"flag\":\"thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Array of thresholds associated with the alert.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"update-subscription-charge-filter\",\"operation_id\":\"updateSubscriptionChargeFilter\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Update a charge filter\",\"description\":\"This endpoint updates a specific filter for a charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the filter should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"values\"],\"flag\":\"values\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"List of possible filter values. The key and values must match one of the billable metric filters.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"update-subscription-lifetime-usage\",\"operation_id\":\"updateSubscriptionLifetimeUsage\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/lifetime_usage\",\"summary\":\"Update a subscription lifetime usage\",\"description\":\"This endpoint allows you to update the lifetime usage of a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"}],\"body\":{\"wrapper\":\"lifetime_usage\",\"fields\":[{\"path\":[\"external_historical_usage_amount_cents\"],\"flag\":\"external-historical-usage-amount-cents\",\"type\":\"integer\",\"required\":true,\"complex\":false,\"description\":\"The historical usage amount in cents for the subscription (provided by your own application).\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"taxes\",\"action\":\"create\",\"operation_id\":\"createTax\",\"method\":\"POST\",\"path\":\"/taxes\",\"summary\":\"Create a tax\",\"description\":\"This endpoint creates a new tax representing a customizable tax rate applicable to either the organization or a specific customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"body\":{\"wrapper\":\"tax\",\"fields\":[{\"path\":[\"applied_to_organization\"],\"flag\":\"applied-to-organization\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"**Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the tax associated with the API request.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the tax\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Name of the tax.\"},{\"path\":[\"rate\"],\"flag\":\"rate\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The percentage rate of the tax\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"taxes\",\"action\":\"delete\",\"operation_id\":\"destroyTax\",\"method\":\"DELETE\",\"path\":\"/taxes/{code}\",\"summary\":\"Delete a tax\",\"description\":\"This endpoint is used to delete a tax.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"taxes\",\"action\":\"get\",\"operation_id\":\"findTax\",\"method\":\"GET\",\"path\":\"/taxes/{code}\",\"summary\":\"Retrieve a Tax\",\"description\":\"This endpoint retrieves an existing tax representing a customizable tax rate applicable to either the organization or a specific customer. The tax is identified by its unique code.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"taxes\",\"action\":\"list\",\"operation_id\":\"findAllTaxes\",\"method\":\"GET\",\"path\":\"/taxes\",\"summary\":\"List all taxes\",\"description\":\"This endpoint retrieves all existing taxes representing a customizable tax rate applicable to either the organization or a specific customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"taxes\",\"action\":\"update\",\"operation_id\":\"updateTax\",\"method\":\"PUT\",\"path\":\"/taxes/{code}\",\"summary\":\"Update a tax\",\"description\":\"This endpoint updates an existing tax representing a customizable tax rate applicable to either the organization or a specific customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes.\"}],\"body\":{\"wrapper\":\"tax\",\"fields\":[{\"path\":[\"applied_to_organization\"],\"flag\":\"applied-to-organization\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"**Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the tax associated with the API request.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the tax\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Name of the tax.\"},{\"path\":[\"rate\"],\"flag\":\"rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate of the tax\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"create\",\"operation_id\":\"createWallet\",\"method\":\"POST\",\"path\":\"/wallets\",\"summary\":\"Create a wallet\",\"description\":\"This endpoint is used to create a wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"body\":{\"wrapper\":\"wallet\",\"fields\":[{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"fee_types\"],\"flag\":\"applies-to-fee-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the wallet.\"},{\"path\":[\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the wallet.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"granted_credits\"],\"flag\":\"granted-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of free granted credits. Required only if there is no paid credits.\"},{\"path\":[\"ignore_paid_top_up_limits_on_creation\"],\"flag\":\"ignore-paid-top-up-limits-on-creation\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"If set to true, the wallet will ignore paid top-up limits on creation.\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet.\"},{\"path\":[\"paid_credits\"],\"flag\":\"paid-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of paid credits. Required only if there is no granted credits.\"},{\"path\":[\"paid_top_up_max_amount_cents\"],\"flag\":\"paid-top-up-max-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Maximum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"paid_top_up_min_amount_cents\"],\"flag\":\"paid-top-up-min-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Minimum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.\"},{\"path\":[\"rate_amount\"],\"flag\":\"rate-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.\"},{\"path\":[\"recurring_transaction_rules\"],\"flag\":\"recurring-transaction-rules\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.\"},{\"path\":[\"transaction_metadata\"],\"flag\":\"transaction-metadata\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.\"},{\"path\":[\"transaction_name\"],\"flag\":\"transaction-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"create-customer-wallet\",\"operation_id\":\"createCustomerWallet\",\"method\":\"POST\",\"path\":\"/customers/{external_customer_id}/wallets\",\"summary\":\"Create a wallet\",\"description\":\"This endpoint is used to create a wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"body\":{\"wrapper\":\"wallet\",\"fields\":[{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"fee_types\"],\"flag\":\"applies-to-fee-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the wallet.\"},{\"path\":[\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the wallet.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SZL\",\"THB\",\"TJS\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"granted_credits\"],\"flag\":\"granted-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of free granted credits. Required only if there is no paid credits.\"},{\"path\":[\"ignore_paid_top_up_limits_on_creation\"],\"flag\":\"ignore-paid-top-up-limits-on-creation\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"If set to true, the wallet will ignore paid top-up limits on creation.\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet.\"},{\"path\":[\"paid_credits\"],\"flag\":\"paid-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of paid credits. Required only if there is no granted credits.\"},{\"path\":[\"paid_top_up_max_amount_cents\"],\"flag\":\"paid-top-up-max-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Maximum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"paid_top_up_min_amount_cents\"],\"flag\":\"paid-top-up-min-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Minimum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.\"},{\"path\":[\"rate_amount\"],\"flag\":\"rate-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.\"},{\"path\":[\"recurring_transaction_rules\"],\"flag\":\"recurring-transaction-rules\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.\"},{\"path\":[\"transaction_metadata\"],\"flag\":\"transaction-metadata\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.\"},{\"path\":[\"transaction_name\"],\"flag\":\"transaction-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"create-customer-wallet-alert\",\"operation_id\":\"createCustomerWalletAlert\",\"method\":\"POST\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts\",\"summary\":\"Create wallet alert(s)\",\"description\":\"This endpoint allows you to create new alerts for a wallet. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"body\":{\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"create-wallet-transaction\",\"operation_id\":\"createWalletTransaction\",\"method\":\"POST\",\"path\":\"/wallet_transactions\",\"summary\":\"Top up a wallet\",\"description\":\"This endpoint is used to top-up an active wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"body\":{\"wrapper\":\"wallet_transaction\",\"fields\":[{\"path\":[\"granted_credits\"],\"flag\":\"granted-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of free granted credits.\"},{\"path\":[\"ignore_paid_top_up_limits\"],\"flag\":\"ignore-paid-top-up-limits\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When true, allows topping up the wallet with transactions that exceed the paid top-up limits. Defaults to false.\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet transaction. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.\\n\\nNote that this name will apply to all transactions (`paid_credits`, `granted_credits` and `voided_credits`) created by this action.\\n\"},{\"path\":[\"paid_credits\"],\"flag\":\"paid-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of paid credits.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with this wallet transaction. It will be added to invoices generated for the resulting wallet top-up. If not set, falls back to the wallet's `purchase_order_number`.\"},{\"path\":[\"voided_credits\"],\"flag\":\"voided-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of voided credits.\"},{\"path\":[\"wallet_id\"],\"flag\":\"wallet-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-all-customer-wallet-alerts\",\"operation_id\":\"deleteAllCustomerWalletAlerts\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts\",\"summary\":\"Delete all wallet alerts\",\"description\":\"This endpoint allows you to delete all alerts for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-all-customer-wallet-metadata\",\"operation_id\":\"deleteAllCustomerWalletMetadata\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/metadata\",\"summary\":\"Delete all wallet metadata\",\"description\":\"This endpoint removes all metadata from a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-all-wallet-metadata\",\"operation_id\":\"deleteAllWalletMetadata\",\"method\":\"DELETE\",\"path\":\"/wallets/{lago_id}/metadata\",\"summary\":\"Delete all wallet metadata\",\"description\":\"This endpoint removes all metadata from a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet within the Lago application.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-customer-wallet-alert\",\"operation_id\":\"deleteCustomerWalletAlert\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}\",\"summary\":\"Delete a wallet alert\",\"description\":\"This endpoint allows you to delete an existing alert for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-customer-wallet-metadata-key\",\"operation_id\":\"deleteCustomerWalletMetadataKey\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/metadata/{key}\",\"summary\":\"Delete a metadata key\",\"description\":\"This endpoint removes a single metadata key from a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"key\",\"flag\":\"key\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The metadata key to delete.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-wallet-metadata-key\",\"operation_id\":\"deleteWalletMetadataKey\",\"method\":\"DELETE\",\"path\":\"/wallets/{lago_id}/metadata/{key}\",\"summary\":\"Delete a metadata key\",\"description\":\"This endpoint removes a single metadata key from a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet within the Lago application.\"},{\"name\":\"key\",\"flag\":\"key\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The metadata key to delete.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"destroy-customer-wallet\",\"operation_id\":\"destroyCustomerWallet\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{code}\",\"summary\":\"Terminate a wallet\",\"description\":\"This endpoint is used to terminate an existing wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"get\",\"operation_id\":\"findWallet\",\"method\":\"GET\",\"path\":\"/wallets/{lago_id}\",\"summary\":\"Retrieve a wallet\",\"description\":\"This endpoint is used to retrieve an existing wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the wallet's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"get-customer-wallet\",\"operation_id\":\"findCustomerWallet\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/wallets/{code}\",\"summary\":\"Retrieve a wallet\",\"description\":\"This endpoint is used to retrieve an existing wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"get-customer-wallet-alert\",\"operation_id\":\"getCustomerWalletAlert\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}\",\"summary\":\"Retrieve a wallet alert\",\"description\":\"This endpoint enables the retrieval of a specific alert for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"get-customer-wallet-alerts\",\"operation_id\":\"getCustomerWalletAlerts\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts\",\"summary\":\"List wallet alerts\",\"description\":\"This endpoint enables the retrieval of all alerts for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"get-wallet-transaction\",\"operation_id\":\"findWalletTransaction\",\"method\":\"GET\",\"path\":\"/wallet_transactions/{lago_id}\",\"summary\":\"Retrieve a wallet transaction\",\"description\":\"This endpoint is used to retrieve a specific wallet transactions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 unique identifier for the wallet's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"list\",\"operation_id\":\"findAllWallets\",\"method\":\"GET\",\"path\":\"/wallets\",\"summary\":\"List all wallets\",\"description\":\"This endpoint is used to list all wallets with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter the results by currency, expressed as an ISO 4217 code.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter wallets by customer external unique identifier (provided by your own application). When omitted, all wallets for the organization are returned.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter wallets by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"list-customer-wallets\",\"operation_id\":\"findAllCustomerWallets\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/wallets\",\"summary\":\"List all customer's wallets\",\"description\":\"This endpoint is used to list all wallets with prepaid credits of a customer\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter wallets by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"list-wallet-transaction-consumptions\",\"operation_id\":\"findAllWalletTransactionConsumptions\",\"method\":\"GET\",\"path\":\"/wallet_transactions/{lago_id}/consumptions\",\"summary\":\"List all consumptions for a wallet transaction\",\"description\":\"This endpoint is used to list all consumption records for an inbound wallet transaction. It shows how the credits from this inbound transaction were consumed by outbound transactions. Only available for traceable wallets.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet transaction within the Lago application. Must be an inbound wallet transaction.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"list-wallet-transaction-fundings\",\"operation_id\":\"findAllWalletTransactionFundings\",\"method\":\"GET\",\"path\":\"/wallet_transactions/{lago_id}/fundings\",\"summary\":\"List all fundings for a wallet transaction\",\"description\":\"This endpoint is used to list all funding records for an outbound wallet transaction. It shows which inbound transactions funded this outbound transaction. Only available for traceable wallets.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet transaction within the Lago application. Must be an outbound wallet transaction.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"merge-customer-wallet-metadata\",\"operation_id\":\"mergeCustomerWalletMetadata\",\"method\":\"PATCH\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/metadata\",\"summary\":\"Merge wallet metadata\",\"description\":\"This endpoint merges the provided metadata with existing metadata on the wallet.\\nExisting keys not in the request are preserved. New keys are added, existing keys are updated.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"merge-wallet-metadata\",\"operation_id\":\"mergeWalletMetadata\",\"method\":\"PATCH\",\"path\":\"/wallets/{lago_id}/metadata\",\"summary\":\"Merge wallet metadata\",\"description\":\"This endpoint merges the provided metadata with existing metadata on the wallet.\\nExisting keys not in the request are preserved. New keys are added, existing keys are updated.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet within the Lago application.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"metadata\",\"operation_id\":\"replaceWalletMetadata\",\"method\":\"POST\",\"path\":\"/wallets/{lago_id}/metadata\",\"summary\":\"Replace wallet metadata\",\"description\":\"This endpoint replaces all existing metadata on a wallet with the provided key-value pairs.\\nAny existing metadata keys not included in the request will be removed.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet within the Lago application.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"replace-customer-wallet-metadata\",\"operation_id\":\"replaceCustomerWalletMetadata\",\"method\":\"POST\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/metadata\",\"summary\":\"Replace wallet metadata\",\"description\":\"This endpoint replaces all existing metadata on a wallet with the provided key-value pairs.\\nAny existing metadata keys not included in the request will be removed.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"terminate\",\"operation_id\":\"destroyWallet\",\"method\":\"DELETE\",\"path\":\"/wallets/{lago_id}\",\"summary\":\"Terminate a wallet\",\"description\":\"This endpoint is used to terminate an existing wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the wallet's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"update\",\"operation_id\":\"updateWallet\",\"method\":\"PUT\",\"path\":\"/wallets/{lago_id}\",\"summary\":\"Update a wallet\",\"description\":\"This endpoint is used to update an existing wallet with prepaid credits. A terminated wallet cannot be updated and returns a `422` error.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the wallet's record within the Lago system.\"}],\"body\":{\"wrapper\":\"wallet\",\"fields\":[{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"fee_types\"],\"flag\":\"applies-to-fee-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the wallet.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the wallet.\"},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.\"},{\"path\":[\"recurring_transaction_rules\"],\"flag\":\"recurring-transaction-rules\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"update-customer-wallet\",\"operation_id\":\"updateCustomerWallet\",\"method\":\"PUT\",\"path\":\"/customers/{external_customer_id}/wallets/{code}\",\"summary\":\"Update a wallet\",\"description\":\"This endpoint is used to update an existing wallet with prepaid credits. A terminated wallet cannot be updated and returns a `422` error.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"body\":{\"wrapper\":\"wallet\",\"fields\":[{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"fee_types\"],\"flag\":\"applies-to-fee-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the wallet.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the wallet.\"},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.\"},{\"path\":[\"recurring_transaction_rules\"],\"flag\":\"recurring-transaction-rules\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"update-customer-wallet-alert\",\"operation_id\":\"updateCustomerWalletAlert\",\"method\":\"PUT\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}\",\"summary\":\"Update a wallet alert\",\"description\":\"This endpoint allows you to update an existing alert for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"}],\"body\":{\"wrapper\":\"alert\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the alert.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the alert.\"},{\"path\":[\"thresholds\"],\"flag\":\"thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Array of thresholds associated with the alert.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"wallet-transaction-payment-url\",\"operation_id\":\"walletTransactionPaymentUrl\",\"method\":\"POST\",\"path\":\"/wallet_transactions/{lago_id}/payment_url\",\"summary\":\"Generate a payment URL\",\"description\":\"This endpoint generates a checkout link for a specific wallet transaction.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"ID of the wallet transaction.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"wallet-transactions\",\"operation_id\":\"findAllWalletTransactions\",\"method\":\"GET\",\"path\":\"/wallets/{lago_id}/wallet_transactions\",\"summary\":\"List all wallet transactions\",\"description\":\"This endpoint is used to list all wallet transactions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the wallet's record within the Lago system.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The status of the wallet transaction. Possible values are `pending` or `settled`.\"},{\"name\":\"transaction_status\",\"flag\":\"transaction-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.\"},{\"name\":\"transaction_type\",\"flag\":\"transaction-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance).\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"webhook-endpoints\",\"action\":\"create\",\"operation_id\":\"createWebhookEndpoint\",\"method\":\"POST\",\"path\":\"/webhook_endpoints\",\"summary\":\"Create a webhook_endpoint\",\"description\":\"This endpoint is used to create a webhook endpoint.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"body\":{\"wrapper\":\"webhook_endpoint\",\"fields\":[{\"path\":[\"event_types\"],\"flag\":\"event-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"A list of event types that will trigger the webhook. Passing null means that all event types will be sent.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the webhook.\"},{\"path\":[\"signature_algo\"],\"flag\":\"signature-algo\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The signature used for the webhook. If no value is passed,\",\"enum\":[\"jwt\",\"hmac\",\"\"]},{\"path\":[\"webhook_url\"],\"flag\":\"webhook-url\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The URL of the webhook endpoint.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"webhook-endpoints\",\"action\":\"delete\",\"operation_id\":\"destroyWebhookEndpoint\",\"method\":\"DELETE\",\"path\":\"/webhook_endpoints/{lago_id}\",\"summary\":\"Delete a webhook endpoint\",\"description\":\"This endpoint is used to delete an existing webhook endpoint.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 unique identifier for the webhook endpoint's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"webhook-endpoints\",\"action\":\"get\",\"operation_id\":\"findWebhookEndpoint\",\"method\":\"GET\",\"path\":\"/webhook_endpoints/{lago_id}\",\"summary\":\"Retrieve a webhook endpoint\",\"description\":\"This endpoint is used to retrieve an existing webhook endpoint.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 unique identifier for the webhook endpoint's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"webhook-endpoints\",\"action\":\"list\",\"operation_id\":\"findAllWebhookEndpoints\",\"method\":\"GET\",\"path\":\"/webhook_endpoints\",\"summary\":\"List all webhook endpoints\",\"description\":\"This endpoint is used to list all webhook endpoints.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"webhook-endpoints\",\"action\":\"update\",\"operation_id\":\"updateWebhookEndpoint\",\"method\":\"PUT\",\"path\":\"/webhook_endpoints/{lago_id}\",\"summary\":\"Update a webhook endpoint\",\"description\":\"This endpoint is used to update an existing webhook endpoint.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 unique identifier for the webhook endpoint's record within the Lago system.\"}],\"body\":{\"wrapper\":\"webhook_endpoint\",\"fields\":[{\"path\":[\"event_types\"],\"flag\":\"event-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"A list of event types that will trigger the webhook. Passing null means that all event types will be sent.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the webhook.\"},{\"path\":[\"signature_algo\"],\"flag\":\"signature-algo\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The signature used for the webhook. If no value is passed,\",\"enum\":[\"jwt\",\"hmac\",\"\"]},{\"path\":[\"webhook_url\"],\"flag\":\"webhook-url\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The URL of the webhook endpoint.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"webhooks\",\"action\":\"json-public-key\",\"operation_id\":\"fetchJsonPublicKey\",\"method\":\"GET\",\"path\":\"/webhooks/json_public_key\",\"summary\":\"Retrieve webhook public key (JSON)\",\"description\":\"This endpoint is used to retrieve the public key used to verify the webhooks signature, wrapped in a JSON object. Prefer this endpoint over the deprecated GET /webhooks/public_key.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhooks/format---signature#1-retrieve-the-public-key\",\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"webhooks\",\"action\":\"public-key\",\"operation_id\":\"fetchPublicKey\",\"method\":\"GET\",\"path\":\"/webhooks/public_key\",\"summary\":\"Retrieve webhook public key\",\"description\":\"This endpoint is used to retrieve the public key used to verify the webhooks signature\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhooks/format---signature#1-retrieve-the-public-key\",\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false}]" +const operationsJSON = "[{\"resource\":\"activity-logs\",\"action\":\"get\",\"operation_id\":\"findActivityLog\",\"method\":\"GET\",\"path\":\"/activity_logs/{activity_id}\",\"summary\":\"Retrieve an activity log\",\"description\":\"This endpoint retrieves an existing activity log that represents an action performed on some resource. The activity log is identified by its unique activity_id.\",\"docs_url\":\"https://getlago.com/docs/api-reference/audit-logs/activity-logs-object\",\"parameters\":[{\"name\":\"activity_id\",\"flag\":\"activity-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The Activity Id of the existing activity log.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"activity-logs\",\"action\":\"list\",\"operation_id\":\"findAllActivityLogs\",\"method\":\"GET\",\"path\":\"/activity_logs\",\"summary\":\"List all activity logs\",\"description\":\"This endpoint retrieves all existing activity logs that represent actions performed on application resources.\",\"docs_url\":\"https://getlago.com/docs/api-reference/audit-logs/activity-logs-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"from_date\",\"flag\":\"from-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter activity logs from a specific date.\"},{\"name\":\"to_date\",\"flag\":\"to-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter activity logs up to a specific date.\"},{\"name\":\"activity_types[]\",\"flag\":\"activity-types\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by activity types\"},{\"name\":\"activity_sources[]\",\"flag\":\"activity-sources\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by activity sources\"},{\"name\":\"user_emails[]\",\"flag\":\"user-emails\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by user emails\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"External subscription ID\"},{\"name\":\"resource_ids[]\",\"flag\":\"resource-ids\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by resources unique identifiers\"},{\"name\":\"resource_types[]\",\"flag\":\"resource-types\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by resource class types\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"add-ons\",\"action\":\"create\",\"operation_id\":\"createAddOn\",\"method\":\"POST\",\"path\":\"/add_ons\",\"summary\":\"Create an add-on\",\"description\":\"This endpoint is used to create an add-on that can be then attached to a one-off invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"body\":{\"wrapper\":\"add_on\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":true,\"complex\":false,\"description\":\"The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The currency of the add-on.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the add-on.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The description of the add-on.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The name of the add-on.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"add-ons\",\"action\":\"delete\",\"operation_id\":\"destroyAddOn\",\"method\":\"DELETE\",\"path\":\"/add_ons/{code}\",\"summary\":\"Delete an add-on\",\"description\":\"This endpoint is used to delete an existing add-on.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the add-on.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"add-ons\",\"action\":\"get\",\"operation_id\":\"findAddOn\",\"method\":\"GET\",\"path\":\"/add_ons/{code}\",\"summary\":\"Retrieve an add-on\",\"description\":\"This endpoint is used to retrieve a specific add-on.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the add-on.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"add-ons\",\"action\":\"list\",\"operation_id\":\"findAllAddOns\",\"method\":\"GET\",\"path\":\"/add_ons\",\"summary\":\"List all add-ons\",\"description\":\"This endpoint is used to list all existing add-ons.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"add-ons\",\"action\":\"update\",\"operation_id\":\"updateAddOn\",\"method\":\"PUT\",\"path\":\"/add_ons/{code}\",\"summary\":\"Update an add-on\",\"description\":\"This endpoint is used to update an existing add-on.\",\"docs_url\":\"https://getlago.com/docs/api-reference/add-ons/add-on-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the add-on.\"}],\"body\":{\"wrapper\":\"add_on\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the add-on.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the add-on.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The description of the add-on.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the add-on.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"analytics\",\"action\":\"gross-revenue\",\"operation_id\":\"findAllGrossRevenues\",\"method\":\"GET\",\"path\":\"/analytics/gross_revenue\",\"summary\":\"List gross revenue\",\"description\":\"Gross revenue is the sum of monthly `finalized` invoice payments and fees paid in advance that are not invoiceable. This total is calculated after deducting taxes and discounts.\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Currency of revenue analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.\"},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"invoice-collection\",\"operation_id\":\"findAllInvoiceCollections\",\"method\":\"GET\",\"path\":\"/analytics/invoice_collection\",\"summary\":\"List of finalized invoices\",\"description\":\"Represents a monthly aggregation, detailing both the total count and the cumulative amount of invoices that have been marked as `finalized`. This report sorts invoices categorically based on their `payment_status`.\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The currency of revenue analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"invoiced-usage\",\"operation_id\":\"findAllInvoicedUsages\",\"method\":\"GET\",\"path\":\"/analytics/invoiced_usage\",\"summary\":\"List usage revenue\",\"description\":\"Reports a monthly analysis focused on the revenue generated from all usage-based fees. It exclusively accounts for revenue that has been formally invoiced. Importantly, this report does not include revenue related to the usage in the current billing period, limiting its scope to previously invoiced amounts.\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The currency of invoiced usage analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"mrr\",\"operation_id\":\"findAllMrrs\",\"method\":\"GET\",\"path\":\"/analytics/mrr\",\"summary\":\"List MRR\",\"description\":\"This endpoint is used to list MRR.\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Quantifies the revenue generated from `subscription` fees on a monthly basis. This figure is calculated post-application of applicable taxes and deduction of any applicable discounts. The method of calculation varies based on the subscription billing cycle:\\n\\n- Revenue from `monthly` subscription invoices is included in the MRR for the month in which the invoice is issued.\\n- Revenue from `quarterly` subscription invoices is distributed evenly over three months. This distribution applies to fees paid in advance (allocated to the next remaining months depending on calendar or anniversary billing) as well as to fees paid in arrears (allocated to the preceding months depending on calendar or anniversary billing).\\n- Revenue from `yearly` subscription invoices is distributed evenly over twelve months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).\\n- Revenue from `semiannual` subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing).\\n- Revenue from `weekly` subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"overdue-balance\",\"operation_id\":\"findAllOverdueBalances\",\"method\":\"GET\",\"path\":\"/analytics/overdue_balance\",\"summary\":\"List overdue balance\",\"description\":\"Overdue balance is the total amount associated with overdue invoices (invoices with pending or failed payments which are past their due dates).\",\"parameters\":[{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Currency of revenue analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.\"},{\"name\":\"months\",\"flag\":\"months\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Show data only for given number of months.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"analytics\",\"action\":\"usage\",\"operation_id\":\"findAllUsages\",\"method\":\"GET\",\"path\":\"/analytics/usage\",\"summary\":\"List usage\",\"description\":\"Returns usages.\",\"parameters\":[{\"name\":\"time_granularity\",\"flag\":\"time-granularity\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The time granularity of usage analytics. Possible values are 'daily', 'weekly', 'monthly', 'yearly'.\",\"enum\":[\"daily\",\"weekly\",\"monthly\"]},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The currency of usage analytics. Format must be ISO 4217.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"from_date\",\"flag\":\"from-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The start date of the period for which the usage analytics is calculated.\"},{\"name\":\"to_date\",\"flag\":\"to-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The end date of the period for which the usage analytics is calculated.\"},{\"name\":\"customer_type\",\"flag\":\"customer-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The type of customer for which the usage analytics is calculated. Possible values are 'individual', 'company'.\",\"enum\":[\"individual\",\"company\"]},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The external identifier of the customer for which the usage analytics is calculated.\"},{\"name\":\"customer_country\",\"flag\":\"customer-country\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The country of the customer for which the usage analytics is calculated.\",\"enum\":[\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The external identifier of the subscription for which the usage analytics is calculated.\"},{\"name\":\"is_billable_metric_recurring\",\"flag\":\"is-billable-metric-recurring\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Indicates whether the billable metric associated with the usage is recurring.\"},{\"name\":\"plan_code\",\"flag\":\"plan-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The code of the plan for which the usage analytics is calculated.\"},{\"name\":\"billable_metric_code\",\"flag\":\"billable-metric-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The code of the usage-based billable metrics for which the usage analytics is calculated.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"api-logs\",\"action\":\"get\",\"operation_id\":\"findApiLog\",\"method\":\"GET\",\"path\":\"/api_logs/{request_id}\",\"summary\":\"Retrieve an api log\",\"description\":\"This endpoint retrieves an existing api log that represents a request made to the API. The api log is identified by its unique request_id.\",\"docs_url\":\"https://getlago.com/docs/api-reference/audit-logs/api-logs-object\",\"parameters\":[{\"name\":\"request_id\",\"flag\":\"request-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The Request Id of the existing api log.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"api-logs\",\"action\":\"list\",\"operation_id\":\"findAllApiLogs\",\"method\":\"GET\",\"path\":\"/api_logs\",\"summary\":\"List all api logs\",\"description\":\"This endpoint retrieves all existing api logs that represent requests performed to Lago's API.\",\"docs_url\":\"https://getlago.com/docs/api-reference/audit-logs/api-logs-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"from_date\",\"flag\":\"from-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter api logs from a specific date.\"},{\"name\":\"to_date\",\"flag\":\"to-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter api logs up to a specific date.\"},{\"name\":\"http_methods[]\",\"flag\":\"http-methods\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by HTTP methods\"},{\"name\":\"http_statuses[]\",\"flag\":\"http-statuses\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter results by HTTP status or by generic request status\"},{\"name\":\"api_version\",\"flag\":\"api-version\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by API version\"},{\"name\":\"request_paths\",\"flag\":\"request-paths\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by the path of the request\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"billable-metrics\",\"action\":\"create\",\"operation_id\":\"createBillableMetric\",\"method\":\"POST\",\"path\":\"/billable_metrics\",\"summary\":\"Create a billable metric\",\"description\":\"This endpoint creates a new billable metric representing a pricing component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"body\":{\"wrapper\":\"billable_metric\",\"fields\":[{\"path\":[\"aggregation_type\"],\"flag\":\"aggregation-type\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Aggregation method used to compute usage for this billable metric.\",\"enum\":[\"count_agg\",\"sum_agg\",\"max_agg\",\"unique_count_agg\",\"weighted_sum_agg\",\"latest_agg\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the billable metric.\"},{\"path\":[\"expression\"],\"flag\":\"expression\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.\\nAccepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\\\\` and `*` operations.\\nRound is accepting an optional second parameter to specify the number of decimal.\\n\"},{\"path\":[\"field_name\"],\"flag\":\"field-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Name of the billable metric.\"},{\"path\":[\"recurring\"],\"flag\":\"recurring\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Defines if the billable metric is persisted billing period over billing period.\\n\\n- If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period.\\n- If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period.\\n- If not defined in the request, default value is `false`.\"},{\"path\":[\"rounding_function\"],\"flag\":\"rounding-function\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Refers to the numeric value or mathematical expression that will be rounded based on the calculated number of billing units. Possible values are `round`, `ceil` and `floor`.\",\"enum\":[\"ceil\",\"floor\",\"round\",\"\"]},{\"path\":[\"rounding_precision\"],\"flag\":\"rounding-precision\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of decimal places to which the `rounding_function` will be rounded. It can be a positive or negative value.\"},{\"path\":[\"weighted_interval\"],\"flag\":\"weighted-interval\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.\",\"enum\":[\"seconds\",\"\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"billable-metrics\",\"action\":\"delete\",\"operation_id\":\"destroyBillableMetric\",\"method\":\"DELETE\",\"path\":\"/billable_metrics/{code}\",\"summary\":\"Delete a billable metric\",\"description\":\"This endpoint deletes an existing billable metric representing a pricing component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing billable metric.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"billable-metrics\",\"action\":\"evaluate-expression\",\"operation_id\":\"evaluateBillableMetricExpression\",\"method\":\"POST\",\"path\":\"/billable_metrics/evaluate_expression\",\"summary\":\"Evaluate an expression for a billable metric\",\"description\":\"Evaluate an expression for a billable metric creation by providing the expression and test data\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"body\":{\"fields\":[{\"path\":[\"event\",\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The code that identifies a targeted billable metric.\"},{\"path\":[\"event\",\"properties\"],\"flag\":\"properties\",\"type\":\"object\",\"required\":true,\"complex\":true,\"description\":\"This field represents additional properties associated with the event. They can be used when evaluating the expression.\"},{\"path\":[\"event\",\"timestamp\"],\"flag\":\"timestamp\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).\\nIf this timestamp is not provided, the API will automatically set it to the time of event reception.\\n\"},{\"path\":[\"expression\"],\"flag\":\"expression\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.\\nAccepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\\\\` and `*` operations.\\nRound is accepting an optional second parameter to specify the number of decimal.\\n\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"billable-metrics\",\"action\":\"get\",\"operation_id\":\"findBillableMetric\",\"method\":\"GET\",\"path\":\"/billable_metrics/{code}\",\"summary\":\"Retrieve a billable metric\",\"description\":\"This endpoint retrieves an existing billable metric that represents a pricing component of your application. The billable metric is identified by its unique code.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing billable metric.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"billable-metrics\",\"action\":\"list\",\"operation_id\":\"findAllBillableMetrics\",\"method\":\"GET\",\"path\":\"/billable_metrics\",\"summary\":\"List all billable metrics\",\"description\":\"This endpoint retrieves all existing billable metrics that represent pricing components of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"billable-metrics\",\"action\":\"update\",\"operation_id\":\"updateBillableMetric\",\"method\":\"PUT\",\"path\":\"/billable_metrics/{code}\",\"summary\":\"Update a billable metric\",\"description\":\"This endpoint updates an existing billable metric representing a pricing component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/billable-metrics/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing billable metric.\"}],\"body\":{\"wrapper\":\"billable_metric\",\"fields\":[{\"path\":[\"aggregation_type\"],\"flag\":\"aggregation-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Aggregation method used to compute usage for this billable metric.\",\"enum\":[\"count_agg\",\"sum_agg\",\"max_agg\",\"unique_count_agg\",\"weighted_sum_agg\",\"latest_agg\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the billable metric.\"},{\"path\":[\"expression\"],\"flag\":\"expression\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.\\nAccepted function are `ceil`, `concat` and `round` as well as `+`, `-`, `\\\\` and `*` operations.\\nRound is accepting an optional second parameter to specify the number of decimal.\\n\"},{\"path\":[\"field_name\"],\"flag\":\"field-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Property of the billable metric used for aggregating usage data. This field is not required for `count_agg`.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Name of the billable metric.\"},{\"path\":[\"recurring\"],\"flag\":\"recurring\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Defines if the billable metric is persisted billing period over billing period.\\n\\n- If set to `true`: the accumulated number of units calculated from the previous billing period is persisted to the next billing period.\\n- If set to `false`: the accumulated number of units is reset to 0 at the end of the billing period.\\n- If not defined in the request, default value is `false`.\"},{\"path\":[\"rounding_function\"],\"flag\":\"rounding-function\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Refers to the numeric value or mathematical expression that will be rounded based on the calculated number of billing units. Possible values are `round`, `ceil` and `floor`.\",\"enum\":[\"ceil\",\"floor\",\"round\",\"\"]},{\"path\":[\"rounding_precision\"],\"flag\":\"rounding-precision\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of decimal places to which the `rounding_function` will be rounded. It can be a positive or negative value.\"},{\"path\":[\"weighted_interval\"],\"flag\":\"weighted-interval\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Parameter exclusively utilized in conjunction with the `weighted_sum` aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in `seconds`.\",\"enum\":[\"seconds\",\"\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"billing-entities\",\"action\":\"create\",\"operation_id\":\"createBillingEntity\",\"method\":\"POST\",\"path\":\"/billing_entities\",\"summary\":\"Create a billing entity\",\"description\":\"This endpoint is used to create a new billing entity\",\"docs_url\":\"https://getlago.com/docs/api-reference/billing-entities/object\",\"body\":{\"wrapper\":\"billing_entity\",\"fields\":[{\"path\":[\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"billing_configuration\",\"document_locale\"],\"flag\":\"billing-configuration-document-locale\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The language of the documents generated for this billing entity\"},{\"path\":[\"billing_configuration\",\"invoice_footer\"],\"flag\":\"billing-configuration-invoice-footer\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The footer text to be displayed on invoices for this billing entity\"},{\"path\":[\"billing_configuration\",\"invoice_grace_period\"],\"flag\":\"billing-configuration-invoice-grace-period\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The grace period (in days) for invoice finalization\"},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_adjustment\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-adjustment\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.\",\"enum\":[\"align_with_finalization_date\",\"keep_anchor\"]},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_anchor\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-anchor\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Defines whether the issuing date follows the current billing period's end date or the next period starting date.\",\"enum\":[\"current_period_end\",\"next_period_start\"]},{\"path\":[\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the billing address\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique code of the billing entity\"},{\"path\":[\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The country code of the billing address\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"default_currency\"],\"flag\":\"default-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The default currency of the billing entity\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"document_number_prefix\"],\"flag\":\"document-number-prefix\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The prefix used in document numbers for this billing entity\"},{\"path\":[\"document_numbering\"],\"flag\":\"document-numbering\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of document numbering for this billing entity:\\n- `per_customer`: document numbers are unique per customer\\n- `per_billing_entity`: document numbers are unique per billing entity\",\"enum\":[\"per_customer\",\"per_billing_entity\"]},{\"path\":[\"einvoicing\"],\"flag\":\"einvoicing\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether e-invoicing is enabled for this billing entity\"},{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The email address of the billing entity\"},{\"path\":[\"email_settings\"],\"flag\":\"email-settings\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The email notification settings for this billing entity\"},{\"path\":[\"eu_tax_management\"],\"flag\":\"eu-tax-management\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether EU tax management is enabled for this billing entity\"},{\"path\":[\"finalize_zero_amount_invoice\"],\"flag\":\"finalize-zero-amount-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether to finalize invoices with zero amount for this billing entity\"},{\"path\":[\"legal_name\"],\"flag\":\"legal-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal name of the billing entity\"},{\"path\":[\"legal_number\"],\"flag\":\"legal-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal registration number of the billing entity\"},{\"path\":[\"logo\"],\"flag\":\"logo\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The base64 encoded logo image for the billing entity\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The name of the billing entity\"},{\"path\":[\"net_payment_term\"],\"flag\":\"net-payment-term\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The net payment term (in days) for this billing entity\"},{\"path\":[\"phone\"],\"flag\":\"phone\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The phone number of the billing entity\"},{\"path\":[\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the billing address\"},{\"path\":[\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The tax identification number of the billing entity\"},{\"path\":[\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The timezone of the billing entity\",\"enum\":[\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Nuuk\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"zipcode\"],\"flag\":\"zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the billing address\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"billing-entities\",\"action\":\"get\",\"operation_id\":\"getBillingEntity\",\"method\":\"GET\",\"path\":\"/billing_entities/{code}\",\"summary\":\"Retrieve a billing entity\",\"description\":\"This endpoint returns a specific billing entity by its code\",\"docs_url\":\"https://getlago.com/docs/api-reference/billing-entities/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The unique code of the billing entity\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"billing-entities\",\"action\":\"list\",\"operation_id\":\"listBillingEntities\",\"method\":\"GET\",\"path\":\"/billing_entities\",\"summary\":\"List all billing entities\",\"description\":\"This endpoint returns a list of all billing entities in the organization\",\"docs_url\":\"https://getlago.com/docs/api-reference/billing-entities/object\",\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"billing-entities\",\"action\":\"update\",\"operation_id\":\"updateBillingEntity\",\"method\":\"PUT\",\"path\":\"/billing_entities/{code}\",\"summary\":\"Update a billing entity\",\"description\":\"This endpoint is used to update an existing billing entity\",\"docs_url\":\"https://getlago.com/docs/api-reference/billing-entities/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The unique code of the billing entity\"}],\"body\":{\"wrapper\":\"billing_entity\",\"fields\":[{\"path\":[\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"billing_configuration\",\"document_locale\"],\"flag\":\"billing-configuration-document-locale\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The language of the documents generated for this billing entity\"},{\"path\":[\"billing_configuration\",\"invoice_footer\"],\"flag\":\"billing-configuration-invoice-footer\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The footer text to be displayed on invoices for this billing entity\"},{\"path\":[\"billing_configuration\",\"invoice_grace_period\"],\"flag\":\"billing-configuration-invoice-grace-period\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The grace period (in days) for invoice finalization\"},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_adjustment\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-adjustment\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.\",\"enum\":[\"align_with_finalization_date\",\"keep_anchor\"]},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_anchor\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-anchor\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Defines whether the issuing date follows the current billing period's end date or the next period starting date.\",\"enum\":[\"current_period_end\",\"next_period_start\"]},{\"path\":[\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the billing address\"},{\"path\":[\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The country code of the billing address\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"default_currency\"],\"flag\":\"default-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The default currency of the billing entity\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"document_number_prefix\"],\"flag\":\"document-number-prefix\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The prefix used in document numbers for this billing entity\"},{\"path\":[\"document_numbering\"],\"flag\":\"document-numbering\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of document numbering for this billing entity:\\n- `per_customer`: document numbers are unique per customer\\n- `per_billing_entity`: document numbers are unique per billing entity\",\"enum\":[\"per_customer\",\"per_billing_entity\"]},{\"path\":[\"einvoicing\"],\"flag\":\"einvoicing\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether e-invoicing is enabled for this billing entity\"},{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The email address of the billing entity\"},{\"path\":[\"email_settings\"],\"flag\":\"email-settings\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The email notification settings for this billing entity\"},{\"path\":[\"eu_tax_management\"],\"flag\":\"eu-tax-management\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether EU tax management is enabled for this billing entity\"},{\"path\":[\"finalize_zero_amount_invoice\"],\"flag\":\"finalize-zero-amount-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Whether to finalize invoices with zero amount for this billing entity\"},{\"path\":[\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The codes of the invoice custom section that should be associated with this billing entity\"},{\"path\":[\"legal_name\"],\"flag\":\"legal-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal name of the billing entity\"},{\"path\":[\"legal_number\"],\"flag\":\"legal-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal registration number of the billing entity\"},{\"path\":[\"logo\"],\"flag\":\"logo\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The base64 encoded logo image for the billing entity. Sending \\\"null\\\" will remove the logo, if any exist.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the billing entity\"},{\"path\":[\"net_payment_term\"],\"flag\":\"net-payment-term\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The net payment term (in days) for this billing entity\"},{\"path\":[\"phone\"],\"flag\":\"phone\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The phone number of the billing entity\"},{\"path\":[\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the billing address\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The tax codes that should be associated with this billing entity\"},{\"path\":[\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The tax identification number of the billing entity\"},{\"path\":[\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The timezone of the billing entity\",\"enum\":[\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Nuuk\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"zipcode\"],\"flag\":\"zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the billing address\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"apply\",\"operation_id\":\"applyCoupon\",\"method\":\"POST\",\"path\":\"/applied_coupons\",\"summary\":\"Apply a coupon to a customer\",\"description\":\"This endpoint is used to apply a specific coupon to a customer, before or during a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"body\":{\"wrapper\":\"applied_coupon\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The currency of the coupon. This field is required only for coupon with `fixed_amount` type.\",\"enum\":[\"\",\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"coupon_code\"],\"flag\":\"coupon-code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the coupon.\"},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"frequency\"],\"flag\":\"frequency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.\\n\\n- If set to `once`, the coupon is applicable only for a single use.\\n- If set to `recurring`, the coupon can be used multiple times for recurring billing periods.\\n- If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.\",\"enum\":[\"once\",\"recurring\",\"forever\",\"\"]},{\"path\":[\"frequency_duration\"],\"flag\":\"frequency-duration\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type\"},{\"path\":[\"percentage_rate\"],\"flag\":\"percentage-rate\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"create\",\"operation_id\":\"createCoupon\",\"method\":\"POST\",\"path\":\"/coupons\",\"summary\":\"Create a coupon\",\"description\":\"This endpoint is used to create a coupon that can be then attached to a customer to create a discount.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"body\":{\"wrapper\":\"coupon\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The currency of the coupon. This field is required only for coupon with `fixed_amount` type.\",\"enum\":[\"\",\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"plan_codes\"],\"flag\":\"applies-to-plan-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the coupon.\"},{\"path\":[\"coupon_type\"],\"flag\":\"coupon-type\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.\\n\\n- If set to `fixed_amount`, the coupon represents a fixed amount discount.\\n- If set to `percentage`, the coupon represents a percentage-based discount.\",\"enum\":[\"fixed_amount\",\"percentage\"]},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Description of the coupon.\"},{\"path\":[\"expiration\"],\"flag\":\"expiration\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.\\n\\n- If set to `time_limit`, the coupon has an expiration based on a specified time limit.\\n- If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely.\",\"enum\":[\"no_expiration\",\"time_limit\"]},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid.\"},{\"path\":[\"frequency\"],\"flag\":\"frequency\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.\\n\\n- If set to `once`, the coupon is applicable only for a single use.\\n- If set to `recurring`, the coupon can be used multiple times for recurring billing periods.\\n- If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.\",\"enum\":[\"once\",\"recurring\",\"forever\"]},{\"path\":[\"frequency_duration\"],\"flag\":\"frequency-duration\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The name of the coupon.\"},{\"path\":[\"percentage_rate\"],\"flag\":\"percentage-rate\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.\"},{\"path\":[\"reusable\"],\"flag\":\"reusable\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"delete\",\"operation_id\":\"destroyCoupon\",\"method\":\"DELETE\",\"path\":\"/coupons/{code}\",\"summary\":\"Delete a coupon\",\"description\":\"This endpoint is used to delete a coupon.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the coupon.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"delete-applied-coupon\",\"operation_id\":\"deleteAppliedCoupon\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/applied_coupons/{applied_coupon_id}\",\"summary\":\"Delete an applied coupon\",\"description\":\"This endpoint is used to delete a specific coupon that has been applied to a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"applied_coupon_id\",\"flag\":\"applied-coupon-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the applied coupon, created by Lago.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"coupons\",\"action\":\"get\",\"operation_id\":\"findCoupon\",\"method\":\"GET\",\"path\":\"/coupons/{code}\",\"summary\":\"Retrieve a coupon\",\"description\":\"This endpoint is used to retrieve a specific coupon.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the coupon.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"coupons\",\"action\":\"list\",\"operation_id\":\"findAllCoupons\",\"method\":\"GET\",\"path\":\"/coupons\",\"summary\":\"List all coupons\",\"description\":\"This endpoint is used to list all existing coupons.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"coupons\",\"action\":\"list-applied-coupons\",\"operation_id\":\"findAllAppliedCoupons\",\"method\":\"GET\",\"path\":\"/applied_coupons\",\"summary\":\"List all applied coupons\",\"description\":\"This endpoint is used to list all applied coupons. You can filter by coupon status and by customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The status of the coupon. Can be either `active` or `terminated`.\",\"enum\":[\"active\",\"terminated\"]},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"coupon_code[]\",\"flag\":\"coupon-code\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"The code of the coupon applied to the customer. Use it to filter applied coupons by their code.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"coupons\",\"action\":\"update\",\"operation_id\":\"updateCoupon\",\"method\":\"PUT\",\"path\":\"/coupons/{code}\",\"summary\":\"Update a coupon\",\"description\":\"This endpoint is used to update a coupon that can be then attached to a customer to create a discount.\",\"docs_url\":\"https://getlago.com/docs/api-reference/coupons/coupon-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code used to identify the coupon.\"}],\"body\":{\"wrapper\":\"coupon\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The currency of the coupon. This field is required only for coupon with `fixed_amount` type.\",\"enum\":[\"\",\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"plan_codes\"],\"flag\":\"applies-to-plan-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the coupon.\"},{\"path\":[\"coupon_type\"],\"flag\":\"coupon-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of the coupon. It can have two possible values: `fixed_amount` or `percentage`.\\n\\n- If set to `fixed_amount`, the coupon represents a fixed amount discount.\\n- If set to `percentage`, the coupon represents a percentage-based discount.\",\"enum\":[\"fixed_amount\",\"percentage\"]},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Description of the coupon.\"},{\"path\":[\"expiration\"],\"flag\":\"expiration\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the type of expiration for the coupon. It can have two possible values: `time_limit` or `no_expiration`.\\n\\n- If set to `time_limit`, the coupon has an expiration based on a specified time limit.\\n- If set to `no_expiration`, the coupon does not have an expiration date and remains valid indefinitely.\",\"enum\":[\"no_expiration\",\"time_limit\"]},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The expiration date and time of the coupon. This field is required only for coupons with `expiration` set to `time_limit`. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid.\"},{\"path\":[\"frequency\"],\"flag\":\"frequency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`.\\n\\n- If set to `once`, the coupon is applicable only for a single use.\\n- If set to `recurring`, the coupon can be used multiple times for recurring billing periods.\\n- If set to `forever`, the coupon has unlimited usage and can be applied indefinitely.\",\"enum\":[\"once\",\"recurring\",\"forever\"]},{\"path\":[\"frequency_duration\"],\"flag\":\"frequency-duration\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the coupon.\"},{\"path\":[\"percentage_rate\"],\"flag\":\"percentage-rate\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type.\"},{\"path\":[\"reusable\"],\"flag\":\"reusable\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Indicates whether the coupon can be reused or not. If set to `true`, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to `false`, the coupon can only be used once and is not reusable. If not specified, this field is set to `true` by default.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"create\",\"operation_id\":\"createCreditNote\",\"method\":\"POST\",\"path\":\"/credit_notes\",\"summary\":\"Create a credit note\",\"description\":\"This endpoint creates a new credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"body\":{\"wrapper\":\"credit_note\",\"fields\":[{\"path\":[\"credit_amount_cents\"],\"flag\":\"credit-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The total amount to be credited to the customer balance for discounts on future invoices. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The description of the credit note.\"},{\"path\":[\"invoice_id\"],\"flag\":\"invoice-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The invoice unique identifier, created by Lago.\"},{\"path\":[\"items\"],\"flag\":\"items\",\"type\":\"array\",\"required\":true,\"complex\":true,\"description\":\"The list of credit note's items.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"offset_amount_cents\"],\"flag\":\"offset-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The total amount to be immediately deducted from the invoice balance. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.\"},{\"path\":[\"reason\"],\"flag\":\"reason\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The reason of the credit note creation.\\nPossible values are `duplicated_charge`, `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge` or `other`.\",\"enum\":[\"duplicated_charge\",\"product_unsatisfactory\",\"order_change\",\"order_cancellation\",\"fraudulent_charge\",\"other\",\"\"]},{\"path\":[\"refund_amount_cents\"],\"flag\":\"refund-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The total amount to be refunded immediately to the payment method used by the customer. For a total or partial refund, credit or offset, the amount in cents must include both the item amount and the applicable tax. The refunded, credited and offsetted amounts should always balance. The total, including taxes, cannot exceed the invoice's total fees.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"delete-all-credit-note-metadata\",\"operation_id\":\"deleteAllCreditNoteMetadata\",\"method\":\"DELETE\",\"path\":\"/credit_notes/{lago_id}/metadata\",\"summary\":\"Delete all credit note metadata\",\"description\":\"This endpoint removes all metadata from a credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"delete-credit-note-metadata-key\",\"operation_id\":\"deleteCreditNoteMetadataKey\",\"method\":\"DELETE\",\"path\":\"/credit_notes/{lago_id}/metadata/{key}\",\"summary\":\"Delete a metadata key\",\"description\":\"This endpoint removes a single metadata key from a credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"},{\"name\":\"key\",\"flag\":\"key\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The metadata key to delete.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"download\",\"operation_id\":\"downloadCreditNote\",\"method\":\"POST\",\"path\":\"/credit_notes/{lago_id}/download\",\"summary\":\"Download a credit note PDF\",\"description\":\"This endpoint downloads the PDF of an existing credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"credit-notes\",\"action\":\"estimate\",\"operation_id\":\"estimateCreditNote\",\"method\":\"POST\",\"path\":\"/credit_notes/estimate\",\"summary\":\"Estimate amounts for a new credit note\",\"description\":\"This endpoint allows you to retrieve amounts for a new credit note creation.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"body\":{\"wrapper\":\"credit_note\",\"fields\":[{\"path\":[\"invoice_id\"],\"flag\":\"invoice-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The invoice unique identifier, created by Lago.\"},{\"path\":[\"items\"],\"flag\":\"items\",\"type\":\"array\",\"required\":true,\"complex\":true,\"description\":\"The list of credit note's items.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"credit-notes\",\"action\":\"get\",\"operation_id\":\"findCreditNote\",\"method\":\"GET\",\"path\":\"/credit_notes/{lago_id}\",\"summary\":\"Retrieve a credit note\",\"description\":\"This endpoint retrieves an existing credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"credit-notes\",\"action\":\"list\",\"operation_id\":\"findAllCreditNotes\",\"method\":\"GET\",\"path\":\"/credit_notes\",\"summary\":\"List all credit notes\",\"description\":\"This endpoint list all existing credit notes.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"issuing_date_from\",\"flag\":\"issuing-date-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes starting from a specific date.\"},{\"name\":\"issuing_date_to\",\"flag\":\"issuing-date-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes up to a specific date.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search credit notes by id, number, customer name, customer external_id or customer email.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by currency. Possible values ISO 4217 currency codes.\"},{\"name\":\"reason\",\"flag\":\"reason\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`.\",\"enum\":[\"product_unsatisfactory\",\"order_change\",\"order_cancellation\",\"fraudulent_charge\",\"duplicated_charge\",\"other\"]},{\"name\":\"credit_status\",\"flag\":\"credit-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`.\",\"enum\":[\"available\",\"consumed\",\"voided\"]},{\"name\":\"refund_status\",\"flag\":\"refund-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\"]},{\"name\":\"invoice_number\",\"flag\":\"invoice-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by their related invoice number.\"},{\"name\":\"purchase_order_number\",\"flag\":\"purchase-order-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by the invoice purchase order number. The match is exact but case-insensitive.\"},{\"name\":\"amount_from\",\"flag\":\"amount-from\",\"in\":\"query\",\"type\":\"integer\",\"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 types.\"},{\"name\":\"amount_to\",\"flag\":\"amount-to\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"types[]\",\"flag\":\"types\",\"in\":\"query\",\"type\":\"array\",\"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 amount and `offset` those with an amount deducted from the invoice balance. A credit note can match several types.\"},{\"name\":\"self_billed\",\"flag\":\"self-billed\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter credit notes by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"credit-notes\",\"action\":\"merge-credit-note-metadata\",\"operation_id\":\"mergeCreditNoteMetadata\",\"method\":\"PATCH\",\"path\":\"/credit_notes/{lago_id}/metadata\",\"summary\":\"Merge credit note metadata\",\"description\":\"This endpoint merges the provided metadata with existing metadata on the credit note.\\nExisting keys not in the request are preserved. New keys are added, existing keys are updated.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"metadata\",\"operation_id\":\"replaceCreditNoteMetadata\",\"method\":\"POST\",\"path\":\"/credit_notes/{lago_id}/metadata\",\"summary\":\"Replace credit note metadata\",\"description\":\"This endpoint replaces all existing metadata on a credit note with the provided key-value pairs.\\nAny existing metadata keys not included in the request will be removed.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"update\",\"operation_id\":\"updateCreditNote\",\"method\":\"PUT\",\"path\":\"/credit_notes/{lago_id}\",\"summary\":\"Update a credit note\",\"description\":\"This endpoint updates an existing credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"body\":{\"wrapper\":\"credit_note\",\"fields\":[{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"refund_status\"],\"flag\":\"refund-status\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:\\n\\n- `pending`: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.\\n- `succeeded`: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.\\n- `failed`: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.\",\"enum\":[\"pending\",\"succeeded\",\"failed\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"credit-notes\",\"action\":\"void\",\"operation_id\":\"voidCreditNote\",\"method\":\"PUT\",\"path\":\"/credit_notes/{lago_id}/void\",\"summary\":\"Void available credit\",\"description\":\"This endpoint voids the available credit linked to a specific credit note.\",\"docs_url\":\"https://getlago.com/docs/api-reference/credit-notes/credit-note-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The credit note unique identifier, created by Lago.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"customers\",\"action\":\"applied-coupons\",\"operation_id\":\"findAllCustomerAppliedCoupons\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/applied_coupons\",\"summary\":\"List all customer's applied coupons\",\"description\":\"This endpoint is used to list all applied coupons for a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The status of the coupon. Can be either `active` or `terminated`.\",\"enum\":[\"active\",\"terminated\"]},{\"name\":\"coupon_code[]\",\"flag\":\"coupon-code\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"The code of the coupon applied to the customer. Use it to filter applied coupons by their code.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"checkout-url\",\"operation_id\":\"generateCustomerCheckoutURL\",\"method\":\"POST\",\"path\":\"/customers/{external_customer_id}/checkout_url\",\"summary\":\"Generate a Customer Payment Provider Checkout URL\",\"description\":\"This endpoint regenerates the Payment Provider Checkout URL of a Customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application).\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"create\",\"operation_id\":\"createCustomer\",\"method\":\"POST\",\"path\":\"/customers\",\"summary\":\"Create a customer\",\"description\":\"This endpoint creates a new customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"body\":{\"wrapper\":\"customer\",\"fields\":[{\"path\":[\"account_type\"],\"flag\":\"account-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of the account. It can have one of the following values:\\n- `customer`: the account is a customer, default value.\\n- `partner`: the account is a partner.\\n\\nThis field is only applied when revenue share is enabled on your organization; otherwise it is ignored.\",\"enum\":[\"customer\",\"partner\"]},{\"path\":[\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"billing_configuration\",\"document_locale\"],\"flag\":\"billing-configuration-document-locale\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago\"},{\"path\":[\"billing_configuration\",\"invoice_grace_period\"],\"flag\":\"billing-configuration-invoice-grace-period\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items\"},{\"path\":[\"billing_configuration\",\"payment_provider\"],\"flag\":\"billing-configuration-payment-provider\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The payment provider utilized to initiate payments for invoices issued by Lago.\\nAccepted values: `stripe`, `adyen`, `cashfree`, `flutterwave`, `gocardless`, `moneyhash` or null. This field is required if you intend to assign a `provider_customer_id`.\",\"enum\":[\"stripe\",\"adyen\",\"cashfree\",\"flutterwave\",\"gocardless\",\"moneyhash\"]},{\"path\":[\"billing_configuration\",\"payment_provider_code\"],\"flag\":\"billing-configuration-payment-provider-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify a payment provider connection.\"},{\"path\":[\"billing_configuration\",\"provider_customer_id\"],\"flag\":\"billing-configuration-provider-customer-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer\"},{\"path\":[\"billing_configuration\",\"provider_payment_methods\"],\"flag\":\"billing-configuration-provider-payment-methods\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to `card`. For now, possible values are `card`, `sepa_debit`, `us_bank_account`, `bacs_debit`, `boleto`, `link`, `crypto` and `customer_balance`. Note that when `link` is selected, `card` should also be provided in the array. When `customer_balance` is selected, no other payment can be selected.\"},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_adjustment\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-adjustment\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period.\",\"enum\":[\"align_with_finalization_date\",\"keep_anchor\",\"\"]},{\"path\":[\"billing_configuration\",\"subscription_invoice_issuing_date_anchor\"],\"flag\":\"billing-configuration-subscription-invoice-issuing-date-anchor\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Defines whether the issuing date follows the current billing period's end date or the next period starting date.\",\"enum\":[\"current_period_end\",\"next_period_start\",\"\"]},{\"path\":[\"billing_configuration\",\"sync\"],\"flag\":\"billing-configuration-sync\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set this field to `true` if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the `provider_customer_id` is `null` and the customer is automatically created in the payment provider through Lago. By default, the value is set to `false`\"},{\"path\":[\"billing_configuration\",\"sync_with_provider\"],\"flag\":\"billing-configuration-sync-with-provider\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set this field to `true` if you want to create a customer record in the payment provider's system. This option is applicable only when the `provider_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The unique code of the billing entity to associate with the customer. If not provided, the default billing entity will be used.\"},{\"path\":[\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the customer's billing address\"},{\"path\":[\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Currency of the customer. Format must be ISO 4217\",\"enum\":[\"\",\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"customer_type\"],\"flag\":\"customer-type\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The type of the customer. It can have one of the following values:\\n- `company`: the customer is a company.\\n- `individual`: the customer is an individual.\",\"enum\":[\"company\",\"individual\",\"\"]},{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The email of the customer\"},{\"path\":[\"external_id\"],\"flag\":\"external-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"external_salesforce_id\"],\"flag\":\"external-salesforce-id\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The customer ID within the Salesforce system\"},{\"path\":[\"finalize_zero_amount_invoice\"],\"flag\":\"finalize-zero-amount-invoice\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies how invoices with a zero total amount should be handled:\\n- `inherit`: (Default) Follows the organization-level configuration.\\n- `finalize`: Invoices are issued and finalized even if the total amount is zero.\\n- `skip`: Invoices with a total amount of zero are not finalized.\",\"enum\":[\"inherit\",\"skip\",\"finalize\"]},{\"path\":[\"firstname\"],\"flag\":\"firstname\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"First name of the customer\"},{\"path\":[\"integration_customers\"],\"flag\":\"integration-customers\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections.\"},{\"path\":[\"lastname\"],\"flag\":\"lastname\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Last name of the customer\"},{\"path\":[\"legal_name\"],\"flag\":\"legal-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal company name of the customer\"},{\"path\":[\"legal_number\"],\"flag\":\"legal-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal company number of the customer\"},{\"path\":[\"logo_url\"],\"flag\":\"logo-url\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The logo URL of the customer\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The full name of the customer (255 characters max).\"},{\"path\":[\"net_payment_term\"],\"flag\":\"net-payment-term\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.\"},{\"path\":[\"phone\"],\"flag\":\"phone\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The phone number of the customer\"},{\"path\":[\"shipping_address\",\"address_line1\"],\"flag\":\"shipping-address-address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"shipping_address\",\"address_line2\"],\"flag\":\"shipping-address-address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"shipping_address\",\"city\"],\"flag\":\"shipping-address-city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the customer's billing address\"},{\"path\":[\"shipping_address\",\"country\"],\"flag\":\"shipping-address-country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"shipping_address\",\"state\"],\"flag\":\"shipping-address-state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the customer's billing address\"},{\"path\":[\"shipping_address\",\"zipcode\"],\"flag\":\"shipping-address-zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the customer's billing address\"},{\"path\":[\"skip_invoice_custom_sections\"],\"flag\":\"skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for this customer only. False by default\"},{\"path\":[\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the customer's billing address\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The tax identification number of the customer\"},{\"path\":[\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone\",\"enum\":[\"\",\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Godthab\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"url\"],\"flag\":\"url\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The custom website URL of the customer\"},{\"path\":[\"zipcode\"],\"flag\":\"zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the customer's billing address\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"customers\",\"action\":\"credit-notes\",\"operation_id\":\"findAllCustomerCreditNotes\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/credit_notes\",\"summary\":\"List all customer's credit notes\",\"description\":\"This endpoint list all existing credit notes for a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"issuing_date_from\",\"flag\":\"issuing-date-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes starting from a specific date.\"},{\"name\":\"issuing_date_to\",\"flag\":\"issuing-date-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes up to a specific date.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search credit notes by id, number, customer name, customer external_id or customer email.\"},{\"name\":\"reason\",\"flag\":\"reason\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by reasons. Possible values are `product_unsatisfactory`, `order_change`, `order_cancellation`, `fraudulent_charge`, `duplicated_charge` or `other`.\",\"enum\":[\"product_unsatisfactory\",\"order_change\",\"order_cancellation\",\"fraudulent_charge\",\"duplicated_charge\",\"other\"]},{\"name\":\"credit_status\",\"flag\":\"credit-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by credit status. Possible values are `available`, `consumed` or `voided`.\",\"enum\":[\"available\",\"consumed\",\"voided\"]},{\"name\":\"refund_status\",\"flag\":\"refund-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by refund status. Possible values are `pending`, `succeeded` or `failed`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\"]},{\"name\":\"invoice_number\",\"flag\":\"invoice-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter credit notes by their related invoice number.\"},{\"name\":\"purchase_order_number\",\"flag\":\"purchase-order-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by the invoice purchase order number. The match is exact but case-insensitive.\"},{\"name\":\"amount_from\",\"flag\":\"amount-from\",\"in\":\"query\",\"type\":\"integer\",\"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 types.\"},{\"name\":\"amount_to\",\"flag\":\"amount-to\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"self_billed\",\"flag\":\"self-billed\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter credit notes belonging to a self billed invoice. Possible values are `true` or `false`.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"current-usage\",\"operation_id\":\"findCustomerCurrentUsage\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/current_usage\",\"summary\":\"Retrieve customer current usage\",\"description\":\"This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application).\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":true,\"description\":\"The unique identifier of the subscription within your application.\"},{\"name\":\"apply_taxes\",\"flag\":\"apply-taxes\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.\\n\"},{\"name\":\"charge_id\",\"flag\":\"charge-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter usage to a specific charge by its Lago ID (UUID). Replaces deprecated `filter_by_charge_id`.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter usage to a specific charge by its code. Replaces deprecated `filter_by_charge_code`.\"},{\"name\":\"billable_metric_code\",\"flag\":\"billable-metric-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter usage to a specific billable metric by its code.\"},{\"name\":\"group\",\"flag\":\"group\",\"in\":\"query\",\"type\":\"object\",\"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`.\\n\"},{\"name\":\"filter_by_charge_id\",\"flag\":\"filter-by-charge-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"**Deprecated.** Filter usage to a specific charge by its Lago ID (UUID).\"},{\"name\":\"filter_by_charge_code\",\"flag\":\"filter-by-charge-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"**Deprecated.** Filter usage to a specific charge by its code.\"},{\"name\":\"filter_by_group\",\"flag\":\"filter-by-group\",\"in\":\"query\",\"type\":\"object\",\"required\":false,\"description\":\"**Deprecated.** Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `filter_by_group[cloud]=aws`.\\n\"},{\"name\":\"full_usage\",\"flag\":\"full-usage\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"When `true`, returns usage since subscription start instead of the current billing period. Requires one of `charge_id`, `charge_code`, `group` (or their deprecated `filter_by_*` equivalents) to be set.\\n\"},{\"name\":\"filter_by_presentation\",\"flag\":\"filter-by-presentation\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values will be returned. Pass an empty array to disable `presentation_breakdowns` entirely.\\n\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"delete\",\"operation_id\":\"destroyCustomer\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}\",\"summary\":\"Delete a customer\",\"description\":\"This endpoint deletes an existing customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"customers\",\"action\":\"get\",\"operation_id\":\"findCustomer\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}\",\"summary\":\"Retrieve a customer\",\"description\":\"This endpoint retrieves an existing customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"invoices\",\"operation_id\":\"findAllCustomerInvoices\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/invoices\",\"summary\":\"List all customer's invoices\",\"description\":\"This endpoint is used for retrieving all invoices of a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"amount_from\",\"flag\":\"amount-from\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"amount_to\",\"flag\":\"amount-to\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"issuing_date_from\",\"flag\":\"issuing-date-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices starting from a specific date.\"},{\"name\":\"issuing_date_to\",\"flag\":\"issuing-date-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices up to a specific date.\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by status. Possible values are `draft` or `finalized`.\",\"enum\":[\"draft\",\"finalized\"]},{\"name\":\"payment_status\",\"flag\":\"payment-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by payment status. Possible values are `pending`, `failed` or `succeeded`.\",\"enum\":[\"pending\",\"failed\",\"succeeded\"]},{\"name\":\"payment_overdue\",\"flag\":\"payment-overdue\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices by payment_overdue. Possible values are `true` or `false`.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search invoices by id, number, customer name, customer external_id or customer email.\"},{\"name\":\"payment_dispute_lost\",\"flag\":\"payment-dispute-lost\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices with a payment dispute lost. Possible values are `true` or `false`.\"},{\"name\":\"invoice_type\",\"flag\":\"invoice-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`.\",\"enum\":[\"subscription\",\"add_on\",\"credit\",\"one_off\",\"advance_charges\",\"progressive_billing\"]},{\"name\":\"self_billed\",\"flag\":\"self-billed\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices by self billed. Possible values are `true` or `false`.\"},{\"name\":\"metadata[key]\",\"flag\":\"metadata[key]\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for invoice without given metadata key. For example, `metadata[color]=blue`.\"},{\"name\":\"purchase_order_number\",\"flag\":\"purchase-order-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by the invoice purchase order number. The match is exact but case-insensitive.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"list\",\"operation_id\":\"findAllCustomers\",\"method\":\"GET\",\"path\":\"/customers\",\"summary\":\"List all customers\",\"description\":\"This endpoint retrieves all existing customers.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter customers by external ID.\"},{\"name\":\"account_type[]\",\"flag\":\"account-type\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by account type.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by billing entity codes.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter customers by search term. This will filter all customers whose name, firstname, lastname, legal name, external id or email contain the search term.\"},{\"name\":\"countries[]\",\"flag\":\"countries\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by countries. Possible values are the ISO 3166-1 alpha-2 codes.\"},{\"name\":\"states[]\",\"flag\":\"states\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by states.\"},{\"name\":\"zipcodes[]\",\"flag\":\"zipcodes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by zipcodes.\"},{\"name\":\"currencies[]\",\"flag\":\"currencies\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter customers by currencies.\"},{\"name\":\"has_tax_identification_number\",\"flag\":\"has-tax-identification-number\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter customers by whether they have a tax identification number or not.\"},{\"name\":\"metadata[key]\",\"flag\":\"metadata[key]\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter customers by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for customers without given metadata key. For example, `metadata[is_synced]=true\\u0026metadata[last_synced_at]=`.\"},{\"name\":\"customer_type\",\"flag\":\"customer-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter customers by customer type.\",\"enum\":[\"company\",\"individual\"]},{\"name\":\"has_customer_type\",\"flag\":\"has-customer-type\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter customers by whether they have a customer type or not.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"past-usage\",\"operation_id\":\"findAllCustomerPastUsage\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/past_usage\",\"summary\":\"Retrieve customer past usage\",\"description\":\"This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application).\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":true,\"description\":\"The unique identifier of the subscription within your application.\"},{\"name\":\"billable_metric_code\",\"flag\":\"billable-metric-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Billable metric code filter to apply to the charge usage\"},{\"name\":\"periods_count\",\"flag\":\"periods-count\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of past billing period to returns in the result\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"payment-requests\",\"operation_id\":\"findAllCustomerPaymentRequests\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/payment_requests\",\"summary\":\"List all customer's payment requests\",\"description\":\"This endpoint is used to list all existing payment requests of a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter the results by currency, expressed as an ISO 4217 code.\"},{\"name\":\"payment_status\",\"flag\":\"payment-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by payment status. Possible values are `pending`, `failed` or `succeeded`.\",\"enum\":[\"pending\",\"failed\",\"succeeded\"]},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter payment requests by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"payments\",\"operation_id\":\"findAllCustomerPayments\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/payments\",\"summary\":\"List all customer's payments\",\"description\":\"This endpoint is used to list all payments of a customer\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"invoice_id\",\"flag\":\"invoice-id\",\"in\":\"query\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"portal-url\",\"operation_id\":\"getCustomerPortalUrl\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/portal_url\",\"summary\":\"Get a customer portal URL\",\"description\":\"Retrieves an embeddable link for displaying a customer portal.\\n\\nThis endpoint allows you to fetch the URL that can be embedded to provide customers access to a dedicated portal\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing customer\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"projected-usage\",\"operation_id\":\"findCustomerProjectedUsage\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/projected_usage\",\"summary\":\"Retrieve customer current and projected usage\",\"description\":\"This endpoint enables the retrieval of the usage-based billing data for a customer within the current period. It also returns the projected usage for the current period based on the current usage.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application).\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":true,\"description\":\"The unique identifier of the subscription within your application.\"},{\"name\":\"apply_taxes\",\"flag\":\"apply-taxes\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.\\n\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"customers\",\"action\":\"subscriptions\",\"operation_id\":\"findAllCustomerSubscriptions\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/subscriptions\",\"summary\":\"List all customer's subscriptions\",\"description\":\"This endpoint retrieves all active subscriptions for a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/customers/object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The subscription external unique identifier (provided by your own application).\"},{\"name\":\"plan_code\",\"flag\":\"plan-code\",\"in\":\"query\",\"type\":\"string\",\"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 plans.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"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 you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter subscriptions by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"entitlements\",\"action\":\"create\",\"operation_id\":\"createEntitlement\",\"method\":\"POST\",\"path\":\"/plans/{code}/entitlements\",\"summary\":\"Create an entitlement\",\"description\":\"This endpoint creates new entitlements by adding features to a plan. Note that all existing entitlements will be deleted and replaced by the ones provided. To add a new entitlement without removing the existing ones, use PATCH. The feature must exist and all privileges must be valid for the feature.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"body\":{\"wrapper\":\"entitlements\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"destroy\",\"operation_id\":\"destroyEntitlement\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/entitlements/{feature_code}\",\"summary\":\"Delete an entitlement\",\"description\":\"This endpoint deletes an existing entitlement by removing the feature from the plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"destroy-subscription-entitlement\",\"operation_id\":\"destroySubscriptionEntitlement\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/entitlements/{feature_code}\",\"summary\":\"Remove an entitlement from a subscription\",\"description\":\"This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"destroy-subscription-entitlement-privilege\",\"operation_id\":\"destroySubscriptionEntitlementPrivilege\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}\",\"summary\":\"Remove a privilege from a subscription entitlement override\",\"description\":\"This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"},{\"name\":\"privilege_code\",\"flag\":\"privilege-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the privilege to remove from the subscription entitlement override.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"get\",\"operation_id\":\"findEntitlement\",\"method\":\"GET\",\"path\":\"/plans/{code}/entitlements/{feature_code}\",\"summary\":\"Retrieve an entitlement\",\"description\":\"This endpoint retrieves a specific entitlement for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"entitlements\",\"action\":\"list\",\"operation_id\":\"findAllEntitlements\",\"method\":\"GET\",\"path\":\"/plans/{code}/entitlements\",\"summary\":\"List all entitlements\",\"description\":\"This endpoint retrieves all entitlements for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"entitlements\",\"action\":\"list-subscription-entitlements\",\"operation_id\":\"findAllSubscriptionEntitlements\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/entitlements\",\"summary\":\"List all subscription entitlements\",\"description\":\"This endpoint retrieves all entitlements for a specific subscription, including both plan entitlements and any subscription-specific overrides.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"entitlements\",\"action\":\"remove-entitlement-privilege\",\"operation_id\":\"removeEntitlementPrivilege\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/entitlements/{feature_code}/privileges/{privilege_code}\",\"summary\":\"Remove a privilege from an entitlement\",\"description\":\"This endpoint removes a specific privilege and its value from an entitlement. The privilege remains untouched on the original feature.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"feature_code\",\"flag\":\"feature-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"},{\"name\":\"privilege_code\",\"flag\":\"privilege-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the privilege to remove from the entitlement.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"update\",\"operation_id\":\"updateEntitlement\",\"method\":\"PATCH\",\"path\":\"/plans/{code}/entitlements\",\"summary\":\"Partial update of an entitlement\",\"description\":\"This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"body\":{\"wrapper\":\"entitlements\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"entitlements\",\"action\":\"update-subscription-entitlements\",\"operation_id\":\"updateSubscriptionEntitlements\",\"method\":\"PATCH\",\"path\":\"/subscriptions/{external_id}/entitlements\",\"summary\":\"Update subscription entitlements\",\"description\":\"This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"entitlements\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"events\",\"action\":\"batch\",\"operation_id\":\"createBatchEvents\",\"method\":\"POST\",\"path\":\"/events/batch\",\"summary\":\"Batch multiple events\",\"description\":\"This endpoint can be used to send a batch of usage records. Each request may include up to 100 events.\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"fields\":[{\"path\":[\"events\"],\"flag\":\"events\",\"type\":\"array\",\"required\":true,\"complex\":true}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"batch-estimate-instant-fees\",\"operation_id\":\"eventBatchEstimateInstantFees\",\"method\":\"POST\",\"path\":\"/events/batch_estimate_instant_fees\",\"summary\":\"Batch estimate instant fees for a pay in advance charge\",\"description\":\"Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance standard or percentage charges\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"fields\":[{\"path\":[\"events\"],\"flag\":\"events\",\"type\":\"array\",\"required\":true,\"complex\":true}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"estimate-fees\",\"operation_id\":\"eventEstimateFees\",\"method\":\"POST\",\"path\":\"/events/estimate_fees\",\"summary\":\"Estimate fees for a pay in advance charge\",\"description\":\"Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance charges\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"wrapper\":\"event\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.\"},{\"path\":[\"external_subscription_id\"],\"flag\":\"external-subscription-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique identifier of the subscription within your application.\"},{\"path\":[\"properties\"],\"flag\":\"properties\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required. Any property of the targeted billable metric can be sent here, in addition to the documented fields below.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"estimate-instant-fees\",\"operation_id\":\"eventEstimateInstantFees\",\"method\":\"POST\",\"path\":\"/events/estimate_instant_fees\",\"summary\":\"Estimate instant fees for a pay in advance charge\",\"description\":\"Estimate the fees that would be created after reception of an event for a billable metric attached to one or multiple pay in advance standard or percentage charges\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"wrapper\":\"event\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.\"},{\"path\":[\"external_subscription_id\"],\"flag\":\"external-subscription-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique identifier of the subscription within your application.\"},{\"path\":[\"properties\"],\"flag\":\"properties\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.\"},{\"path\":[\"transaction_id\"],\"flag\":\"transaction-id\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field represents a unique identifier for the event.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"get\",\"operation_id\":\"findEvent\",\"method\":\"GET\",\"path\":\"/events/{transaction_id}\",\"summary\":\"Retrieve a specific event\",\"description\":\"This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.\\n\\nNote that transaction_id is unique per external_subscription_id so multiple subscriptions can share the same transaction_id. This endpoint will only return the first event found with the given transaction_id.\\n\\nWARNING: If your Lago organization is configured to use the Clickhouse-based event pipeline, multiple events can share the same `transaction_id` (with different timestamps). This endpoint will only return the first event found.\\n\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"parameters\":[{\"name\":\"transaction_id\",\"flag\":\"transaction-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"This field represents the unique identifier sent for this specific event (must be URL encoded).\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"events\",\"action\":\"list\",\"operation_id\":\"findAllEvents\",\"method\":\"GET\",\"path\":\"/events\",\"summary\":\"List all events\",\"description\":\"This endpoint is used for retrieving all events.\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"External subscription ID\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter events by its code.\"},{\"name\":\"timestamp_from_started_at\",\"flag\":\"timestamp-from-started-at\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Requires `external_subscription_id` to be set. Filter events by timestamp after the subscription started at datetime.\"},{\"name\":\"timestamp_from\",\"flag\":\"timestamp-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter events by timestamp starting from a specific date.\"},{\"name\":\"timestamp_to\",\"flag\":\"timestamp-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter events by timestamp up to a specific date.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"events\",\"action\":\"send\",\"operation_id\":\"createEvent\",\"method\":\"POST\",\"path\":\"/events\",\"summary\":\"Send usage events\",\"description\":\"This endpoint is used for transmitting usage measurement events to either a designated customer or a specific subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/events/event-object\",\"body\":{\"wrapper\":\"event\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The code that identifies a targeted billable metric. It is essential that this code matches the `code` property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.\"},{\"path\":[\"external_subscription_id\"],\"flag\":\"external-subscription-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique identifier of the subscription in your application. This field is mandatory in order to link events to the correct customer subscription.\"},{\"path\":[\"precise_total_amount_cents\"],\"flag\":\"precise-total-amount-cents\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The precise total amount in cents with precision used by the `dynamic` pricing model to compute the usage amount.\"},{\"path\":[\"properties\"],\"flag\":\"properties\",\"type\":\"object\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.\"},{\"path\":[\"timestamp\"],\"flag\":\"timestamp\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).\\nIf this timestamp is not provided, the API will automatically set it to the time of event reception.\\nYou can also provide miliseconds precision by appending decimals to the timestamp.\\n\"},{\"path\":[\"transaction_id\"],\"flag\":\"transaction-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"This field represents a unique identifier for the event.\\nIt is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.\\n\\nWARNING: If the Lago organization is configured to use the new Clickhouse-based event pipeline (designed for high-volume processing), the idempotency logic is handled differently.\\nEvent uniqueness is maintained with both `transaction_id` and `timestamp` fields.\\nIf a new event arrives with identical values for these two fields as an existing event, the new one will overwrite the previous event rather than being rejected.\\n\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"features\",\"action\":\"create\",\"operation_id\":\"createFeature\",\"method\":\"POST\",\"path\":\"/features\",\"summary\":\"Create a feature\",\"description\":\"This endpoint creates a new feature representing an entitlement component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"body\":{\"wrapper\":\"feature\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the feature.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the feature.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Name of the feature.\"},{\"path\":[\"privileges\"],\"flag\":\"privileges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Privileges associated with this feature. Can be empty.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"features\",\"action\":\"delete\",\"operation_id\":\"destroyFeature\",\"method\":\"DELETE\",\"path\":\"/features/{code}\",\"summary\":\"Delete a feature\",\"description\":\"This endpoint deletes an existing feature representing an entitlement component of your application. Deleting a feature will remove it from all plans and subscriptions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"features\",\"action\":\"delete-feature-privilege\",\"operation_id\":\"deleteFeaturePrivilege\",\"method\":\"DELETE\",\"path\":\"/features/{code}/privileges/{privilege_code}\",\"summary\":\"Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.\",\"description\":\"Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"},{\"name\":\"privilege_code\",\"flag\":\"privilege-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing privilege.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"features\",\"action\":\"get\",\"operation_id\":\"findFeature\",\"method\":\"GET\",\"path\":\"/features/{code}\",\"summary\":\"Retrieve a feature\",\"description\":\"This endpoint retrieves an existing feature that represents an entitlement component of your application. The feature is identified by its unique code.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"features\",\"action\":\"list\",\"operation_id\":\"findAllFeatures\",\"method\":\"GET\",\"path\":\"/features\",\"summary\":\"List all features\",\"description\":\"This endpoint retrieves all existing features that represent entitlement components of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search in name, code and description.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"features\",\"action\":\"update\",\"operation_id\":\"updateFeature\",\"method\":\"PUT\",\"path\":\"/features/{code}\",\"summary\":\"Update a feature\",\"description\":\"This endpoint updates an existing feature representing an entitlement component of your application.\",\"docs_url\":\"https://getlago.com/docs/api-reference/entitlements/features/feature-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing feature.\"}],\"body\":{\"wrapper\":\"feature\",\"fields\":[{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the feature.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Name of the feature.\"},{\"path\":[\"privileges\"],\"flag\":\"privileges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Privileges associated with this feature. Can be empty.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"fees\",\"action\":\"delete\",\"operation_id\":\"deleteFee\",\"method\":\"DELETE\",\"path\":\"/fees/{lago_id}\",\"summary\":\"Delete a fee\",\"description\":\"This endpoint is used for deleting a specific fee that has not yet been invoiced\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the fee's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"fees\",\"action\":\"get\",\"operation_id\":\"findFee\",\"method\":\"GET\",\"path\":\"/fees/{lago_id}\",\"summary\":\"Retrieve a specific fee\",\"description\":\"This endpoint is used for retrieving a specific fee that has been issued.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the fee's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"fees\",\"action\":\"list\",\"operation_id\":\"findAllFees\",\"method\":\"GET\",\"path\":\"/fees\",\"summary\":\"List all fees\",\"description\":\"This endpoint is used for retrieving all fees that have been issued.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"external_subscription_id\",\"flag\":\"external-subscription-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"External subscription ID\"},{\"name\":\"event_transaction_id\",\"flag\":\"event-transaction-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by event transaction ID\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by the fee's currency.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"name\":\"fee_type\",\"flag\":\"fee-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The fee type. Possible values are `add_on`, `charge`, `fixed_charge`, `credit`, `subscription` or `commitment`.\",\"enum\":[\"charge\",\"fixed_charge\",\"add_on\",\"subscription\",\"credit\",\"commitment\"]},{\"name\":\"billable_metric_code\",\"flag\":\"billable-metric-code\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results by the `code` of the billable metric attached to the fee. Only applies to `charge` types.\"},{\"name\":\"payment_status\",\"flag\":\"payment-status\",\"in\":\"query\",\"type\":\"string\",\"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 this field are `pending`, `succeeded`, `failed` and `refunded`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\",\"refunded\"]},{\"name\":\"created_at_from\",\"flag\":\"created-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results created at or after this date and time in UTC.\"},{\"name\":\"created_at_to\",\"flag\":\"created-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results created at or before this date and time in UTC.\"},{\"name\":\"succeeded_at_from\",\"flag\":\"succeeded-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment success at or after this date and time in UTC.\"},{\"name\":\"succeeded_at_to\",\"flag\":\"succeeded-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment success at or before this date and time in UTC.\"},{\"name\":\"failed_at_from\",\"flag\":\"failed-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment failure at or after this date and time in UTC.\"},{\"name\":\"failed_at_to\",\"flag\":\"failed-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment failure at or before this date and time in UTC.\"},{\"name\":\"refunded_at_from\",\"flag\":\"refunded-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment refund at or after this date and time in UTC.\"},{\"name\":\"refunded_at_to\",\"flag\":\"refunded-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter results with a payment refund at or before this date and time in UTC.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"fees\",\"action\":\"update\",\"operation_id\":\"updateFee\",\"method\":\"PUT\",\"path\":\"/fees/{lago_id}\",\"summary\":\"Update a fee\",\"description\":\"This endpoint is used for updating a specific fee that has been issued.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the fee's record within the Lago system.\"}],\"body\":{\"wrapper\":\"fee\",\"fields\":[{\"path\":[\"payment_status\"],\"flag\":\"payment-status\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The payment status of the fee. Possible values are `pending`, `succeeded`, `failed` or `refunded`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\",\"refunded\"]}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"create\",\"operation_id\":\"createInvoice\",\"method\":\"POST\",\"path\":\"/invoices\",\"summary\":\"Create a one-off invoice\",\"description\":\"This endpoint is used for issuing a one-off invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"body\":{\"wrapper\":\"invoice\",\"fields\":[{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity to issue the invoice from. If not provided, the customer's billing entity is used.\"},{\"path\":[\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the invoice.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"path\":[\"fees\"],\"flag\":\"fees\",\"type\":\"array\",\"required\":true,\"complex\":true},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number to associate with the invoice.\"},{\"path\":[\"skip_psp\"],\"flag\":\"skip-psp\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"If true, the invoice will be created but not sent to the payment provider.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"delete\",\"operation_id\":\"deleteInvoice\",\"method\":\"DELETE\",\"path\":\"/invoices/{lago_id}\",\"summary\":\"Delete a draft invoice\",\"description\":\"This endpoint is used for permanently deleting a `draft` invoice. Deleting a draft invoice removes it entirely: it never becomes accounts receivable, consumes no invoice number, and disappears from every list, export, and analytics surface. Only invoices in the `draft` status can be deleted; for a `finalized` invoice, void it instead.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"download\",\"operation_id\":\"downloadInvoice\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/download\",\"summary\":\"Download an invoice PDF\",\"description\":\"This endpoint is used for downloading a specific invoice PDF document.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"finalize\",\"operation_id\":\"finalizeInvoice\",\"method\":\"PUT\",\"path\":\"/invoices/{lago_id}/finalize\",\"summary\":\"Finalize a draft invoice\",\"description\":\"This endpoint is used for finalizing a draft invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"get\",\"operation_id\":\"findInvoice\",\"method\":\"GET\",\"path\":\"/invoices/{lago_id}\",\"summary\":\"Retrieve an invoice\",\"description\":\"This endpoint is used for retrieving a specific invoice that has been issued.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"list\",\"operation_id\":\"findAllInvoices\",\"method\":\"GET\",\"path\":\"/invoices\",\"summary\":\"List all invoices\",\"description\":\"This endpoint is used for retrieving all invoices.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"amount_from\",\"flag\":\"amount-from\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"amount_to\",\"flag\":\"amount-to\",\"in\":\"query\",\"type\":\"integer\",\"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.\"},{\"name\":\"issuing_date_from\",\"flag\":\"issuing-date-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices starting from a specific date.\"},{\"name\":\"issuing_date_to\",\"flag\":\"issuing-date-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices up to a specific date.\"},{\"name\":\"statuses[]\",\"flag\":\"statuses\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`.\"},{\"name\":\"payment_statuses[]\",\"flag\":\"payment-statuses\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`.\"},{\"name\":\"payment_overdue\",\"flag\":\"payment-overdue\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices by payment_overdue. Possible values are `true` or `false`.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search invoices by id, number, customer name, customer external_id or customer email.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by currency. Possible values ISO 4217 currency codes.\"},{\"name\":\"payment_dispute_lost\",\"flag\":\"payment-dispute-lost\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices with a payment dispute lost. Possible values are `true` or `false`.\"},{\"name\":\"partially_paid\",\"flag\":\"partially-paid\",\"in\":\"query\",\"type\":\"boolean\",\"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. When `false`, those invoices are excluded.\"},{\"name\":\"settlements[]\",\"flag\":\"settlements\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter invoices settled by at least one of the given settlement types. `payment` matches invoices settled by a payment, `credit_note` matches invoices settled by a credit note.\"},{\"name\":\"invoice_type\",\"flag\":\"invoice-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`.\",\"enum\":[\"subscription\",\"add_on\",\"credit\",\"one_off\",\"advance_charges\",\"progressive_billing\"]},{\"name\":\"self_billed\",\"flag\":\"self-billed\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"Filter invoices by self billed. Possible values are `true` or `false`.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter invoices by billing entity codes. Possible values are the billing entity codes you have created.\"},{\"name\":\"metadata[key]\",\"flag\":\"metadata[key]\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for invoice without given metadata key. For example, `metadata[color]=blue`.\"},{\"name\":\"purchase_order_number\",\"flag\":\"purchase-order-number\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by the invoice purchase order number. The match is exact but case-insensitive.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"lose-dispute\",\"operation_id\":\"loseDisputeInvoice\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/lose_dispute\",\"summary\":\"Mark an invoice payment dispute as lost\",\"description\":\"This endpoint is used for setting invoice's payment dispute as lost.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"payment-url\",\"operation_id\":\"invoicePaymentUrl\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/payment_url\",\"summary\":\"Generate a payment URL\",\"description\":\"This endpoint generates a checkout link for a specific invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"preview\",\"operation_id\":\"invoicePreview\",\"method\":\"POST\",\"path\":\"/invoices/preview\",\"summary\":\"Create an invoice preview\",\"description\":\"This endpoint is used for generating invoice preview.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"body\":{\"fields\":[{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity to which will be associated a customer if the external_id is not provided. If billing_entity_code is not provided, default billing_entity of organization will be used.\"},{\"path\":[\"billing_time\"],\"flag\":\"billing-time\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).\",\"enum\":[\"calendar\",\"anniversary\"]},{\"path\":[\"coupons\"],\"flag\":\"coupons\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"customer\",\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"customer\",\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"customer\",\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The city of the customer's billing address\"},{\"path\":[\"customer\",\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)\",\"enum\":[\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"customer\",\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the invoice.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"customer\",\"external_id\"],\"flag\":\"external-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"path\":[\"customer\",\"integration_customers\"],\"flag\":\"integration-customers\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"customer\",\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The full name of the customer\"},{\"path\":[\"customer\",\"shipping_address\",\"address_line1\"],\"flag\":\"shipping-address-address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of the billing address\"},{\"path\":[\"customer\",\"shipping_address\",\"address_line2\"],\"flag\":\"shipping-address-address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of the billing address\"},{\"path\":[\"customer\",\"shipping_address\",\"city\"],\"flag\":\"shipping-address-city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of the customer's billing address\"},{\"path\":[\"customer\",\"shipping_address\",\"country\"],\"flag\":\"shipping-address-country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"customer\",\"shipping_address\",\"state\"],\"flag\":\"shipping-address-state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of the customer's billing address\"},{\"path\":[\"customer\",\"shipping_address\",\"zipcode\"],\"flag\":\"shipping-address-zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of the customer's billing address\"},{\"path\":[\"customer\",\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The state of the customer's billing address\"},{\"path\":[\"customer\",\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The tax identification number of the customer\"},{\"path\":[\"customer\",\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone\",\"enum\":[\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Nuuk\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"plan_code\"],\"flag\":\"plan-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"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 system-level identification purposes, like assigning a subscription, for instance.\"},{\"path\":[\"subscription_at\"],\"flag\":\"subscription-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"subscriptions\",\"external_ids\"],\"flag\":\"subscriptions-external-ids\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"subscriptions\",\"plan_code\"],\"flag\":\"subscriptions-plan-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the plan. It serves as a unique identifier associated with the new plan to which the customer is upgrading or downgrading.\"},{\"path\":[\"subscriptions\",\"terminated_at\"],\"flag\":\"subscriptions-terminated-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The date and time when the subscription is terminated. It should defined in the future.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"invoices\",\"action\":\"refresh\",\"operation_id\":\"refreshInvoice\",\"method\":\"PUT\",\"path\":\"/invoices/{lago_id}/refresh\",\"summary\":\"Refresh a draft invoice\",\"description\":\"This endpoint is used for refreshing a draft invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"retry\",\"operation_id\":\"retryInvoice\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/retry\",\"summary\":\"Retry generation of a failed invoice\",\"description\":\"This endpoint is used for retrying to generate a failed invoice.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"retry-payment\",\"operation_id\":\"retryPayment\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/retry_payment\",\"summary\":\"Retry an invoice payment\",\"description\":\"This endpoint resends an invoice for collection and retry a payment.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"body\":{\"wrapper\":\"payment_method\",\"fields\":[{\"path\":[\"payment_method_id\"],\"flag\":\"payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method_type\"],\"flag\":\"payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"update\",\"operation_id\":\"updateInvoice\",\"method\":\"PUT\",\"path\":\"/invoices/{lago_id}\",\"summary\":\"Update an invoice\",\"description\":\"This endpoint is used for updating an existing invoice. A voided invoice cannot be updated and returns a `405` error.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"body\":{\"wrapper\":\"invoice\",\"fields\":[{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"array\",\"required\":false,\"complex\":true},{\"path\":[\"payment_status\"],\"flag\":\"payment-status\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The payment status of the invoice. Possible values are `pending`, `failed` or `succeeded`.\",\"enum\":[\"pending\",\"succeeded\",\"failed\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"invoices\",\"action\":\"void\",\"operation_id\":\"voidInvoice\",\"method\":\"POST\",\"path\":\"/invoices/{lago_id}/void\",\"summary\":\"Void an invoice\",\"description\":\"This endpoint is used for voiding an invoice.\\n• When no body parameters are provided, the invoice can be voided only if it is in a `finalized` status and its payment status is NOT `succeeded`.\\n• When `generate_credit_note` is provided (optionally with `refund_amount` and/or `credit_amount`), this validation is bypassed: the invoice is forcibly voided and a credit note is generated. If the specified refund/credit amounts do not cover the full invoice total, the remainder is issued on a second credit note that is created and immediately voided.\",\"docs_url\":\"https://getlago.com/docs/api-reference/invoices/invoice-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"body\":{\"fields\":[{\"path\":[\"credit_amount\"],\"flag\":\"credit-amount\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Portion of the invoice amount (in cents) to be credited to the customer's balance in the generated credit note.\"},{\"path\":[\"generate_credit_note\"],\"flag\":\"generate-credit-note\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to force voiding the invoice and generate a credit note.\"},{\"path\":[\"refund_amount\"],\"flag\":\"refund-amount\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Portion of the invoice amount (in cents) to be refunded to the customer in the generated credit note.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"order-forms\",\"action\":\"get\",\"operation_id\":\"findOrderForm\",\"method\":\"GET\",\"path\":\"/order_forms/{lago_id}\",\"summary\":\"Retrieve an order form\",\"description\":\"This endpoint retrieves a specific order form.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order form's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"order-forms\",\"action\":\"list\",\"operation_id\":\"findAllOrderForms\",\"method\":\"GET\",\"path\":\"/order_forms\",\"summary\":\"List all order forms\",\"description\":\"This endpoint is used to list all existing order forms.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by status. Possible values are `generated`, `signed`, `expired` and `voided`.\"},{\"name\":\"customer_id[]\",\"flag\":\"customer-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by the Lago identifiers of their customers.\"},{\"name\":\"number[]\",\"flag\":\"number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by their number, as assigned by Lago.\"},{\"name\":\"quote_number[]\",\"flag\":\"quote-number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by the number of the quote they come from.\"},{\"name\":\"owner_id[]\",\"flag\":\"owner-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter order forms by the Lago identifiers of the users owning the quote they come from.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search order forms by number.\"},{\"name\":\"created_at_from\",\"flag\":\"created-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter order forms created from a specific date and time, in UTC (ISO 8601).\"},{\"name\":\"created_at_to\",\"flag\":\"created-at-to\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter order forms created up to a specific date and time, in UTC (ISO 8601).\"},{\"name\":\"expires_at_from\",\"flag\":\"expires-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"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\",\"flag\":\"expires-at-to\",\"in\":\"query\",\"type\":\"string\",\"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.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"order-forms\",\"action\":\"mark-as-signed\",\"operation_id\":\"markOrderFormAsSigned\",\"method\":\"POST\",\"path\":\"/order_forms/{lago_id}/mark_as_signed\",\"summary\":\"Mark an order form as signed\",\"description\":\"This endpoint records the customer's signature on an order form, and creates the order that carries the quoted deal out.\\nOnly a `generated` order form can be signed, so a `422` is returned once the order form has been signed, has expired or has been voided.\\nAn `execute_at` landing on or after the day the quoted deal stops being executable is rejected as well, so the order can never be scheduled past the term it bills.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order form's record within the Lago system.\"}],\"body\":{\"wrapper\":\"order_form\",\"fields\":[{\"path\":[\"execute_at\"],\"flag\":\"execute-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The date and time in UTC (ISO 8601) when Lago executes the order created from the order form. It must be in the future, requires `execution_mode` to be set, and must fall strictly before the day the quoted deal stops being executable, otherwise signing is rejected with a `422`. When it is omitted, the order is created but not scheduled, and waits to be executed on demand.\"},{\"path\":[\"execution_mode\"],\"flag\":\"execution-mode\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"How the order created from the order form is carried out. It becomes mandatory as soon as `execute_at` is provided.\",\"enum\":[\"execute_in_lago\",\"order_only\"]},{\"path\":[\"signed_document\"],\"flag\":\"signed-document\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The document signed by the customer, as a base64 data URI (`data:\\u003ccontent_type\\u003e;base64,\\u003cdata\\u003e`). Accepted content types are `application/pdf`, `image/jpeg` and `image/png`, for a maximum of 10 MB. Once attached, it is exposed as `signed_document_url` on the order form.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"order-forms\",\"action\":\"void\",\"operation_id\":\"voidOrderForm\",\"method\":\"POST\",\"path\":\"/order_forms/{lago_id}/void\",\"summary\":\"Void an order form\",\"description\":\"This endpoint voids an order form, with the `manual` reason, and cascades to the quote version it was generated from, which is voided with the `cascade_of_voided` reason.\\nOnly a `generated` order form can be voided, so a `422` is returned once the order form has been signed, has expired or has already been voided.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order form's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"orders\",\"action\":\"execute\",\"operation_id\":\"executeOrder\",\"method\":\"POST\",\"path\":\"/orders/{lago_id}/execute\",\"summary\":\"Execute an order\",\"description\":\"This endpoint carries out an order on demand, without waiting for its `execute_at` schedule. It runs synchronously, so the response carries the resulting status and, when the execution fails, the reason it failed.\\nAn `execute_in_lago` order applies the quoted deal, creating the subscriptions, coupons, wallets or one-off invoice it describes; an `order_only` order is simply marked as executed. What the execution produced is listed in `execution_record`.\\nExecuting is idempotent: an order that has already been executed is returned untouched. An order whose previous execution failed is executed again, and a `422` is returned when the order carries no execution mode and none is provided in the body.\\nRestating an `execution_mode` that differs from the one stored on the order updates it first, which only succeeds while the order is still `created`: a `failed` order can be retried, but not switched to another mode. That update also re-validates the order's own `execute_at` against the day the quoted deal stops being executable, so a `422` is possible even though no date was sent. An order carrying no `execute_at` is not bounded that way, and a deal whose term has passed then only fails when the execution runs.\\nA `404` is not limited to an unknown order: when the execution cannot find a catalog record the quote pinned, such as a deleted plan, charge, coupon or the subscription being amended, the missing resource is reported as a `404` and the order is left `failed`.\\nConcurrency is reported two ways. A mode change losing the race on the quote comes back as a `422` validation error, while the execution itself losing it comes back as a `422` carrying a lock code, because a scheduled execution relies on that error to be retried.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order's record within the Lago system.\"}],\"body\":{\"wrapper\":\"order\",\"fields\":[{\"path\":[\"execution_mode\"],\"flag\":\"execution-mode\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"How the order is carried out. It is only persisted when it differs from the mode already stored on the order, so restating the current mode never fails. Changing the mode of an order that has already been executed is rejected.\",\"enum\":[\"execute_in_lago\",\"order_only\"]}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"orders\",\"action\":\"get\",\"operation_id\":\"findOrder\",\"method\":\"GET\",\"path\":\"/orders/{lago_id}\",\"summary\":\"Retrieve an order\",\"description\":\"This endpoint retrieves a specific order, along with the `billing_snapshot` its execution applies and the `execution_record` of what it produced.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the order's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"orders\",\"action\":\"list\",\"operation_id\":\"findAllOrders\",\"method\":\"GET\",\"path\":\"/orders\",\"summary\":\"List all orders\",\"description\":\"This endpoint is used to list all existing orders.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by status. Possible values are `created`, `executed` and `failed`.\"},{\"name\":\"order_type[]\",\"flag\":\"order-type\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the order type of the quote they come from. Possible values are `subscription_creation`, `subscription_amendment` and `one_off`.\"},{\"name\":\"execution_mode[]\",\"flag\":\"execution-mode\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by execution mode. Possible values are `execute_in_lago` and `order_only`.\"},{\"name\":\"customer_id[]\",\"flag\":\"customer-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the Lago identifiers of their customers.\"},{\"name\":\"number[]\",\"flag\":\"number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by their number, as assigned by Lago.\"},{\"name\":\"order_form_number[]\",\"flag\":\"order-form-number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the number of the order form they come from.\"},{\"name\":\"quote_number[]\",\"flag\":\"quote-number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the number of the quote they come from.\"},{\"name\":\"owner_id[]\",\"flag\":\"owner-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter orders by the Lago identifiers of the users owning the quote they come from.\"},{\"name\":\"search_term\",\"flag\":\"search-term\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Search orders by number.\"},{\"name\":\"executed_at_from\",\"flag\":\"executed-at-from\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"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\",\"flag\":\"executed-at-to\",\"in\":\"query\",\"type\":\"string\",\"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.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"organizations\",\"action\":\"get\",\"operation_id\":\"findOrganization\",\"method\":\"GET\",\"path\":\"/organizations\",\"summary\":\"Retrieve your organization\",\"description\":\"This endpoint retrieves your own organization's settings.\",\"docs_url\":\"https://getlago.com/docs/api-reference/organizations/organization-object\",\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"organizations\",\"action\":\"update\",\"operation_id\":\"updateOrganization\",\"method\":\"PUT\",\"path\":\"/organizations\",\"summary\":\"Update your organization\",\"description\":\"This endpoint is used to update your own organization's settings.\",\"docs_url\":\"https://getlago.com/docs/api-reference/organizations/organization-object\",\"body\":{\"wrapper\":\"organization\",\"fields\":[{\"path\":[\"address_line1\"],\"flag\":\"address-line1\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The first line of your organization's billing address.\"},{\"path\":[\"address_line2\"],\"flag\":\"address-line2\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The second line of your organization's billing address.\"},{\"path\":[\"billing_configuration\",\"document_locale\"],\"flag\":\"billing-configuration-document-locale\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The locale of the billing documents, expressed in the ISO 639-1 format. This field indicates the language or regional variant used for the documents content issued or the embeddable customer portal.\"},{\"path\":[\"billing_configuration\",\"invoice_footer\"],\"flag\":\"billing-configuration-invoice-footer\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The customer invoice message that appears at the bottom of each billing documents.\"},{\"path\":[\"billing_configuration\",\"invoice_grace_period\"],\"flag\":\"billing-configuration-invoice-grace-period\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer's grace period.\"},{\"path\":[\"city\"],\"flag\":\"city\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The city of your organization's billing address.\"},{\"path\":[\"country\"],\"flag\":\"country\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The country of your organization.\",\"enum\":[\"\",\"AD\",\"AE\",\"AF\",\"AG\",\"AI\",\"AL\",\"AM\",\"AO\",\"AQ\",\"AR\",\"AS\",\"AT\",\"AU\",\"AW\",\"AX\",\"AZ\",\"BA\",\"BB\",\"BD\",\"BE\",\"BF\",\"BG\",\"BH\",\"BI\",\"BJ\",\"BL\",\"BM\",\"BN\",\"BO\",\"BQ\",\"BR\",\"BS\",\"BT\",\"BV\",\"BW\",\"BY\",\"BZ\",\"CA\",\"CC\",\"CD\",\"CF\",\"CG\",\"CH\",\"CI\",\"CK\",\"CL\",\"CM\",\"CN\",\"CO\",\"CR\",\"CU\",\"CV\",\"CW\",\"CX\",\"CY\",\"CZ\",\"DE\",\"DJ\",\"DK\",\"DM\",\"DO\",\"DZ\",\"EC\",\"EE\",\"EG\",\"EH\",\"ER\",\"ES\",\"ET\",\"FI\",\"FJ\",\"FK\",\"FM\",\"FO\",\"FR\",\"GA\",\"GB\",\"GD\",\"GE\",\"GF\",\"GG\",\"GH\",\"GI\",\"GL\",\"GM\",\"GN\",\"GP\",\"GQ\",\"GR\",\"GS\",\"GT\",\"GU\",\"GW\",\"GY\",\"HK\",\"HM\",\"HN\",\"HR\",\"HT\",\"HU\",\"ID\",\"IE\",\"IL\",\"IM\",\"IN\",\"IO\",\"IQ\",\"IR\",\"IS\",\"IT\",\"JE\",\"JM\",\"JO\",\"JP\",\"KE\",\"KG\",\"KH\",\"KI\",\"KM\",\"KN\",\"KP\",\"KR\",\"KW\",\"KY\",\"KZ\",\"LA\",\"LB\",\"LC\",\"LI\",\"LK\",\"LR\",\"LS\",\"LT\",\"LU\",\"LV\",\"LY\",\"MA\",\"MC\",\"MD\",\"ME\",\"MF\",\"MG\",\"MH\",\"MK\",\"ML\",\"MM\",\"MN\",\"MO\",\"MP\",\"MQ\",\"MR\",\"MS\",\"MT\",\"MU\",\"MV\",\"MW\",\"MX\",\"MY\",\"MZ\",\"NA\",\"NC\",\"NE\",\"NF\",\"NG\",\"NI\",\"NL\",\"NO\",\"NP\",\"NR\",\"NU\",\"NZ\",\"OM\",\"PA\",\"PE\",\"PF\",\"PG\",\"PH\",\"PK\",\"PL\",\"PM\",\"PN\",\"PR\",\"PS\",\"PT\",\"PW\",\"PY\",\"QA\",\"RE\",\"RO\",\"RS\",\"RU\",\"RW\",\"SA\",\"SB\",\"SC\",\"SD\",\"SE\",\"SG\",\"SH\",\"SI\",\"SJ\",\"SK\",\"SL\",\"SM\",\"SN\",\"SO\",\"SR\",\"SS\",\"ST\",\"SV\",\"SX\",\"SY\",\"SZ\",\"TC\",\"TD\",\"TF\",\"TG\",\"TH\",\"TJ\",\"TK\",\"TL\",\"TM\",\"TN\",\"TO\",\"TR\",\"TT\",\"TV\",\"TW\",\"TZ\",\"UA\",\"UG\",\"UM\",\"US\",\"UY\",\"UZ\",\"VA\",\"VC\",\"VE\",\"VG\",\"VI\",\"VN\",\"VU\",\"WF\",\"WS\",\"YE\",\"YT\",\"ZA\",\"ZM\",\"ZW\"]},{\"path\":[\"default_currency\"],\"flag\":\"default-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The default currency of an organization.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"document_number_prefix\"],\"flag\":\"document-number-prefix\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.\"},{\"path\":[\"document_numbering\"],\"flag\":\"document-numbering\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"This parameter configures the method of incrementing invoice numbers for your customers.\\n\\n- `per_customer`: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.\\n- `per_organization`: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.\\n\\nThe default value for `document_numbering` is set to `per_customer`, meaning that, unless changed, invoice numbers will increment uniquely for each customer.\",\"enum\":[\"per_customer\",\"per_organization\"]},{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The email address of your organization used to bill your customers.\"},{\"path\":[\"email_settings\"],\"flag\":\"email-settings\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values are `invoice.finalized`, `credit_note.created` and `payment_receipt.created`.\"},{\"path\":[\"finalize_zero_amount_invoice\"],\"flag\":\"finalize-zero-amount-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.\"},{\"path\":[\"legal_name\"],\"flag\":\"legal-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal name of your organization.\"},{\"path\":[\"legal_number\"],\"flag\":\"legal-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The legal number of your organization.\"},{\"path\":[\"net_payment_term\"],\"flag\":\"net-payment-term\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.\"},{\"path\":[\"slug\"],\"flag\":\"slug\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"A concise and unique identifier for your organization, used as a prefix in customer slugs.\"},{\"path\":[\"state\"],\"flag\":\"state\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The state of your organization's billing address.\"},{\"path\":[\"tax_identification_number\"],\"flag\":\"tax-identification-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The tax identification number of your organization.\"},{\"path\":[\"timezone\"],\"flag\":\"timezone\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.\",\"enum\":[\"UTC\",\"Africa/Algiers\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"America/Argentina/Buenos_Aires\",\"America/Bogota\",\"America/Caracas\",\"America/Chicago\",\"America/Chihuahua\",\"America/Denver\",\"America/Guatemala\",\"America/Guyana\",\"America/Halifax\",\"America/Indiana/Indianapolis\",\"America/Juneau\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Mazatlan\",\"America/Mexico_City\",\"America/Monterrey\",\"America/Montevideo\",\"America/New_York\",\"America/Nuuk\",\"America/Phoenix\",\"America/Puerto_Rico\",\"America/Regina\",\"America/Santiago\",\"America/Sao_Paulo\",\"America/St_Johns\",\"America/Tijuana\",\"Asia/Almaty\",\"Asia/Baghdad\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Chongqing\",\"Asia/Colombo\",\"Asia/Dhaka\",\"Asia/Hong_Kong\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Kathmandu\",\"Asia/Kolkata\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuwait\",\"Asia/Magadan\",\"Asia/Muscat\",\"Asia/Novosibirsk\",\"Asia/Riyadh\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Tokyo\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yangon\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Cape_Verde\",\"Atlantic/South_Georgia\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Darwin\",\"Australia/Hobart\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Helsinki\",\"Europe/Istanbul\",\"Europe/Kaliningrad\",\"Europe/Kyiv\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Madrid\",\"Europe/Minsk\",\"Europe/Moscow\",\"Europe/Paris\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/Sarajevo\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"GMT+12\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Chatham\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Majuro\",\"Pacific/Midway\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Port_Moresby\",\"Pacific/Tongatapu\"]},{\"path\":[\"webhook_url\"],\"flag\":\"webhook-url\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner.\"},{\"path\":[\"zipcode\"],\"flag\":\"zipcode\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The zipcode of your organization's billing address.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"payment-methods\",\"action\":\"destroy\",\"operation_id\":\"destroyPaymentMethod\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/payment_methods/{lago_id}\",\"summary\":\"Delete a payment method\",\"description\":\"This endpoint deletes a specific payment method for a customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-methods/payment-method-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The payment method unique identifier, created by Lago.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"payment-methods\",\"action\":\"list-customers-payment-methods\",\"operation_id\":\"findAllCustomersPaymentMethods\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/payment_methods\",\"summary\":\"List all customer payment methods\",\"description\":\"This endpoint retrieves all payment methods of a Customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-methods/payment-method-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"payment-methods\",\"action\":\"payment-method-set-as-default\",\"operation_id\":\"paymentMethodSetAsDefault\",\"method\":\"PUT\",\"path\":\"/customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default\",\"summary\":\"Set the payment method as default\",\"description\":\"This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-methods/payment-method-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The payment method unique identifier, created by Lago.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"payment-receipts\",\"action\":\"get\",\"operation_id\":\"findPaymentReceipt\",\"method\":\"GET\",\"path\":\"/payment_receipts/{lago_id}\",\"summary\":\"Retrieve a payment receipt\",\"description\":\"This endpoint retrieves a specific payment receipt.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-receipts/payment-receipt-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the payment receipt.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"payment-receipts\",\"action\":\"list\",\"operation_id\":\"findAllPaymentReceipts\",\"method\":\"GET\",\"path\":\"/payment_receipts\",\"summary\":\"List all payment receipts\",\"description\":\"This endpoint is used to list all existing payment receipts.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-receipts/payment-receipt-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"invoice_id\",\"flag\":\"invoice-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter payment receipts by invoice id.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"payment-requests\",\"action\":\"create\",\"operation_id\":\"createPaymentRequest\",\"method\":\"POST\",\"path\":\"/payment_requests\",\"summary\":\"Create a payment request\",\"description\":\"This endpoint is used to create a payment request to collect payments of overdue invoices of a given customer\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-requests/payment-request-object\",\"body\":{\"wrapper\":\"payment_request\",\"fields\":[{\"path\":[\"email\"],\"flag\":\"email\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The email address used for sending dunning notifications. When omitted, the customer's own email address is used.\"},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"lago_invoice_ids\"],\"flag\":\"lago-invoice-ids\",\"type\":\"array\",\"required\":true,\"complex\":true,\"description\":\"A list of Lago IDs for the customer's overdue invoices to start the dunning process\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"payment-requests\",\"action\":\"get\",\"operation_id\":\"findPaymentRequest\",\"method\":\"GET\",\"path\":\"/payment_requests/{lago_id}\",\"summary\":\"Retrieve a payment request\",\"description\":\"This endpoint retrieves a specific payment request by its ID.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-requests/payment-request-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the payment request.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"payment-requests\",\"action\":\"list\",\"operation_id\":\"findAllPaymentRequests\",\"method\":\"GET\",\"path\":\"/payment_requests\",\"summary\":\"List all payment requests\",\"description\":\"This endpoint is used to list all existing payment requests.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payment-requests/payment-request-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter the results by currency, expressed as an ISO 4217 code.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"payment_status\",\"flag\":\"payment-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by payment status. Possible values are `pending`, `failed` or `succeeded`.\",\"enum\":[\"pending\",\"failed\",\"succeeded\"]},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter payment requests by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"payments\",\"action\":\"create\",\"operation_id\":\"createPayment\",\"method\":\"POST\",\"path\":\"/payments\",\"summary\":\"Create a payment\",\"description\":\"This endpoint is used to create a manual payment\",\"docs_url\":\"https://getlago.com/docs/api-reference/payments/payment-object\",\"body\":{\"wrapper\":\"payment\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":true,\"complex\":false,\"description\":\"The payment amount in cents\"},{\"path\":[\"invoice_id\"],\"flag\":\"invoice-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique identifier assigned to the invoice\"},{\"path\":[\"paid_at\"],\"flag\":\"paid-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The date the payment was made\"},{\"path\":[\"reference\"],\"flag\":\"reference\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Reference for the payment\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"payments\",\"action\":\"get\",\"operation_id\":\"findPayment\",\"method\":\"GET\",\"path\":\"/payments/{lago_id}\",\"summary\":\"Retrieve a payment\",\"description\":\"This endpoint retrieves a specific payment by its ID.\",\"docs_url\":\"https://getlago.com/docs/api-reference/payments/payment-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the payment.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"payments\",\"action\":\"list\",\"operation_id\":\"findAllPayments\",\"method\":\"GET\",\"path\":\"/payments\",\"summary\":\"List all payments\",\"description\":\"This endpoint is used to list all payments\",\"docs_url\":\"https://getlago.com/docs/api-reference/payments/payment-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Unique identifier assigned to the customer in your application.\"},{\"name\":\"invoice_id\",\"flag\":\"invoice-id\",\"in\":\"query\",\"type\":\"string\",\"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 identifier for the invoice's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"charges\",\"operation_id\":\"findAllPlanCharges\",\"method\":\"GET\",\"path\":\"/plans/{code}/charges\",\"summary\":\"List all charges for a plan\",\"description\":\"This endpoint retrieves all charges for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"create\",\"operation_id\":\"createPlan\",\"method\":\"POST\",\"path\":\"/plans\",\"summary\":\"Create a plan\",\"description\":\"This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"body\":{\"wrapper\":\"plan\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":true,\"complex\":false,\"description\":\"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"bill_charges_monthly\"],\"flag\":\"bill-charges-monthly\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is `yearly` or `semiannual`. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`.\"},{\"path\":[\"bill_fixed_charges_monthly\"],\"flag\":\"bill-fixed-charges-monthly\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field, when set to `true`, enables to invoice fixed charges on monthly basis, even if the cadence of the plan is `yearly` or `semiannual`. This allows customers to pay fixed charges on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`.\"},{\"path\":[\"charges\"],\"flag\":\"charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional usage-based charges for this plan.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"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 system-level identification purposes, like assigning a subscription, for instance.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The description on the plan.\"},{\"path\":[\"fixed_charges\"],\"flag\":\"fixed-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional fixed charges for this plan.\"},{\"path\":[\"interval\"],\"flag\":\"interval\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `semiannual`, `quarterly`, `monthly`, or `weekly`.\",\"enum\":[\"weekly\",\"monthly\",\"quarterly\",\"semiannual\",\"yearly\"]},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"minimum_commitment\",\"amount_cents\"],\"flag\":\"minimum-commitment-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the minimum commitment in cents.\"},{\"path\":[\"minimum_commitment\",\"invoice_display_name\"],\"flag\":\"minimum-commitment-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.\"},{\"path\":[\"minimum_commitment\",\"tax_codes\"],\"flag\":\"minimum-commitment-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The name of the plan.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":true,\"complex\":false,\"description\":\"This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"trial_period\"],\"flag\":\"trial-period\",\"type\":\"number\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The duration in days during which the base cost of the plan is offered for free.\"},{\"path\":[\"usage_thresholds\"],\"flag\":\"usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of usage thresholds to apply to the plan.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"create-plan-charge\",\"operation_id\":\"createPlanCharge\",\"method\":\"POST\",\"path\":\"/plans/{code}/charges\",\"summary\":\"Create a charge\",\"description\":\"This endpoint creates a new charge for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"body\":{\"wrapper\":\"charge\",\"fields\":[{\"path\":[\"accepts_target_wallet\"],\"flag\":\"accepts-target-wallet\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies whether the charge accepts a target wallet for prepaid credits deduction.\\nWhen set to `true`, events may include a `target_wallet_code` in their `properties` to direct credit deduction to a specific wallet.\\nIf no `target_wallet_code` is provided on the event, the standard wallet selection logic is applied.\\nIf the `target_wallet_code` does not match an existing wallet, no credits will be applied for that event.\\n\\nThis field requires a premium integration.\"},{\"path\":[\"applied_pricing_unit\",\"code\"],\"flag\":\"applied-pricing-unit-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the pricing unit.\"},{\"path\":[\"applied_pricing_unit\",\"conversion_rate\"],\"flag\":\"applied-pricing-unit-conversion-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The conversion rate from pricing units to the plan's currency.\\nThis rate determines how many currency units (in the plan's base currency) equal one pricing unit.\\nFor example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50.\"},{\"path\":[\"billable_metric_id\"],\"flag\":\"billable-metric-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique identifier of the billable metric created by Lago.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the creation of the charge should be cascaded to the children plans. When set to `true`, the charge will be created in children plans. Conversely, when set to `false`, the charge will only be created in the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charge_model\"],\"flag\":\"charge-model\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:\\n - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)\\n - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)\\n - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)\\n - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)\\n - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)\\n - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)\\n - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)\\n\",\"enum\":[\"dynamic\",\"graduated\",\"graduated_percentage\",\"package\",\"percentage\",\"standard\",\"volume\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying the charge within the plan.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of filters used to apply differentiated pricing based on additional event properties.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"invoiceable\"],\"flag\":\"invoiceable\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.\"},{\"path\":[\"min_amount_cents\"],\"flag\":\"min-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"presentation_group_keys\"],\"flag\":\"properties-presentation-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Groups usage into sub-items on invoices for display only, without affecting pricing or aggregation.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"prorated\"],\"flag\":\"prorated\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.\\n\\n- If set to `true`, the charge is prorated based on the remaining days in the current billing period.\\n- If set to `false`, the charge is billed in full.\\n- If not defined in the request, default value is `false`.\"},{\"path\":[\"regroup_paid_fees\"],\"flag\":\"regroup-paid-fees\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.\\nThis field determines whether and when the charge fee should be included in\\nthe invoice. If `null`, no invoice will be issued for this charge fee.\\nIf `invoice`, an invoice will be generated at the end of the period,\\nconsolidating all charge fees with a succeeded payment status.\",\"enum\":[\"\",\"invoice\"]},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"create-plan-charge-filter\",\"operation_id\":\"createPlanChargeFilter\",\"method\":\"POST\",\"path\":\"/plans/{code}/charges/{charge_code}/filters\",\"summary\":\"Create a charge filter\",\"description\":\"This endpoint creates a new filter for a specific charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the creation of the filter should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"values\"],\"flag\":\"values\",\"type\":\"object\",\"required\":true,\"complex\":true,\"description\":\"List of possible filter values. The key and values must match one of the billable metric filters.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"create-plan-fixed-charge\",\"operation_id\":\"createPlanFixedCharge\",\"method\":\"POST\",\"path\":\"/plans/{code}/fixed_charges\",\"summary\":\"Create a fixed charge\",\"description\":\"This endpoint creates a new fixed charge for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"}],\"body\":{\"wrapper\":\"fixed_charge\",\"fields\":[{\"path\":[\"add_on_code\"],\"flag\":\"add-on-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying an add-on. Either add_on_id or add_on_code is required.\"},{\"path\":[\"add_on_id\"],\"flag\":\"add-on-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique identifier of the add-on. Either add_on_id or add_on_code is required.\"},{\"path\":[\"apply_units_immediately\"],\"flag\":\"apply-units-immediately\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the fixed charge units are applied immediately for active subscriptions. When set to `false`, the units are applied at the next billing period.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the creation of the fixed charge should be cascaded to the children plans. When set to `true`, the fixed charge will be created in children plans. Conversely, when set to `false`, the fixed charge will only be created in the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charge_model\"],\"flag\":\"charge-model\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the pricing model used for the calculation of the fixed charge fee. It can be any of the following values:\\n - `standard`\\n - `graduated`\\n - `volume`\\n\",\"enum\":[\"standard\",\"graduated\",\"volume\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying the fixed charge within the plan.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the add-on will be used as the default display name.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for this fixed charge. When set to `true`, the charge is due and invoiced immediately at the beginning of the billing period. When set to `false`, the charge is due and invoiced at the end of the billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"prorated\"],\"flag\":\"prorated\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Specifies whether a fixed charge is prorated based on the remaining number of days in the billing period or billed fully.\\n\\n- If set to `true`, the charge is prorated based on the remaining days in the current billing period.\\n- If set to `false`, the charge is billed in full.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"units\"],\"flag\":\"units\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units for the fixed charge.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"delete\",\"operation_id\":\"destroyPlan\",\"method\":\"DELETE\",\"path\":\"/plans/{code}\",\"summary\":\"Delete a plan\",\"description\":\"This endpoint deletes a specific plan. Note that this plan could be associated with active subscriptions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes, like assigning a subscription, for instance.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"delete-all-plan-metadata\",\"operation_id\":\"deleteAllPlanMetadata\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/metadata\",\"summary\":\"Delete all plan metadata\",\"description\":\"This endpoint removes all metadata from a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The code of the plan.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"delete-plan-metadata-key\",\"operation_id\":\"deletePlanMetadataKey\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/metadata/{key}\",\"summary\":\"Delete a metadata key\",\"description\":\"This endpoint removes a single metadata key from a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The code of the plan.\"},{\"name\":\"key\",\"flag\":\"key\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The metadata key to delete.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"destroy-plan-charge\",\"operation_id\":\"destroyPlanCharge\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/charges/{charge_code}\",\"summary\":\"Delete a charge\",\"description\":\"This endpoint deletes a specific charge from a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"}],\"body\":{\"wrapper\":\"charge\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the deletion will be cascaded to the children plans.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"destroy-plan-charge-filter\",\"operation_id\":\"destroyPlanChargeFilter\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Delete a charge filter\",\"description\":\"This endpoint deletes a specific filter from a charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the deletion will be cascaded to the children plans.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"destroy-plan-fixed-charge\",\"operation_id\":\"destroyPlanFixedCharge\",\"method\":\"DELETE\",\"path\":\"/plans/{code}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Delete a fixed charge\",\"description\":\"This endpoint deletes a specific fixed charge from a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"}],\"body\":{\"wrapper\":\"fixed_charge\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the deletion will be cascaded to the children plans.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"filters\",\"operation_id\":\"findAllPlanChargeFilters\",\"method\":\"GET\",\"path\":\"/plans/{code}/charges/{charge_code}/filters\",\"summary\":\"List all filters for a charge\",\"description\":\"This endpoint retrieves all filters for a specific charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"fixed-charges\",\"operation_id\":\"findAllPlanFixedCharges\",\"method\":\"GET\",\"path\":\"/plans/{code}/fixed_charges\",\"summary\":\"List all fixed charges for a plan\",\"description\":\"This endpoint retrieves all fixed charges for a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"get\",\"operation_id\":\"findPlan\",\"method\":\"GET\",\"path\":\"/plans/{code}\",\"summary\":\"Retrieve a plan\",\"description\":\"This endpoint retrieves a specific plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes, like assigning a subscription, for instance.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"get-plan-charge\",\"operation_id\":\"findPlanCharge\",\"method\":\"GET\",\"path\":\"/plans/{code}/charges/{charge_code}\",\"summary\":\"Retrieve a charge\",\"description\":\"This endpoint retrieves a specific charge for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"get-plan-charge-filter\",\"operation_id\":\"findPlanChargeFilter\",\"method\":\"GET\",\"path\":\"/plans/{code}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Retrieve a charge filter\",\"description\":\"This endpoint retrieves a specific filter for a charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"get-plan-fixed-charge\",\"operation_id\":\"findPlanFixedCharge\",\"method\":\"GET\",\"path\":\"/plans/{code}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Retrieve a fixed charge\",\"description\":\"This endpoint retrieves a specific fixed charge for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"list\",\"operation_id\":\"findAllPlans\",\"method\":\"GET\",\"path\":\"/plans\",\"summary\":\"List all plans\",\"description\":\"This endpoint retrieves all existing plans.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"plans\",\"action\":\"merge-plan-metadata\",\"operation_id\":\"mergePlanMetadata\",\"method\":\"PATCH\",\"path\":\"/plans/{code}/metadata\",\"summary\":\"Merge plan metadata\",\"description\":\"This endpoint merges the provided metadata with existing metadata on the plan.\\nExisting keys not in the request are preserved. New keys are added, existing keys are updated.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The code of the plan.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"metadata\",\"operation_id\":\"replacePlanMetadata\",\"method\":\"POST\",\"path\":\"/plans/{code}/metadata\",\"summary\":\"Replace plan metadata\",\"description\":\"This endpoint replaces all existing metadata on a plan with the provided key-value pairs.\\nAny existing metadata keys not included in the request will be removed.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The code of the plan.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"update\",\"operation_id\":\"updatePlan\",\"method\":\"PUT\",\"path\":\"/plans/{code}\",\"summary\":\"Update a plan\",\"description\":\"This endpoint updates a specific plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes, like assigning a subscription, for instance.\"}],\"body\":{\"wrapper\":\"plan\",\"fields\":[{\"path\":[\"amount_cents\"],\"flag\":\"amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.\"},{\"path\":[\"amount_currency\"],\"flag\":\"amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"bill_charges_monthly\"],\"flag\":\"bill-charges-monthly\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field, when set to `true`, enables to invoice usage-based charges on monthly basis, even if the cadence of the plan is yearly or semiannual. This allows customers to pay charges overage on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`.\"},{\"path\":[\"bill_fixed_charges_monthly\"],\"flag\":\"bill-fixed-charges-monthly\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This field, when set to `true`, enables to invoice fixed charges on monthly basis, even if the cadence of the plan is `yearly` or `semiannual`. This allows customers to pay fixed charges on a monthly basis. This can be set to true only if the plan's interval is `yearly` or `semiannual`.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the plan should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charges\"],\"flag\":\"charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional usage-based charges for this plan.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"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 system-level identification purposes, like assigning a subscription, for instance.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The description on the plan.\"},{\"path\":[\"fixed_charges\"],\"flag\":\"fixed-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional fixed charges for this plan.\"},{\"path\":[\"interval\"],\"flag\":\"interval\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The interval used for recurring billing. It represents the frequency at which subscription billing occurs. The interval can be one of the following values: `yearly`, `semiannual`, `quarterly`, `monthly`, or `weekly`.\",\"enum\":[\"weekly\",\"monthly\",\"quarterly\",\"semiannual\",\"yearly\"]},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"minimum_commitment\",\"amount_cents\"],\"flag\":\"minimum-commitment-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the minimum commitment in cents.\"},{\"path\":[\"minimum_commitment\",\"invoice_display_name\"],\"flag\":\"minimum-commitment-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.\"},{\"path\":[\"minimum_commitment\",\"tax_codes\"],\"flag\":\"minimum-commitment-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the plan.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for the plan. When set to `true`, the base cost of the plan is due at the beginning of each billing period. Conversely, when set to `false`, the base cost of the plan is due at the end of each billing period.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"trial_period\"],\"flag\":\"trial-period\",\"type\":\"number\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The duration in days during which the base cost of the plan is offered for free.\"},{\"path\":[\"usage_thresholds\"],\"flag\":\"usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of usage thresholds to apply to the plan.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"update-plan-charge\",\"operation_id\":\"updatePlanCharge\",\"method\":\"PUT\",\"path\":\"/plans/{code}/charges/{charge_code}\",\"summary\":\"Update a charge\",\"description\":\"This endpoint updates a specific charge for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"}],\"body\":{\"wrapper\":\"charge\",\"fields\":[{\"path\":[\"accepts_target_wallet\"],\"flag\":\"accepts-target-wallet\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies whether the charge accepts a target wallet for prepaid credits deduction.\\nWhen set to `true`, events may include a `target_wallet_code` in their `properties` to direct credit deduction to a specific wallet.\\nIf no `target_wallet_code` is provided on the event, the standard wallet selection logic is applied.\\nIf the `target_wallet_code` does not match an existing wallet, no credits will be applied for that event.\\n\\nThis field requires a premium integration.\"},{\"path\":[\"applied_pricing_unit\",\"code\"],\"flag\":\"applied-pricing-unit-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the pricing unit.\"},{\"path\":[\"applied_pricing_unit\",\"conversion_rate\"],\"flag\":\"applied-pricing-unit-conversion-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The conversion rate from pricing units to the plan's currency.\\nThis rate determines how many currency units (in the plan's base currency) equal one pricing unit.\\nFor example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50.\"},{\"path\":[\"billable_metric_id\"],\"flag\":\"billable-metric-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique identifier of the billable metric created by Lago.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the charge should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charge_model\"],\"flag\":\"charge-model\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:\\n - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)\\n - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)\\n - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)\\n - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)\\n - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)\\n - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)\\n - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)\\n\",\"enum\":[\"dynamic\",\"graduated\",\"graduated_percentage\",\"package\",\"percentage\",\"standard\",\"volume\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying the charge within the plan.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of filters used to apply differentiated pricing based on additional event properties.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"invoiceable\"],\"flag\":\"invoiceable\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.\"},{\"path\":[\"min_amount_cents\"],\"flag\":\"min-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"presentation_group_keys\"],\"flag\":\"properties-presentation-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Groups usage into sub-items on invoices for display only, without affecting pricing or aggregation.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"prorated\"],\"flag\":\"prorated\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Specifies whether a charge is prorated based on the remaining number of days in the billing period or billed fully.\\n\\n- If set to `true`, the charge is prorated based on the remaining days in the current billing period.\\n- If set to `false`, the charge is billed in full.\\n- If not defined in the request, default value is `false`.\"},{\"path\":[\"regroup_paid_fees\"],\"flag\":\"regroup-paid-fees\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.\\nThis field determines whether and when the charge fee should be included in\\nthe invoice. If `null`, no invoice will be issued for this charge fee.\\nIf `invoice`, an invoice will be generated at the end of the period,\\nconsolidating all charge fees with a succeeded payment status.\",\"enum\":[\"\",\"invoice\"]},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"update-plan-charge-filter\",\"operation_id\":\"updatePlanChargeFilter\",\"method\":\"PUT\",\"path\":\"/plans/{code}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Update a charge filter\",\"description\":\"This endpoint updates a specific filter for a charge.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the filter should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"values\"],\"flag\":\"values\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"List of possible filter values. The key and values must match one of the billable metric filters.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"plans\",\"action\":\"update-plan-fixed-charge\",\"operation_id\":\"updatePlanFixedCharge\",\"method\":\"PUT\",\"path\":\"/plans/{code}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Update a fixed charge\",\"description\":\"This endpoint updates a specific fixed charge for a plan.\",\"docs_url\":\"https://getlago.com/docs/api-reference/plans/object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing plan.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"}],\"body\":{\"wrapper\":\"fixed_charge\",\"fields\":[{\"path\":[\"add_on_code\"],\"flag\":\"add-on-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying an add-on. Either add_on_id or add_on_code is required.\"},{\"path\":[\"add_on_id\"],\"flag\":\"add-on-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique identifier of the add-on. Either add_on_id or add_on_code is required.\"},{\"path\":[\"apply_units_immediately\"],\"flag\":\"apply-units-immediately\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the fixed charge units are applied immediately for active subscriptions. When set to `false`, the units are applied at the next billing period.\"},{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the fixed charge should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"charge_model\"],\"flag\":\"charge-model\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the pricing model used for the calculation of the fixed charge fee. It can be any of the following values:\\n - `standard`\\n - `graduated`\\n - `volume`\\n\",\"enum\":[\"standard\",\"graduated\",\"volume\"]},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code identifying the fixed charge within the plan.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the add-on will be used as the default display name.\"},{\"path\":[\"pay_in_advance\"],\"flag\":\"pay-in-advance\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines the billing timing for this fixed charge. When set to `true`, the charge is due and invoiced immediately at the beginning of the billing period. When set to `false`, the charge is due and invoiced at the end of the billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"prorated\"],\"flag\":\"prorated\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Specifies whether a fixed charge is prorated based on the remaining number of days in the billing period or billed fully.\\n\\n- If set to `true`, the charge is prorated based on the remaining days in the current billing period.\\n- If set to `false`, the charge is billed in full.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"units\"],\"flag\":\"units\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units for the fixed charge.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"quotes\",\"action\":\"approve-quote-version\",\"operation_id\":\"approveQuoteVersion\",\"method\":\"POST\",\"path\":\"/quote_versions/{lago_id}/approve\",\"summary\":\"Approve a quote version\",\"description\":\"This endpoint approves a quote version and generates the order form to send to the customer for signature.\\nOnly a `draft` version can be approved, and its `billing_items` must be complete: approval validates them against the catalog and against the customer, and returns a `422` when the deal cannot be executed as quoted.\\nThe `expires_at` of the generated order form is bounded by the deal's own term, so a signing window reaching beyond the day the deal stops being executable is rejected.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote version's record within the Lago system.\"}],\"body\":{\"fields\":[{\"path\":[\"expires_at\"],\"flag\":\"expires-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The date and time in UTC (ISO 8601) when the order form generated by the approval expires. It must be in the future, and must fall strictly before the day the quoted deal stops being executable, otherwise the approval is rejected with a `422`. That boundary is the earliest of the `endDate` of any quoted plan and the `expirationAt` of any quoted wallet credit or recurring top-up rule. A `one_off` quote carries none of them, so its signing window is never bounded. When `expires_at` is omitted, the order form never expires.\"}],\"required\":false},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"quotes\",\"action\":\"clone-quote-version\",\"operation_id\":\"cloneQuoteVersion\",\"method\":\"POST\",\"path\":\"/quote_versions/{lago_id}/clone\",\"summary\":\"Clone a quote version\",\"description\":\"This endpoint copies a quote version into a new `draft` version of the same quote, so that the deal can be renegotiated.\\nAny version of the quote can be cloned, but a quote can only carry one active version: the draft the quote currently holds, if any, is voided with the `superseded` reason. Cloning is therefore rejected with a `422` once a version of the quote has been approved.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote version's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"quotes\",\"action\":\"get\",\"operation_id\":\"findQuote\",\"method\":\"GET\",\"path\":\"/quotes/{lago_id}\",\"summary\":\"Retrieve a quote\",\"description\":\"This endpoint retrieves a specific quote, along with its owners and its current version.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"quotes\",\"action\":\"get-quote-version\",\"operation_id\":\"findQuoteVersion\",\"method\":\"GET\",\"path\":\"/quote_versions/{lago_id}\",\"summary\":\"Retrieve a quote version\",\"description\":\"This endpoint retrieves a specific quote version, along with its document `content` and its `billing_items`.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote version's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"quotes\",\"action\":\"list\",\"operation_id\":\"findAllQuotes\",\"method\":\"GET\",\"path\":\"/quotes\",\"summary\":\"List all quotes\",\"description\":\"This endpoint is used to list all existing quotes.\\nQuotes are ordered by creation date, from the most recent to the oldest.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by the status of their current version. Possible values are `draft`, `approved` and `voided`.\"},{\"name\":\"order_type[]\",\"flag\":\"order-type\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by order type. Possible values are `subscription_creation`, `subscription_amendment` and `one_off`.\"},{\"name\":\"number[]\",\"flag\":\"number\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by their number, as assigned by Lago.\"},{\"name\":\"owner_id[]\",\"flag\":\"owner-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by the Lago identifiers of the users owning them.\"},{\"name\":\"external_customer_id[]\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter quotes by the external unique identifiers of their customers (provided by your own application).\"},{\"name\":\"from_date\",\"flag\":\"from-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter quotes created from a specific date.\"},{\"name\":\"to_date\",\"flag\":\"to-date\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter quotes created up to a specific date.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"quotes\",\"action\":\"versions\",\"operation_id\":\"findAllQuoteVersions\",\"method\":\"GET\",\"path\":\"/quotes/{lago_id}/versions\",\"summary\":\"List all versions of a quote\",\"description\":\"This endpoint is used to list all the versions of a specific quote, from the most recent to the oldest.\\nThe `content` and `billing_items` of each version are omitted; retrieve a version to get them.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote's record within the Lago system.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"quotes\",\"action\":\"void-quote-version\",\"operation_id\":\"voidQuoteVersion\",\"method\":\"POST\",\"path\":\"/quote_versions/{lago_id}/void\",\"summary\":\"Void a quote version\",\"description\":\"This endpoint voids a quote version, which makes it definitive: a voided version can neither be edited nor approved again.\\nOnly a `draft` version can be voided through this endpoint, and the resulting `void_reason` is `manual`. An `approved` version is voided by Lago itself, through the order form generated from it.\\nA concurrent write on the same quote is reported as a `422` rather than retried, so a duplicated call can fail while the first one is still in flight.\\nThis is a premium feature.\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the quote version's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"alerts\",\"operation_id\":\"getSubscriptionAlerts\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/alerts\",\"summary\":\"List subscription alerts\",\"description\":\"This endpoint enables the retrieval of all alerts for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"charges\",\"operation_id\":\"findAllSubscriptionCharges\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/charges\",\"summary\":\"List all charges for a subscription\",\"description\":\"This endpoint retrieves all effective charges for a specific subscription.\\nIf the subscription has plan overrides with charge overrides, the overridden charges are returned.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"create\",\"operation_id\":\"createSubscription\",\"method\":\"POST\",\"path\":\"/subscriptions\",\"summary\":\"Assign a plan to a customer\",\"description\":\"This endpoint assigns a plan to a customer, creating or modifying a subscription. Ideal for initial subscriptions or plan changes (upgrades/downgrades).\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"body\":{\"fields\":[{\"path\":[\"authorization\",\"amount_cents\"],\"flag\":\"authorization-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the authorization in cents.\"},{\"path\":[\"authorization\",\"amount_currency\"],\"flag\":\"authorization-amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the authorization.\"},{\"path\":[\"subscription\",\"activation_rules\"],\"flag\":\"activation-rules\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Optional list of activation rules that gate the subscription activation. When a `payment` rule is provided and the plan is paid in advance (and the subscription is not in a trial), the subscription is created in the `incomplete` state and is only activated once the gating payment succeeds. If the payment fails or the rule's `timeout_hours` elapses, the subscription is canceled.\\n\"},{\"path\":[\"subscription\",\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity to be used for the subscription. If not provided, the default billing entity will be used.\"},{\"path\":[\"subscription\",\"billing_time\"],\"flag\":\"billing-time\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).\",\"enum\":[\"calendar\",\"anniversary\"]},{\"path\":[\"subscription\",\"consolidate_invoice\"],\"flag\":\"consolidate-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices.\\n\\n- `true` (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method).\\n- `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice.\\n\"},{\"path\":[\"subscription\",\"ending_at\"],\"flag\":\"ending-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).\"},{\"path\":[\"subscription\",\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"subscription\",\"external_id\"],\"flag\":\"external-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The unique external identifier for the subscription. This identifier serves as an idempotency key, ensuring that each subscription is unique.\"},{\"path\":[\"subscription\",\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"subscription\",\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"subscription\",\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.\"},{\"path\":[\"subscription\",\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"subscription\",\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"subscription\",\"plan_code\"],\"flag\":\"plan-code\",\"type\":\"string\",\"required\":true,\"complex\":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 plans.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"amount_cents\"],\"flag\":\"plan-overrides-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"amount_currency\"],\"flag\":\"plan-overrides-amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"subscription\",\"plan_overrides\",\"charges\"],\"flag\":\"plan-overrides-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional usage-based charges for this plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"description\"],\"flag\":\"plan-overrides-description\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The description on the plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"fixed_charges\"],\"flag\":\"plan-overrides-fixed-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"invoice_display_name\"],\"flag\":\"plan-overrides-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"metadata\"],\"flag\":\"plan-overrides-metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"amount_cents\"],\"flag\":\"plan-overrides-minimum-commitment-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the minimum commitment in cents.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"invoice_display_name\"],\"flag\":\"plan-overrides-minimum-commitment-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"tax_codes\"],\"flag\":\"plan-overrides-minimum-commitment-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"name\"],\"flag\":\"plan-overrides-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"tax_codes\"],\"flag\":\"plan-overrides-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"trial_period\"],\"flag\":\"plan-overrides-trial-period\",\"type\":\"number\",\"required\":false,\"complex\":false,\"description\":\"The duration in days during which the base cost of the plan is offered for free.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"usage_thresholds\"],\"flag\":\"plan-overrides-usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Managing usage thresholds through `plan_overrides` is deprecated and its behavior is inconsistent: an empty array does not reliably clear thresholds (it is ignored the first time a subscription is overridden), and it never affects thresholds inherited from a parent plan. Use the top-level `usage_thresholds` array on the subscription instead, or `progressive_billing_disabled` to switch progressive billing off.\\n\"},{\"path\":[\"subscription\",\"progressive_billing_disabled\"],\"flag\":\"progressive-billing-disabled\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Disables progressive billing for this subscription, regardless of any usage thresholds defined on the plan (including thresholds inherited from a parent plan when the subscription runs on a plan override).\\n\\nSet to `true` to switch progressive billing off for this subscription specifically, without changing the plan's thresholds.\\n\"},{\"path\":[\"subscription\",\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the subscription. It will be added to invoices generated for this subscription.\"},{\"path\":[\"subscription\",\"subscription_at\"],\"flag\":\"subscription-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The start date for the subscription, allowing for the creation of subscriptions that can begin in the past or future. Please note that it cannot be used to update the start date of a pending subscription or schedule an upgrade/downgrade. The start_date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"subscription\",\"usage_thresholds\"],\"flag\":\"usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Usage thresholds managed directly on the subscription. This is the recommended way to set progressive billing thresholds per subscription; when present, they take precedence over the thresholds defined on the plan.\\n\\nThis field cannot be combined with `plan_overrides.usage_thresholds` in the same request.\\n\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"create-subscription-alert\",\"operation_id\":\"createSubscriptionAlert\",\"method\":\"POST\",\"path\":\"/subscriptions/{external_id}/alerts\",\"summary\":\"Create subscription alert(s)\",\"description\":\"This endpoint allows you to create alerts for a subscription. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"create-subscription-charge-filter\",\"operation_id\":\"createSubscriptionChargeFilter\",\"method\":\"POST\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters\",\"summary\":\"Create a charge filter\",\"description\":\"This endpoint creates a new filter for a specific charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the creation of the filter should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"values\"],\"flag\":\"values\",\"type\":\"object\",\"required\":true,\"complex\":true,\"description\":\"List of possible filter values. The key and values must match one of the billable metric filters.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"delete-all-subscription-alerts\",\"operation_id\":\"deleteAllSubscriptionAlerts\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/alerts\",\"summary\":\"Delete all subscription alerts\",\"description\":\"This endpoint allows you to delete all alerts for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"delete-subscription-alert\",\"operation_id\":\"deleteSubscriptionAlert\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/alerts/{code}\",\"summary\":\"Delete a subscription alert\",\"description\":\"This endpoint allows you to delete an existing alert for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"destroy-subscription-charge-filter\",\"operation_id\":\"destroySubscriptionChargeFilter\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Delete a charge filter\",\"description\":\"This endpoint deletes a specific filter from a charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"filters\",\"operation_id\":\"findAllSubscriptionChargeFilters\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters\",\"summary\":\"List all filters for a charge\",\"description\":\"This endpoint retrieves all filters for a specific charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"fixed-charges\",\"operation_id\":\"findAllSubscriptionFixedCharges\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/fixed_charges\",\"summary\":\"List all fixed charges for a subscription\",\"description\":\"This endpoint retrieves all effective fixed charges for a specific subscription.\\nThe `units` of each fixed charge reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get\",\"operation_id\":\"findSubscription\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}\",\"summary\":\"Retrieve a subscription\",\"description\":\"This endpoint retrieves a specific subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"By default, this endpoint only return `active` subscriptions. If you want to retrieve a subscription with a different `status`, you can specify it here.\\n\\n_Note: As there may exists multiple `canceled` or `terminated` subscribtions for the same `external_id`, it is recommended to use the \\\"List all subscriptions\\\" endpoint to retrieve those subscriptions._\\n\",\"enum\":[\"active\",\"terminated\",\"pending\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get-subscription-alert\",\"operation_id\":\"getSubscriptionAlert\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/alerts/{code}\",\"summary\":\"Retrieve a subscription alert\",\"description\":\"This endpoint enables the retrieval of a specific alert for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get-subscription-charge\",\"operation_id\":\"findSubscriptionCharge\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}\",\"summary\":\"Retrieve a charge for a subscription\",\"description\":\"This endpoint retrieves a specific effective charge for a subscription.\\nIf the subscription has a plan override with a charge override, the overridden charge is returned.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get-subscription-charge-filter\",\"operation_id\":\"findSubscriptionChargeFilter\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Retrieve a charge filter\",\"description\":\"This endpoint retrieves a specific filter for a charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"get-subscription-fixed-charge\",\"operation_id\":\"findSubscriptionFixedCharge\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Retrieve a fixed charge for a subscription\",\"description\":\"This endpoint retrieves a specific effective fixed charge for a subscription.\\nThe `units` reflect any per-subscription unit override applied to the subscription; when no override exists, the plan-level units are returned.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"lifetime-usage\",\"operation_id\":\"getSubscriptionLifetimeUsage\",\"method\":\"GET\",\"path\":\"/subscriptions/{external_id}/lifetime_usage\",\"summary\":\"Retrieve subscription lifetime usage\",\"description\":\"This endpoint enables the retrieval of the lifetime usage of a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"list\",\"operation_id\":\"findAllSubscriptions\",\"method\":\"GET\",\"path\":\"/subscriptions\",\"summary\":\"List all subscriptions\",\"description\":\"This endpoint retrieves all active subscriptions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter the results by currency, expressed as an ISO 4217 code.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter subscriptions by their external unique identifier (provided by your own application).\"},{\"name\":\"plan_code\",\"flag\":\"plan-code\",\"in\":\"query\",\"type\":\"string\",\"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 plans.\"},{\"name\":\"overridden\",\"flag\":\"overridden\",\"in\":\"query\",\"type\":\"boolean\",\"required\":false,\"description\":\"When set, filters subscriptions by whether their plan is an override of a parent plan. `true` returns only subscriptions on overridden plans; `false` returns only those on standard (non-overridden) plans.\"},{\"name\":\"status[]\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"array\",\"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 you can define them in a status[] query param. Available filter values: `pending`, `canceled`, `terminated`, `active`.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter subscriptions by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"subscriptions\",\"action\":\"override-subscription-charge\",\"operation_id\":\"overrideSubscriptionCharge\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}\",\"summary\":\"Override a charge for a subscription\",\"description\":\"This endpoint creates or updates a charge override for a specific subscription.\\nIf the subscription does not have a plan override yet, one will be created automatically.\\nThe charge override allows customizing specific charge properties (invoice_display_name, min_amount_cents, properties, filters, taxes, applied_pricing_unit) without affecting the original plan charge.\\nThis is a premium feature.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"charge\",\"fields\":[{\"path\":[\"applied_pricing_unit\",\"code\"],\"flag\":\"applied-pricing-unit-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the pricing unit.\"},{\"path\":[\"applied_pricing_unit\",\"conversion_rate\"],\"flag\":\"applied-pricing-unit-conversion-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The conversion rate from pricing units to the plan's currency.\\nThis rate determines how many currency units (in the plan's base currency) equal one pricing unit.\\nFor example, if the plan uses USD and the conversion rate is 0.5, then 1 pricing unit = $0.50.\"},{\"path\":[\"filters\"],\"flag\":\"filters\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of filters used to apply differentiated pricing based on additional event properties.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.\"},{\"path\":[\"min_amount_cents\"],\"flag\":\"min-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"presentation_group_keys\"],\"flag\":\"properties-presentation-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Groups usage into sub-items on invoices for display only, without affecting pricing or aggregation.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"override-subscription-fixed-charge\",\"operation_id\":\"overrideSubscriptionFixedCharge\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/fixed_charges/{fixed_charge_code}\",\"summary\":\"Override a fixed charge for a subscription\",\"description\":\"This endpoint creates or updates a fixed charge override for a subscription, without affecting the original plan fixed charge.\\nWhen the body contains only `units` (and optionally `apply_units_immediately`), the change is recorded as a per-subscription unit override. When the body also sets `invoice_display_name`, `properties`, or `tax_codes`, it is applied as a full plan override for the subscription instead.\\nWith `apply_units_immediately: true` on a pay-in-advance fixed charge the change is billed mid-period; otherwise it takes effect at the next billing period.\\nThis is a premium feature.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"fixed_charge_code\",\"flag\":\"fixed-charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing fixed charge.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"fixed_charge\",\"fields\":[{\"path\":[\"apply_units_immediately\"],\"flag\":\"apply-units-immediately\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When set to `true`, the fixed charge units are applied immediately for active subscriptions. When set to `false`, the units are applied at the next billing period.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the add-on will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"tax_codes\"],\"flag\":\"tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"units\"],\"flag\":\"units\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units for the fixed charge.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"terminate\",\"operation_id\":\"destroySubscription\",\"method\":\"DELETE\",\"path\":\"/subscriptions/{external_id}\",\"summary\":\"Terminate a subscription\",\"description\":\"This endpoint allows you to terminate a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Selects which subscription to terminate for the given `external_id`, based on its status. If the field is not defined, Lago targets only `active` subscriptions.\\n\\n- `pending`: cancel a subscription scheduled for a future activation (include `status=pending`).\\n- `incomplete`: cancel a payment-gated subscription that is still awaiting its activation payment (include `status=incomplete`). The subscription is canceled with `cancellation_reason: manual`, its invoice is closed and nothing is billed, and any pending payment is canceled on a best-effort basis with the payment provider (some provider statuses cannot be canceled). Applied coupons, credit notes and wallet credits are recredited. Termination behaviours (`on_termination_credit_note`, `on_termination_invoice`) are ignored, as an incomplete subscription has never been billed.\\n\"},{\"name\":\"on_termination_credit_note\",\"flag\":\"on-termination-credit-note\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"When a pay-in-advance subscription is terminated before the end of its billing period, we generate a credit note for the unused subscription time by default.\\nThis field allows you to control the behavior of the credit note generation:\\n\\n- `credit`: A credit note is generated for the unused subscription time. The unused amount is credited back to the customer.\\n- `refund`: A credit note is generated for the unused subscription time. If the invoice is paid or partially paid, the unused paid amount is refunded; any unpaid unused amount is credited back to the customer.\\n- `skip`: No credit note is generated for the unused subscription time.\\n\\n_Note: This field is only applicable to pay-in-advance plans and is ignored for pay-in-arrears plans._\\n\",\"enum\":[\"credit\",\"refund\",\"skip\"]},{\"name\":\"on_termination_invoice\",\"flag\":\"on-termination-invoice\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"When a subscription is terminated before the end of its billing period, we generate an invoice for the unbilled usage.\\nThis field allows you to control the behavior of the invoice generation:\\n\\n- `generate`: An invoice is generated for the unbilled usage.\\n- `skip`: No invoice is generated for the unbilled usage.\\n\",\"enum\":[\"generate\",\"skip\"]}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"update\",\"operation_id\":\"updateSubscription\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}\",\"summary\":\"Update a subscription\",\"description\":\"This endpoint allows you to update a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"By default, this endpoint only return `active` subscriptions. If you want to update a subscription with a different `status`, you can specify it here.\\n\",\"enum\":[\"active\",\"pending\"]}],\"body\":{\"fields\":[{\"path\":[\"status\"],\"flag\":\"status\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"If the field is not defined and multiple `active` and `pending` subscriptions exists, Lago will update the `active` subscription. However, if you wish to update a `pending` subscription, please ensure that you include the `status` attribute with the `pending` value in your request body.\",\"enum\":[\"active\",\"pending\"]},{\"path\":[\"subscription\",\"activation_rules\"],\"flag\":\"activation-rules\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Optional list of activation rules that gate the subscription activation. Activation rules can only be set or modified while the subscription is `pending` (future-dated and not yet activated); the request is rejected for `incomplete`, `active`, or `terminated` subscriptions.\\n\"},{\"path\":[\"subscription\",\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the subscription. Updates take effect on future invoices only.\"},{\"path\":[\"subscription\",\"consolidate_invoice\"],\"flag\":\"consolidate-invoice\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices.\\n\\n- `true`: the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method).\\n- `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice.\\n\"},{\"path\":[\"subscription\",\"ending_at\"],\"flag\":\"ending-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC).\"},{\"path\":[\"subscription\",\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"subscription\",\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"subscription\",\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan.\"},{\"path\":[\"subscription\",\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"subscription\",\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"subscription\",\"plan_overrides\",\"amount_cents\"],\"flag\":\"plan-overrides-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"amount_currency\"],\"flag\":\"plan-overrides-amount-currency\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"subscription\",\"plan_overrides\",\"charges\"],\"flag\":\"plan-overrides-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Additional usage-based charges for this plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"description\"],\"flag\":\"plan-overrides-description\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The description on the plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"fixed_charges\"],\"flag\":\"plan-overrides-fixed-charges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Fixed charge overrides for the subscription. When `plan_overrides` contains only `fixed_charges` and every entry contains only `id`, `units`, and optionally `apply_units_immediately`, the units are recorded as a per-subscription override without creating a plan override, and subscription-scoped reads return these units. If any entry carries other fields, or `plan_overrides` contains any other key, the request is applied as a full plan override for the subscription instead.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"invoice_display_name\"],\"flag\":\"plan-overrides-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the plan will be used as the default display name.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"metadata\"],\"flag\":\"plan-overrides-metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"amount_cents\"],\"flag\":\"plan-overrides-minimum-commitment-amount-cents\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The amount of the minimum commitment in cents.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"invoice_display_name\"],\"flag\":\"plan-overrides-minimum-commitment-invoice-display-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"minimum_commitment\",\"tax_codes\"],\"flag\":\"plan-overrides-minimum-commitment-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"name\"],\"flag\":\"plan-overrides-name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The name of the plan.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"tax_codes\"],\"flag\":\"plan-overrides-tax-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique code used to identify the taxes.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"trial_period\"],\"flag\":\"plan-overrides-trial-period\",\"type\":\"number\",\"required\":false,\"complex\":false,\"description\":\"The duration in days during which the base cost of the plan is offered for free.\"},{\"path\":[\"subscription\",\"plan_overrides\",\"usage_thresholds\"],\"flag\":\"plan-overrides-usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Managing usage thresholds through `plan_overrides` is deprecated and its behavior is inconsistent: an empty array does not reliably clear thresholds (it is ignored the first time a subscription is overridden), and it never affects thresholds inherited from a parent plan. Use the top-level `usage_thresholds` array on the subscription instead, or `progressive_billing_disabled` to switch progressive billing off.\\n\"},{\"path\":[\"subscription\",\"progressive_billing_disabled\"],\"flag\":\"progressive-billing-disabled\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Disables progressive billing for this subscription, regardless of any usage thresholds defined on the plan (including thresholds inherited from a parent plan when the subscription runs on a plan override).\\n\\nSet to `true` to switch progressive billing off for this subscription specifically. This is the recommended way to stop progressive billing on a subscription that inherits thresholds from its plan, since clearing `usage_thresholds` only removes subscription-level thresholds and does not remove those defined on (or inherited from) the plan.\\n\"},{\"path\":[\"subscription\",\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the subscription. It will be added to invoices generated for this subscription.\"},{\"path\":[\"subscription\",\"subscription_at\"],\"flag\":\"subscription-at\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The start date and time of the subscription. This field can only be modified for pending subscriptions that have not yet started. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"subscription\",\"usage_thresholds\"],\"flag\":\"usage-thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Usage thresholds managed directly on the subscription. This is the recommended way to set progressive billing thresholds per subscription; when present, they take precedence over the thresholds defined on the plan.\\n\\nSending an empty array removes all subscription-level thresholds. This field cannot be combined with `plan_overrides.usage_thresholds` in the same request. To fully disable progressive billing on a subscription that inherits thresholds from its plan, use `progressive_billing_disabled` instead.\\n\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"update-subscription-alert\",\"operation_id\":\"updateSubscriptionAlert\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/alerts/{code}\",\"summary\":\"Update a subscription alert\",\"description\":\"This endpoint allows you to update an existing alert for a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"alert\",\"fields\":[{\"path\":[\"billable_metric_code\"],\"flag\":\"billable-metric-code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the billable metric associated with the alert. Only for alerts based on a billable metric.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the alert.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the alert.\"},{\"path\":[\"thresholds\"],\"flag\":\"thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Array of thresholds associated with the alert.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"update-subscription-charge-filter\",\"operation_id\":\"updateSubscriptionChargeFilter\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}\",\"summary\":\"Update a charge filter\",\"description\":\"This endpoint updates a specific filter for a charge on a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription.\"},{\"name\":\"charge_code\",\"flag\":\"charge-code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Code of the existing charge.\"},{\"name\":\"filter_id\",\"flag\":\"filter-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier of the charge filter.\"},{\"name\":\"subscription_status\",\"flag\":\"subscription-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`.\\n\",\"enum\":[\"pending\",\"active\",\"terminated\",\"canceled\"]}],\"body\":{\"wrapper\":\"filter\",\"fields\":[{\"path\":[\"cascade_updates\"],\"flag\":\"cascade-updates\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"This field determines whether the changes made to the filter should be cascaded to the children plans. When set to `true`, the changes will be cascaded into children. Conversely, when set to `false`, the changes will only be applied to the plan itself. If not defined in the request, default value is `false`.\"},{\"path\":[\"invoice_display_name\"],\"flag\":\"invoice-display-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the name that will be displayed on an invoice. If no value is set for this field, the values of the filter will be used as the default display name.\"},{\"path\":[\"properties\",\"amount\"],\"flag\":\"properties-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"- The unit price, excluding tax, for a `standard` charge model. It is expressed as a decimal value.\\n- The amount, excluding tax, for a complete set of units in a `package` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"fixed_amount\"],\"flag\":\"properties-fixed-amount\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The fixed fee that is applied to each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"free_units\"],\"flag\":\"properties-free-units\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units that are provided free of charge for each billing period in a `package` charge model. This field specifies the number of units that customers can use without incurring any additional cost during each billing cycle.\"},{\"path\":[\"properties\",\"free_units_per_events\"],\"flag\":\"properties-free-units-per-events\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The count of transactions that are not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the number of transactions that are exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"free_units_per_total_aggregation\"],\"flag\":\"properties-free-units-per-total-aggregation\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The transaction amount that is not impacted by the `percentage` rate and fixed fee in a percentage charge model. This field indicates the portion of the transaction amount that is exempt from the calculation of charges based on the specified percentage rate and fixed fee.\"},{\"path\":[\"properties\",\"graduated_percentage_ranges\"],\"flag\":\"properties-graduated-percentage-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated percentage ranges, sorted from bottom to top tiers, used for a `graduated_percentage` charge model.\"},{\"path\":[\"properties\",\"graduated_ranges\"],\"flag\":\"properties-graduated-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Graduated ranges, sorted from bottom to top tiers, used for a `graduated` charge model.\"},{\"path\":[\"properties\",\"grouped_by\"],\"flag\":\"properties-grouped-by\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"**Deprecated.** Replaced by `pricing_group_keys`.\\nThe list of event properties that are used to group the events on the invoice for a `standard` charge model.\"},{\"path\":[\"properties\",\"package_size\"],\"flag\":\"properties-package-size\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The quantity of units included in each pack or set for a `package` charge model. It indicates the number of units that are bundled together as a single package or set within the pricing structure.\"},{\"path\":[\"properties\",\"per_transaction_max_amount\"],\"flag\":\"properties-per-transaction-max-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the maximum allowable spending for a single transaction. Working as a transaction cap.\"},{\"path\":[\"properties\",\"per_transaction_min_amount\"],\"flag\":\"properties-per-transaction-min-amount\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Specifies the minimum allowable spending for a single transaction. Working as a transaction floor.\"},{\"path\":[\"properties\",\"pricing_group_keys\"],\"flag\":\"properties-pricing-group-keys\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"The list of event properties that are used to group the events on the invoice.\"},{\"path\":[\"properties\",\"rate\"],\"flag\":\"properties-rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate that is applied to the amount of each transaction for a `percentage` charge model. It is expressed as a decimal value.\"},{\"path\":[\"properties\",\"volume_ranges\"],\"flag\":\"properties-volume-ranges\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Volume ranges, sorted from bottom to top tiers, used for a `volume` charge model.\"},{\"path\":[\"values\"],\"flag\":\"values\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"List of possible filter values. The key and values must match one of the billable metric filters.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"subscriptions\",\"action\":\"update-subscription-lifetime-usage\",\"operation_id\":\"updateSubscriptionLifetimeUsage\",\"method\":\"PUT\",\"path\":\"/subscriptions/{external_id}/lifetime_usage\",\"summary\":\"Update a subscription lifetime usage\",\"description\":\"This endpoint allows you to update the lifetime usage of a subscription.\",\"docs_url\":\"https://getlago.com/docs/api-reference/subscriptions/subscription-object\",\"parameters\":[{\"name\":\"external_id\",\"flag\":\"external-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"External ID of the existing subscription\"}],\"body\":{\"wrapper\":\"lifetime_usage\",\"fields\":[{\"path\":[\"external_historical_usage_amount_cents\"],\"flag\":\"external-historical-usage-amount-cents\",\"type\":\"integer\",\"required\":true,\"complex\":false,\"description\":\"The historical usage amount in cents for the subscription (provided by your own application).\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"taxes\",\"action\":\"create\",\"operation_id\":\"createTax\",\"method\":\"POST\",\"path\":\"/taxes\",\"summary\":\"Create a tax\",\"description\":\"This endpoint creates a new tax representing a customizable tax rate applicable to either the organization or a specific customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"body\":{\"wrapper\":\"tax\",\"fields\":[{\"path\":[\"applied_to_organization\"],\"flag\":\"applied-to-organization\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"**Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique code used to identify the tax associated with the API request.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the tax\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Name of the tax.\"},{\"path\":[\"rate\"],\"flag\":\"rate\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The percentage rate of the tax\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"taxes\",\"action\":\"delete\",\"operation_id\":\"destroyTax\",\"method\":\"DELETE\",\"path\":\"/taxes/{code}\",\"summary\":\"Delete a tax\",\"description\":\"This endpoint is used to delete a tax.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"taxes\",\"action\":\"get\",\"operation_id\":\"findTax\",\"method\":\"GET\",\"path\":\"/taxes/{code}\",\"summary\":\"Retrieve a Tax\",\"description\":\"This endpoint retrieves an existing tax representing a customizable tax rate applicable to either the organization or a specific customer. The tax is identified by its unique code.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"taxes\",\"action\":\"list\",\"operation_id\":\"findAllTaxes\",\"method\":\"GET\",\"path\":\"/taxes\",\"summary\":\"List all taxes\",\"description\":\"This endpoint retrieves all existing taxes representing a customizable tax rate applicable to either the organization or a specific customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"taxes\",\"action\":\"update\",\"operation_id\":\"updateTax\",\"method\":\"PUT\",\"path\":\"/taxes/{code}\",\"summary\":\"Update a tax\",\"description\":\"This endpoint updates an existing tax representing a customizable tax rate applicable to either the organization or a specific customer.\",\"docs_url\":\"https://getlago.com/docs/api-reference/taxes/tax-object\",\"parameters\":[{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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 system-level identification purposes.\"}],\"body\":{\"wrapper\":\"tax\",\"fields\":[{\"path\":[\"applied_to_organization\"],\"flag\":\"applied-to-organization\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"**Deprecated.** This field will be removed in a future version. When set to true, it applies the tax to the organization's default billing entity. To apply or remove a tax from any billing entity (including the default one), please use the `PUT /billing_entities/:code` endpoint instead.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the tax associated with the API request.\"},{\"path\":[\"description\"],\"flag\":\"description\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Internal description of the tax\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Name of the tax.\"},{\"path\":[\"rate\"],\"flag\":\"rate\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The percentage rate of the tax\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"create\",\"operation_id\":\"createWallet\",\"method\":\"POST\",\"path\":\"/wallets\",\"summary\":\"Create a wallet\",\"description\":\"This endpoint is used to create a wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"body\":{\"wrapper\":\"wallet\",\"fields\":[{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"fee_types\"],\"flag\":\"applies-to-fee-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the wallet.\"},{\"path\":[\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The currency of the wallet.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"granted_credits\"],\"flag\":\"granted-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of free granted credits. Required only if there is no paid credits.\"},{\"path\":[\"ignore_paid_top_up_limits_on_creation\"],\"flag\":\"ignore-paid-top-up-limits-on-creation\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"If set to true, the wallet will ignore paid top-up limits on creation.\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet.\"},{\"path\":[\"paid_credits\"],\"flag\":\"paid-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of paid credits. Required only if there is no granted credits.\"},{\"path\":[\"paid_top_up_max_amount_cents\"],\"flag\":\"paid-top-up-max-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Maximum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"paid_top_up_min_amount_cents\"],\"flag\":\"paid-top-up-min-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Minimum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.\"},{\"path\":[\"rate_amount\"],\"flag\":\"rate-amount\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.\"},{\"path\":[\"recurring_transaction_rules\"],\"flag\":\"recurring-transaction-rules\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.\"},{\"path\":[\"transaction_metadata\"],\"flag\":\"transaction-metadata\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.\"},{\"path\":[\"transaction_name\"],\"flag\":\"transaction-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.\"},{\"path\":[\"transaction_priority\"],\"flag\":\"transaction-priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"create-customer-wallet\",\"operation_id\":\"createCustomerWallet\",\"method\":\"POST\",\"path\":\"/customers/{external_customer_id}/wallets\",\"summary\":\"Create a wallet\",\"description\":\"This endpoint is used to create a wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"}],\"body\":{\"wrapper\":\"wallet\",\"fields\":[{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"fee_types\"],\"flag\":\"applies-to-fee-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the wallet. If not provided, the customer's billing entity is used.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the wallet.\"},{\"path\":[\"currency\"],\"flag\":\"currency\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The currency of the wallet.\",\"enum\":[\"AED\",\"AFN\",\"ALL\",\"AMD\",\"ANG\",\"AOA\",\"ARS\",\"AUD\",\"AWG\",\"AZN\",\"BAM\",\"BBD\",\"BDT\",\"BGN\",\"BIF\",\"BMD\",\"BND\",\"BOB\",\"BRL\",\"BSD\",\"BWP\",\"BYN\",\"BZD\",\"CAD\",\"CDF\",\"CHF\",\"CLF\",\"CLP\",\"CNY\",\"COP\",\"CRC\",\"CVE\",\"CZK\",\"DJF\",\"DKK\",\"DOP\",\"DZD\",\"EGP\",\"ETB\",\"EUR\",\"FJD\",\"FKP\",\"GBP\",\"GEL\",\"GHS\",\"GIP\",\"GMD\",\"GNF\",\"GTQ\",\"GYD\",\"HKD\",\"HNL\",\"HRK\",\"HTG\",\"HUF\",\"IDR\",\"ILS\",\"INR\",\"ISK\",\"JMD\",\"JPY\",\"KES\",\"KGS\",\"KHR\",\"KMF\",\"KRW\",\"KYD\",\"KZT\",\"LAK\",\"LBP\",\"LKR\",\"LRD\",\"LSL\",\"MAD\",\"MDL\",\"MGA\",\"MKD\",\"MMK\",\"MNT\",\"MOP\",\"MRO\",\"MUR\",\"MVR\",\"MWK\",\"MXN\",\"MYR\",\"MZN\",\"NAD\",\"NGN\",\"NIO\",\"NOK\",\"NPR\",\"NZD\",\"PAB\",\"PEN\",\"PGK\",\"PHP\",\"PKR\",\"PLN\",\"PYG\",\"QAR\",\"RON\",\"RSD\",\"RUB\",\"RWF\",\"SAR\",\"SBD\",\"SCR\",\"SEK\",\"SGD\",\"SHP\",\"SLL\",\"SOS\",\"SRD\",\"STD\",\"SYP\",\"SZL\",\"THB\",\"TJS\",\"TND\",\"TOP\",\"TRY\",\"TTD\",\"TWD\",\"TZS\",\"UAH\",\"UGX\",\"USD\",\"UYU\",\"UZS\",\"VND\",\"VUV\",\"WST\",\"XAF\",\"XCD\",\"XOF\",\"XPF\",\"YER\",\"ZAR\",\"ZMW\"]},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"external_customer_id\"],\"flag\":\"external-customer-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"path\":[\"granted_credits\"],\"flag\":\"granted-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of free granted credits. Required only if there is no paid credits.\"},{\"path\":[\"ignore_paid_top_up_limits_on_creation\"],\"flag\":\"ignore-paid-top-up-limits-on-creation\",\"type\":\"boolean\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"If set to true, the wallet will ignore paid top-up limits on creation.\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet.\"},{\"path\":[\"paid_credits\"],\"flag\":\"paid-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of paid credits. Required only if there is no granted credits.\"},{\"path\":[\"paid_top_up_max_amount_cents\"],\"flag\":\"paid-top-up-max-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Maximum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"paid_top_up_min_amount_cents\"],\"flag\":\"paid-top-up-min-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Minimum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.\"},{\"path\":[\"rate_amount\"],\"flag\":\"rate-amount\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.\"},{\"path\":[\"recurring_transaction_rules\"],\"flag\":\"recurring-transaction-rules\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.\"},{\"path\":[\"transaction_metadata\"],\"flag\":\"transaction-metadata\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"This optional field allows you to store a list of key-value pairs that provide additional information or custom attributes. These key-value pairs will be included in the metadata of wallet transactions generated during the wallet creation process.\"},{\"path\":[\"transaction_name\"],\"flag\":\"transaction-name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.\"},{\"path\":[\"transaction_priority\"],\"flag\":\"transaction-priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"create-customer-wallet-alert\",\"operation_id\":\"createCustomerWalletAlert\",\"method\":\"POST\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts\",\"summary\":\"Create wallet alert(s)\",\"description\":\"This endpoint allows you to create new alerts for a wallet. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"body\":{\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"create-wallet-transaction\",\"operation_id\":\"createWalletTransaction\",\"method\":\"POST\",\"path\":\"/wallet_transactions\",\"summary\":\"Top up a wallet\",\"description\":\"This endpoint is used to top-up an active wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"body\":{\"wrapper\":\"wallet_transaction\",\"fields\":[{\"path\":[\"granted_credits\"],\"flag\":\"granted-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of free granted credits.\"},{\"path\":[\"ignore_paid_top_up_limits\"],\"flag\":\"ignore-paid-top-up-limits\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"When true, allows topping up the wallet with transactions that exceed the paid top-up limits. Defaults to false.\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"This optional field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet transaction. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`.\\n\\nNote that this name will apply to all transactions (`paid_credits`, `granted_credits` and `voided_credits`) created by this action.\\n\"},{\"path\":[\"paid_credits\"],\"flag\":\"paid-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of paid credits.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with this wallet transaction. It will be added to invoices generated for the resulting wallet top-up. If not set, falls back to the wallet's `purchase_order_number`.\"},{\"path\":[\"voided_credits\"],\"flag\":\"voided-credits\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The number of voided credits.\"},{\"path\":[\"voided_transaction_id\"],\"flag\":\"voided-transaction-id\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount.\"},{\"path\":[\"wallet_id\"],\"flag\":\"wallet-id\",\"type\":\"string\",\"required\":true,\"complex\":false,\"description\":\"Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-all-customer-wallet-alerts\",\"operation_id\":\"deleteAllCustomerWalletAlerts\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts\",\"summary\":\"Delete all wallet alerts\",\"description\":\"This endpoint allows you to delete all alerts for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-all-customer-wallet-metadata\",\"operation_id\":\"deleteAllCustomerWalletMetadata\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/metadata\",\"summary\":\"Delete all wallet metadata\",\"description\":\"This endpoint removes all metadata from a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-all-wallet-metadata\",\"operation_id\":\"deleteAllWalletMetadata\",\"method\":\"DELETE\",\"path\":\"/wallets/{lago_id}/metadata\",\"summary\":\"Delete all wallet metadata\",\"description\":\"This endpoint removes all metadata from a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet within the Lago application.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-customer-wallet-alert\",\"operation_id\":\"deleteCustomerWalletAlert\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}\",\"summary\":\"Delete a wallet alert\",\"description\":\"This endpoint allows you to delete an existing alert for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-customer-wallet-metadata-key\",\"operation_id\":\"deleteCustomerWalletMetadataKey\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/metadata/{key}\",\"summary\":\"Delete a metadata key\",\"description\":\"This endpoint removes a single metadata key from a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"key\",\"flag\":\"key\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The metadata key to delete.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"delete-wallet-metadata-key\",\"operation_id\":\"deleteWalletMetadataKey\",\"method\":\"DELETE\",\"path\":\"/wallets/{lago_id}/metadata/{key}\",\"summary\":\"Delete a metadata key\",\"description\":\"This endpoint removes a single metadata key from a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet within the Lago application.\"},{\"name\":\"key\",\"flag\":\"key\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The metadata key to delete.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"destroy-customer-wallet\",\"operation_id\":\"destroyCustomerWallet\",\"method\":\"DELETE\",\"path\":\"/customers/{external_customer_id}/wallets/{code}\",\"summary\":\"Terminate a wallet\",\"description\":\"This endpoint is used to terminate an existing wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"get\",\"operation_id\":\"findWallet\",\"method\":\"GET\",\"path\":\"/wallets/{lago_id}\",\"summary\":\"Retrieve a wallet\",\"description\":\"This endpoint is used to retrieve an existing wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the wallet's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"get-customer-wallet\",\"operation_id\":\"findCustomerWallet\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/wallets/{code}\",\"summary\":\"Retrieve a wallet\",\"description\":\"This endpoint is used to retrieve an existing wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"get-customer-wallet-alert\",\"operation_id\":\"getCustomerWalletAlert\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}\",\"summary\":\"Retrieve a wallet alert\",\"description\":\"This endpoint enables the retrieval of a specific alert for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"get-customer-wallet-alerts\",\"operation_id\":\"getCustomerWalletAlerts\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts\",\"summary\":\"List wallet alerts\",\"description\":\"This endpoint enables the retrieval of all alerts for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"get-wallet-transaction\",\"operation_id\":\"findWalletTransaction\",\"method\":\"GET\",\"path\":\"/wallet_transactions/{lago_id}\",\"summary\":\"Retrieve a wallet transaction\",\"description\":\"This endpoint is used to retrieve a specific wallet transactions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 unique identifier for the wallet's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"list\",\"operation_id\":\"findAllWallets\",\"method\":\"GET\",\"path\":\"/wallets\",\"summary\":\"List all wallets\",\"description\":\"This endpoint is used to list all wallets with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter the results by currency, expressed as an ISO 4217 code.\"},{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter wallets by customer external unique identifier (provided by your own application). When omitted, all wallets for the organization are returned.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter wallets by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"list-customer-wallets\",\"operation_id\":\"findAllCustomerWallets\",\"method\":\"GET\",\"path\":\"/customers/{external_customer_id}/wallets\",\"summary\":\"List all customer's wallets\",\"description\":\"This endpoint is used to list all wallets with prepaid credits of a customer\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"currency\",\"flag\":\"currency\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter the results by currency, expressed as an ISO 4217 code.\"},{\"name\":\"billing_entity_codes[]\",\"flag\":\"billing-entity-codes\",\"in\":\"query\",\"type\":\"array\",\"required\":false,\"description\":\"Filter wallets by billing entity codes.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"list-wallet-transaction-consumptions\",\"operation_id\":\"findAllWalletTransactionConsumptions\",\"method\":\"GET\",\"path\":\"/wallet_transactions/{lago_id}/consumptions\",\"summary\":\"List all consumptions for a wallet transaction\",\"description\":\"This endpoint is used to list all consumption records for an inbound wallet transaction. It shows how the credits from this inbound transaction were consumed by outbound transactions. Only available for traceable wallets.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet transaction within the Lago application. Must be an inbound wallet transaction.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"list-wallet-transaction-fundings\",\"operation_id\":\"findAllWalletTransactionFundings\",\"method\":\"GET\",\"path\":\"/wallet_transactions/{lago_id}/fundings\",\"summary\":\"List all fundings for a wallet transaction\",\"description\":\"This endpoint is used to list all funding records for an outbound wallet transaction. It shows which inbound transactions funded this outbound transaction. Only available for traceable wallets.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet transaction within the Lago application. Must be an outbound wallet transaction.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"merge-customer-wallet-metadata\",\"operation_id\":\"mergeCustomerWalletMetadata\",\"method\":\"PATCH\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/metadata\",\"summary\":\"Merge wallet metadata\",\"description\":\"This endpoint merges the provided metadata with existing metadata on the wallet.\\nExisting keys not in the request are preserved. New keys are added, existing keys are updated.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"merge-wallet-metadata\",\"operation_id\":\"mergeWalletMetadata\",\"method\":\"PATCH\",\"path\":\"/wallets/{lago_id}/metadata\",\"summary\":\"Merge wallet metadata\",\"description\":\"This endpoint merges the provided metadata with existing metadata on the wallet.\\nExisting keys not in the request are preserved. New keys are added, existing keys are updated.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet within the Lago application.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"metadata\",\"operation_id\":\"replaceWalletMetadata\",\"method\":\"POST\",\"path\":\"/wallets/{lago_id}/metadata\",\"summary\":\"Replace wallet metadata\",\"description\":\"This endpoint replaces all existing metadata on a wallet with the provided key-value pairs.\\nAny existing metadata keys not included in the request will be removed.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique identifier assigned to the wallet within the Lago application.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"replace-customer-wallet-metadata\",\"operation_id\":\"replaceCustomerWalletMetadata\",\"method\":\"POST\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/metadata\",\"summary\":\"Replace wallet metadata\",\"description\":\"This endpoint replaces all existing metadata on a wallet with the provided key-value pairs.\\nAny existing metadata keys not included in the request will be removed.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"body\":{\"wrapper\":\"metadata\",\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"terminate\",\"operation_id\":\"destroyWallet\",\"method\":\"DELETE\",\"path\":\"/wallets/{lago_id}\",\"summary\":\"Terminate a wallet\",\"description\":\"This endpoint is used to terminate an existing wallet with prepaid credits.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the wallet's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"update\",\"operation_id\":\"updateWallet\",\"method\":\"PUT\",\"path\":\"/wallets/{lago_id}\",\"summary\":\"Update a wallet\",\"description\":\"This endpoint is used to update an existing wallet with prepaid credits. A terminated wallet cannot be updated and returns a `422` error.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the wallet's record within the Lago system.\"}],\"body\":{\"wrapper\":\"wallet\",\"fields\":[{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"fee_types\"],\"flag\":\"applies-to-fee-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the wallet.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the wallet.\"},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet.\"},{\"path\":[\"paid_top_up_max_amount_cents\"],\"flag\":\"paid-top-up-max-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Maximum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"paid_top_up_min_amount_cents\"],\"flag\":\"paid-top-up-min-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Minimum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.\"},{\"path\":[\"recurring_transaction_rules\"],\"flag\":\"recurring-transaction-rules\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"update-customer-wallet\",\"operation_id\":\"updateCustomerWallet\",\"method\":\"PUT\",\"path\":\"/customers/{external_customer_id}/wallets/{code}\",\"summary\":\"Update a wallet\",\"description\":\"This endpoint is used to update an existing wallet with prepaid credits. A terminated wallet cannot be updated and returns a `422` error.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"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.\"}],\"body\":{\"wrapper\":\"wallet\",\"fields\":[{\"path\":[\"applies_to\",\"billable_metric_codes\"],\"flag\":\"applies-to-billable-metric-codes\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of billable metric codes to which the wallet is applicable. By specifying the billable metric codes in this field, you can restrict the wallet's usage to specific metrics only.\"},{\"path\":[\"applies_to\",\"fee_types\"],\"flag\":\"applies-to-fee-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"An array of fee types to which the wallet is applicable. By specifying the fee types in this field, you can restrict the wallet's usage to specific fee types only.\"},{\"path\":[\"billing_entity_code\"],\"flag\":\"billing-entity-code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The code of the billing entity associated with the wallet.\"},{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The code of the wallet.\"},{\"path\":[\"expiration_at\"],\"flag\":\"expiration-at\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).\"},{\"path\":[\"invoice_custom_section\",\"invoice_custom_section_codes\"],\"flag\":\"invoice-custom-section-invoice-custom-section-codes\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of unique codes identifying the invoice custom sections to apply. These override the default invoice custom sections configured at the customer or billing entity level.\"},{\"path\":[\"invoice_custom_section\",\"skip_invoice_custom_sections\"],\"flag\":\"invoice-custom-section-skip-invoice-custom-sections\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"Set to `true` to exclude all invoice custom sections from PDF generation for invoices related to this resource. When `true`, `invoice_custom_section_codes` is ignored.\"},{\"path\":[\"invoice_requires_successful_payment\"],\"flag\":\"invoice-requires-successful-payment\",\"type\":\"boolean\",\"required\":false,\"complex\":false,\"description\":\"A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.\"},{\"path\":[\"metadata\"],\"flag\":\"metadata\",\"type\":\"object\",\"required\":false,\"complex\":true,\"description\":\"Metadata to set as key-value pairs. Keys are strings (max 100 characters), values can be strings (max 255 characters) or null.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the wallet.\"},{\"path\":[\"paid_top_up_max_amount_cents\"],\"flag\":\"paid-top-up-max-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Maximum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"paid_top_up_min_amount_cents\"],\"flag\":\"paid-top-up-min-amount-cents\",\"type\":\"integer\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"Minimum amount of cents that can be top-up with a single paid transaction.\"},{\"path\":[\"payment_method\",\"payment_method_id\"],\"flag\":\"payment-method-payment-method-id\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The unique identifier of the payment method (required when using a specific provider payment method).\"},{\"path\":[\"payment_method\",\"payment_method_type\"],\"flag\":\"payment-method-payment-method-type\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The type of payment method to use.\",\"enum\":[\"provider\",\"manual\"]},{\"path\":[\"priority\"],\"flag\":\"priority\",\"type\":\"integer\",\"required\":false,\"complex\":false,\"description\":\"Wallet priority for ordering when a customer has multiple wallets. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.\"},{\"path\":[\"purchase_order_number\"],\"flag\":\"purchase-order-number\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The purchase order number associated with the wallet. It will be added to invoices generated for wallet top-ups, unless a more specific purchase order number is set on the wallet transaction or recurring transaction rule that triggered the top-up.\"},{\"path\":[\"recurring_transaction_rules\"],\"flag\":\"recurring-transaction-rules\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"update-customer-wallet-alert\",\"operation_id\":\"updateCustomerWalletAlert\",\"method\":\"PUT\",\"path\":\"/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}\",\"summary\":\"Update a wallet alert\",\"description\":\"This endpoint allows you to update an existing alert for a wallet.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"external_customer_id\",\"flag\":\"external-customer-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"The customer external unique identifier (provided by your own application)\"},{\"name\":\"wallet_code\",\"flag\":\"wallet-code\",\"in\":\"path\",\"type\":\"string\",\"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.\"},{\"name\":\"code\",\"flag\":\"code\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"Unique code of the alert\"}],\"body\":{\"wrapper\":\"alert\",\"fields\":[{\"path\":[\"code\"],\"flag\":\"code\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"Unique code used to identify the alert.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the alert.\"},{\"path\":[\"thresholds\"],\"flag\":\"thresholds\",\"type\":\"array\",\"required\":false,\"complex\":true,\"description\":\"Array of thresholds associated with the alert.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"wallets\",\"action\":\"wallet-transaction-payment-url\",\"operation_id\":\"walletTransactionPaymentUrl\",\"method\":\"POST\",\"path\":\"/wallet_transactions/{lago_id}/payment_url\",\"summary\":\"Generate a payment URL\",\"description\":\"This endpoint generates a checkout link for a specific wallet transaction.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"required\":true,\"description\":\"ID of the wallet transaction.\"}],\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"wallets\",\"action\":\"wallet-transactions\",\"operation_id\":\"findAllWalletTransactions\",\"method\":\"GET\",\"path\":\"/wallets/{lago_id}/wallet_transactions\",\"summary\":\"List all wallet transactions\",\"description\":\"This endpoint is used to list all wallet transactions.\",\"docs_url\":\"https://getlago.com/docs/api-reference/wallets/wallet-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 identifier for the wallet's record within the Lago system.\"},{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"},{\"name\":\"status\",\"flag\":\"status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The status of the wallet transaction. Possible values are `pending` or `settled`.\"},{\"name\":\"transaction_status\",\"flag\":\"transaction-status\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The transaction status of the wallet transaction. Possible values are `purchased` (with pending or settled status), `granted` (without invoice_id), `voided` or `invoiced`.\"},{\"name\":\"transaction_type\",\"flag\":\"transaction-type\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance).\"},{\"name\":\"metadata[key]\",\"flag\":\"metadata[key]\",\"in\":\"query\",\"type\":\"string\",\"required\":false,\"description\":\"Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. For example, `metadata[color]=blue`.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"webhook-endpoints\",\"action\":\"create\",\"operation_id\":\"createWebhookEndpoint\",\"method\":\"POST\",\"path\":\"/webhook_endpoints\",\"summary\":\"Create a webhook_endpoint\",\"description\":\"This endpoint is used to create a webhook endpoint.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"body\":{\"wrapper\":\"webhook_endpoint\",\"fields\":[{\"path\":[\"event_types\"],\"flag\":\"event-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"A list of event types that will trigger the webhook. Passing null means that all event types will be sent.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the webhook.\"},{\"path\":[\"signature_algo\"],\"flag\":\"signature-algo\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The signature used for the webhook. If no value is passed,\",\"enum\":[\"jwt\",\"hmac\",\"\"]},{\"path\":[\"webhook_url\"],\"flag\":\"webhook-url\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The URL of the webhook endpoint.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"webhook-endpoints\",\"action\":\"delete\",\"operation_id\":\"destroyWebhookEndpoint\",\"method\":\"DELETE\",\"path\":\"/webhook_endpoints/{lago_id}\",\"summary\":\"Delete a webhook endpoint\",\"description\":\"This endpoint is used to delete an existing webhook endpoint.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 unique identifier for the webhook endpoint's record within the Lago system.\"}],\"idempotent\":false,\"dangerous\":true,\"paginated\":false,\"mutation\":true},{\"resource\":\"webhook-endpoints\",\"action\":\"get\",\"operation_id\":\"findWebhookEndpoint\",\"method\":\"GET\",\"path\":\"/webhook_endpoints/{lago_id}\",\"summary\":\"Retrieve a webhook endpoint\",\"description\":\"This endpoint is used to retrieve an existing webhook endpoint.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 unique identifier for the webhook endpoint's record within the Lago system.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"webhook-endpoints\",\"action\":\"list\",\"operation_id\":\"findAllWebhookEndpoints\",\"method\":\"GET\",\"path\":\"/webhook_endpoints\",\"summary\":\"List all webhook endpoints\",\"description\":\"This endpoint is used to list all webhook endpoints.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"parameters\":[{\"name\":\"page\",\"flag\":\"page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Page number.\"},{\"name\":\"per_page\",\"flag\":\"per-page\",\"in\":\"query\",\"type\":\"integer\",\"required\":false,\"description\":\"Number of records per page.\"}],\"idempotent\":true,\"dangerous\":false,\"paginated\":true,\"mutation\":false},{\"resource\":\"webhook-endpoints\",\"action\":\"update\",\"operation_id\":\"updateWebhookEndpoint\",\"method\":\"PUT\",\"path\":\"/webhook_endpoints/{lago_id}\",\"summary\":\"Update a webhook endpoint\",\"description\":\"This endpoint is used to update an existing webhook endpoint.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object\",\"parameters\":[{\"name\":\"lago_id\",\"flag\":\"lago-id\",\"in\":\"path\",\"type\":\"string\",\"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 unique identifier for the webhook endpoint's record within the Lago system.\"}],\"body\":{\"wrapper\":\"webhook_endpoint\",\"fields\":[{\"path\":[\"event_types\"],\"flag\":\"event-types\",\"type\":\"array\",\"required\":false,\"nullable\":true,\"complex\":true,\"description\":\"A list of event types that will trigger the webhook. Passing null means that all event types will be sent.\"},{\"path\":[\"name\"],\"flag\":\"name\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The name of the webhook.\"},{\"path\":[\"signature_algo\"],\"flag\":\"signature-algo\",\"type\":\"string\",\"required\":false,\"nullable\":true,\"complex\":false,\"description\":\"The signature used for the webhook. If no value is passed,\",\"enum\":[\"jwt\",\"hmac\",\"\"]},{\"path\":[\"webhook_url\"],\"flag\":\"webhook-url\",\"type\":\"string\",\"required\":false,\"complex\":false,\"description\":\"The URL of the webhook endpoint.\"}],\"required\":true},\"idempotent\":false,\"dangerous\":false,\"paginated\":false,\"mutation\":true},{\"resource\":\"webhooks\",\"action\":\"json-public-key\",\"operation_id\":\"fetchJsonPublicKey\",\"method\":\"GET\",\"path\":\"/webhooks/json_public_key\",\"summary\":\"Retrieve webhook public key (JSON)\",\"description\":\"This endpoint is used to retrieve the public key used to verify the webhooks signature, wrapped in a JSON object. Prefer this endpoint over the deprecated GET /webhooks/public_key.\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhooks/format---signature#1-retrieve-the-public-key\",\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false},{\"resource\":\"webhooks\",\"action\":\"public-key\",\"operation_id\":\"fetchPublicKey\",\"method\":\"GET\",\"path\":\"/webhooks/public_key\",\"summary\":\"Retrieve webhook public key\",\"description\":\"This endpoint is used to retrieve the public key used to verify the webhooks signature\",\"docs_url\":\"https://getlago.com/docs/api-reference/webhooks/format---signature#1-retrieve-the-public-key\",\"idempotent\":true,\"dangerous\":false,\"paginated\":false,\"mutation\":false}]" diff --git a/man/lago-add-ons-create.1 b/man/lago-add-ons-create.1 index 19518f9..e9b8384 100644 --- a/man/lago-add-ons-create.1 +++ b/man/lago-add-ons-create.1 @@ -19,7 +19,7 @@ This endpoint is used to create an add-on that can be then attached to a one-off .PP \fB--amount-currency\fP="" - The currency of the add-on.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the add-on.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--code\fP="" diff --git a/man/lago-add-ons-update.1 b/man/lago-add-ons-update.1 index 348678c..86b2a02 100644 --- a/man/lago-add-ons-update.1 +++ b/man/lago-add-ons-update.1 @@ -19,7 +19,7 @@ This endpoint is used to update an existing add-on. .PP \fB--amount-currency\fP="" - The currency of the add-on.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the add-on.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--code\fP="" diff --git a/man/lago-analytics-gross-revenue.1 b/man/lago-analytics-gross-revenue.1 index 0ccbf83..e8509c7 100644 --- a/man/lago-analytics-gross-revenue.1 +++ b/man/lago-analytics-gross-revenue.1 @@ -15,7 +15,7 @@ Gross revenue is the sum of monthly \fBfinalized\fR invoice payments and fees pa .SH OPTIONS \fB--currency\fP="" - Currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + Currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--external-customer-id\fP="" diff --git a/man/lago-analytics-invoice-collection.1 b/man/lago-analytics-invoice-collection.1 index b942af2..2a14bdf 100644 --- a/man/lago-analytics-invoice-collection.1 +++ b/man/lago-analytics-invoice-collection.1 @@ -15,7 +15,7 @@ Represents a monthly aggregation, detailing both the total count and the cumulat .SH OPTIONS \fB--currency\fP="" - The currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB-h\fP, \fB--help\fP[=false] diff --git a/man/lago-analytics-invoiced-usage.1 b/man/lago-analytics-invoiced-usage.1 index f7bb85a..169762b 100644 --- a/man/lago-analytics-invoiced-usage.1 +++ b/man/lago-analytics-invoiced-usage.1 @@ -15,7 +15,7 @@ Reports a monthly analysis focused on the revenue generated from all usage-based .SH OPTIONS \fB--currency\fP="" - The currency of invoiced usage analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of invoiced usage analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB-h\fP, \fB--help\fP[=false] diff --git a/man/lago-analytics-mrr.1 b/man/lago-analytics-mrr.1 index 3a4e2af..f76895b 100644 --- a/man/lago-analytics-mrr.1 +++ b/man/lago-analytics-mrr.1 @@ -25,7 +25,7 @@ Revenue from 'yearly' subscription invoices is distributed evenly over twelve mo .IP \(bu 2 Revenue from 'semiannual' subscription invoices is distributed evenly over six months. This allocation is applicable for fees paid in advance (spread over the next remaining months depending on calendar or anniversary billing) and for fees paid in arrears (spread over the previous months depending on calendar or anniversary billing). .IP \(bu 2 -Revenue from 'weekly' subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW +Revenue from 'weekly' subscription invoices, the total revenue from all invoices issued within a month is summed up. This total is then divided by the number of invoices issued during that month, and the result is multiplied by 4.33, representing the average number of weeks in a month.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB-h\fP, \fB--help\fP[=false] diff --git a/man/lago-analytics-overdue-balance.1 b/man/lago-analytics-overdue-balance.1 index 64ff075..ce1c135 100644 --- a/man/lago-analytics-overdue-balance.1 +++ b/man/lago-analytics-overdue-balance.1 @@ -15,7 +15,7 @@ Overdue balance is the total amount associated with overdue invoices (invoices w .SH OPTIONS \fB--currency\fP="" - Currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + Currency of revenue analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--external-customer-id\fP="" diff --git a/man/lago-analytics-usage.1 b/man/lago-analytics-usage.1 index 89374bd..e25c9b2 100644 --- a/man/lago-analytics-usage.1 +++ b/man/lago-analytics-usage.1 @@ -19,7 +19,7 @@ Returns usages. .PP \fB--currency\fP="" - The currency of usage analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of usage analytics. Format must be ISO 4217.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--customer-country\fP="" diff --git a/man/lago-billing-entities-create.1 b/man/lago-billing-entities-create.1 index 246ee5c..7faee72 100644 --- a/man/lago-billing-entities-create.1 +++ b/man/lago-billing-entities-create.1 @@ -55,7 +55,7 @@ This endpoint is used to create a new billing entity .PP \fB--default-currency\fP="" - The default currency of the billing entity; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The default currency of the billing entity; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--document-number-prefix\fP="" diff --git a/man/lago-billing-entities-update.1 b/man/lago-billing-entities-update.1 index 98845d1..8c2f597 100644 --- a/man/lago-billing-entities-update.1 +++ b/man/lago-billing-entities-update.1 @@ -51,7 +51,7 @@ This endpoint is used to update an existing billing entity .PP \fB--default-currency\fP="" - The default currency of the billing entity; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The default currency of the billing entity; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--document-number-prefix\fP="" diff --git a/man/lago-coupons-apply.1 b/man/lago-coupons-apply.1 index 9f4b30b..19ed037 100644 --- a/man/lago-coupons-apply.1 +++ b/man/lago-coupons-apply.1 @@ -19,7 +19,7 @@ This endpoint is used to apply a specific coupon to a customer, before or during .PP \fB--amount-currency\fP="" - The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--coupon-code\fP="" diff --git a/man/lago-coupons-create.1 b/man/lago-coupons-create.1 index 03a8d48..dd4404a 100644 --- a/man/lago-coupons-create.1 +++ b/man/lago-coupons-create.1 @@ -19,7 +19,7 @@ This endpoint is used to create a coupon that can be then attached to a customer .PP \fB--amount-currency\fP="" - The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--applies-to-billable-metric-codes\fP="" diff --git a/man/lago-coupons-update.1 b/man/lago-coupons-update.1 index 98a4570..e6f2bfb 100644 --- a/man/lago-coupons-update.1 +++ b/man/lago-coupons-update.1 @@ -19,7 +19,7 @@ This endpoint is used to update a coupon that can be then attached to a customer .PP \fB--amount-currency\fP="" - The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the coupon. This field is required only for coupon with 'fixed_amount' type.; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--applies-to-billable-metric-codes\fP="" diff --git a/man/lago-customers-create.1 b/man/lago-customers-create.1 index 3ee5b8a..6291a1f 100644 --- a/man/lago-customers-create.1 +++ b/man/lago-customers-create.1 @@ -85,7 +85,7 @@ Accepted values: 'stripe', 'adyen', 'cashfree', 'flutterwave', 'gocardless', 'mo .PP \fB--currency\fP="" - Currency of the customer. Format must be ISO 4217; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + Currency of the customer. Format must be ISO 4217; one of: , AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--customer-type\fP="" diff --git a/man/lago-customers-payment-requests.1 b/man/lago-customers-payment-requests.1 index 870ce44..5a434d1 100644 --- a/man/lago-customers-payment-requests.1 +++ b/man/lago-customers-payment-requests.1 @@ -21,6 +21,10 @@ This endpoint is used to list all existing payment requests of a customer. \fB--billing-entity-codes\fP="" Filter payment requests by billing entity codes. +.PP +\fB--currency\fP="" + Filter the results by currency, expressed as an ISO 4217 code. + .PP \fB-h\fP, \fB--help\fP[=false] help for payment-requests diff --git a/man/lago-customers-subscriptions.1 b/man/lago-customers-subscriptions.1 index 1a171bd..bafba64 100644 --- a/man/lago-customers-subscriptions.1 +++ b/man/lago-customers-subscriptions.1 @@ -21,6 +21,10 @@ This endpoint retrieves all active subscriptions for a customer. \fB--billing-entity-codes\fP="" Filter subscriptions by billing entity codes. +.PP +\fB--external-id\fP="" + The subscription external unique identifier (provided by your own application). + .PP \fB-h\fP, \fB--help\fP[=false] help for subscriptions diff --git a/man/lago-fees-list.1 b/man/lago-fees-list.1 index 358999c..0ae522d 100644 --- a/man/lago-fees-list.1 +++ b/man/lago-fees-list.1 @@ -31,7 +31,7 @@ This endpoint is used for retrieving all fees that have been issued. .PP \fB--currency\fP="" - Filter results by the fee's currency.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + Filter results by the fee's currency.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--event-transaction-id\fP="" diff --git a/man/lago-invoices-create.1 b/man/lago-invoices-create.1 index b1e62d9..2ffc82e 100644 --- a/man/lago-invoices-create.1 +++ b/man/lago-invoices-create.1 @@ -19,7 +19,7 @@ This endpoint is used for issuing a one-off invoice. .PP \fB--currency\fP="" - The currency of the invoice.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the invoice.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--external-customer-id\fP="" diff --git a/man/lago-invoices-preview.1 b/man/lago-invoices-preview.1 index f75cabd..9622c2a 100644 --- a/man/lago-invoices-preview.1 +++ b/man/lago-invoices-preview.1 @@ -43,7 +43,7 @@ This endpoint is used for generating invoice preview. .PP \fB--currency\fP="" - The currency of the invoice.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the invoice.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--external-id\fP="" diff --git a/man/lago-organizations-update.1 b/man/lago-organizations-update.1 index f1ea305..1812f16 100644 --- a/man/lago-organizations-update.1 +++ b/man/lago-organizations-update.1 @@ -43,7 +43,7 @@ This endpoint is used to update your own organization's settings. .PP \fB--default-currency\fP="" - The default currency of an organization.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The default currency of an organization.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--document-number-prefix\fP="" diff --git a/man/lago-payment-methods-payment-method-set-as-default.1 b/man/lago-payment-methods-payment-method-set-as-default.1 index 1f234d7..2bd84f6 100644 --- a/man/lago-payment-methods-payment-method-set-as-default.1 +++ b/man/lago-payment-methods-payment-method-set-as-default.1 @@ -10,7 +10,7 @@ lago-payment-methods-payment-method-set-as-default - Set the payment method as d .SH DESCRIPTION -Use the payment method as default when not selected a payment method +This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset. .SH OPTIONS diff --git a/man/lago-payment-requests-create.1 b/man/lago-payment-requests-create.1 index 30192da..43c587c 100644 --- a/man/lago-payment-requests-create.1 +++ b/man/lago-payment-requests-create.1 @@ -15,7 +15,7 @@ This endpoint is used to create a payment request to collect payments of overdue .SH OPTIONS \fB--email\fP="" - The customer's email address used for sending dunning notifications + The email address used for sending dunning notifications. When omitted, the customer's own email address is used. .PP \fB--external-customer-id\fP="" diff --git a/man/lago-plans-create.1 b/man/lago-plans-create.1 index 9808c07..53cdb4a 100644 --- a/man/lago-plans-create.1 +++ b/man/lago-plans-create.1 @@ -19,7 +19,7 @@ This endpoint creates a plan with subscription and usage-based charges. It suppo .PP \fB--amount-currency\fP="" - The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--bill-charges-monthly\fP="" diff --git a/man/lago-plans-update.1 b/man/lago-plans-update.1 index b718e48..b7e3638 100644 --- a/man/lago-plans-update.1 +++ b/man/lago-plans-update.1 @@ -19,7 +19,7 @@ This endpoint updates a specific plan with subscription and usage-based charges. .PP \fB--amount-currency\fP="" - The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--bill-charges-monthly\fP="" diff --git a/man/lago-subscriptions-alerts.1 b/man/lago-subscriptions-alerts.1 index 9ced6a2..7ea4600 100644 --- a/man/lago-subscriptions-alerts.1 +++ b/man/lago-subscriptions-alerts.1 @@ -14,9 +14,25 @@ This endpoint enables the retrieval of all alerts for a subscription. .SH OPTIONS +\fB--all\fP[=false] + Fetch every page + +.PP \fB-h\fP, \fB--help\fP[=false] help for alerts +.PP +\fB--limit\fP="" + Results per page (1-1000) + +.PP +\fB--page\fP="" + Page number. + +.PP +\fB--per-page\fP="" + Number of records per page. + .PP \fB--subscription-status\fP="" Filter by subscription status. When provided, the subscription is looked up with this status instead of the default 'active' status. Possible values are 'pending', 'active', 'terminated', or 'canceled'.; one of: pending, active, terminated, canceled diff --git a/man/lago-subscriptions-create.1 b/man/lago-subscriptions-create.1 index df27d6a..b8249c7 100644 --- a/man/lago-subscriptions-create.1 +++ b/man/lago-subscriptions-create.1 @@ -91,7 +91,7 @@ This endpoint assigns a plan to a customer, creating or modifying a subscription .PP \fB--plan-overrides-amount-currency\fP="" - The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--plan-overrides-charges\fP="" diff --git a/man/lago-subscriptions-update.1 b/man/lago-subscriptions-update.1 index ea8ac5e..b647365 100644 --- a/man/lago-subscriptions-update.1 +++ b/man/lago-subscriptions-update.1 @@ -67,7 +67,7 @@ This endpoint allows you to update a subscription. .PP \fB--plan-overrides-amount-currency\fP="" - The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the plan. It indicates the monetary unit in which the plan's cost, including taxes and usage-based charges, is expressed.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--plan-overrides-charges\fP="" diff --git a/man/lago-wallets-create-customer-wallet.1 b/man/lago-wallets-create-customer-wallet.1 index ed5ea1e..cb7d154 100644 --- a/man/lago-wallets-create-customer-wallet.1 +++ b/man/lago-wallets-create-customer-wallet.1 @@ -31,7 +31,7 @@ This endpoint is used to create a wallet with prepaid credits. .PP \fB--currency\fP="" - The currency of the wallet.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the wallet.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--expiration-at\fP="" @@ -121,6 +121,10 @@ This endpoint is used to create a wallet with prepaid credits. \fB--transaction-name\fP="" The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either 'Prepaid credits - {{wallet_name}}' if the wallet name is set, or 'Prepaid credits'. +.PP +\fB--transaction-priority\fP="" + The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. + .SH OPTIONS INHERITED FROM PARENT COMMANDS \fB--api-key\fP="" diff --git a/man/lago-wallets-create-wallet-transaction.1 b/man/lago-wallets-create-wallet-transaction.1 index 4b6d59c..b1e168a 100644 --- a/man/lago-wallets-create-wallet-transaction.1 +++ b/man/lago-wallets-create-wallet-transaction.1 @@ -64,6 +64,10 @@ Note that this name will apply to all transactions ('paid_credits', 'granted_cre \fB--payment-method-payment-method-type\fP="" The type of payment method to use.; one of: provider, manual +.PP +\fB--priority\fP="" + The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. + .PP \fB--purchase-order-number\fP="" The purchase order number associated with this wallet transaction. It will be added to invoices generated for the resulting wallet top-up. If not set, falls back to the wallet's 'purchase_order_number'. @@ -72,6 +76,10 @@ Note that this name will apply to all transactions ('paid_credits', 'granted_cre \fB--voided-credits\fP="" The number of voided credits. +.PP +\fB--voided-transaction-id\fP="" + Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount. + .PP \fB--wallet-id\fP="" Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system. diff --git a/man/lago-wallets-create.1 b/man/lago-wallets-create.1 index 7eacb97..ae8a5ee 100644 --- a/man/lago-wallets-create.1 +++ b/man/lago-wallets-create.1 @@ -31,7 +31,7 @@ This endpoint is used to create a wallet with prepaid credits. .PP \fB--currency\fP="" - The currency of the wallet.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW + The currency of the wallet.; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STD, SYP, SZL, THB, TJS, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW .PP \fB--expiration-at\fP="" @@ -121,6 +121,10 @@ This endpoint is used to create a wallet with prepaid credits. \fB--transaction-name\fP="" The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either 'Prepaid credits - {{wallet_name}}' if the wallet name is set, or 'Prepaid credits'. +.PP +\fB--transaction-priority\fP="" + The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50. + .SH OPTIONS INHERITED FROM PARENT COMMANDS \fB--api-key\fP="" diff --git a/man/lago-wallets-get-customer-wallet-alerts.1 b/man/lago-wallets-get-customer-wallet-alerts.1 index 37ed869..5a53c14 100644 --- a/man/lago-wallets-get-customer-wallet-alerts.1 +++ b/man/lago-wallets-get-customer-wallet-alerts.1 @@ -14,9 +14,25 @@ This endpoint enables the retrieval of all alerts for a wallet. .SH OPTIONS +\fB--all\fP[=false] + Fetch every page + +.PP \fB-h\fP, \fB--help\fP[=false] help for get-customer-wallet-alerts +.PP +\fB--limit\fP="" + Results per page (1-1000) + +.PP +\fB--page\fP="" + Page number. + +.PP +\fB--per-page\fP="" + Number of records per page. + .PP \fB--watch\fP[=false] Poll and re-render when the response changes diff --git a/man/lago-wallets-list-customer-wallets.1 b/man/lago-wallets-list-customer-wallets.1 index 4f1817a..732ac22 100644 --- a/man/lago-wallets-list-customer-wallets.1 +++ b/man/lago-wallets-list-customer-wallets.1 @@ -21,6 +21,10 @@ This endpoint is used to list all wallets with prepaid credits of a customer \fB--billing-entity-codes\fP="" Filter wallets by billing entity codes. +.PP +\fB--currency\fP="" + Filter the results by currency, expressed as an ISO 4217 code. + .PP \fB-h\fP, \fB--help\fP[=false] help for list-customer-wallets diff --git a/man/lago-wallets-update-customer-wallet.1 b/man/lago-wallets-update-customer-wallet.1 index e8f1384..e14a23f 100644 --- a/man/lago-wallets-update-customer-wallet.1 +++ b/man/lago-wallets-update-customer-wallet.1 @@ -61,6 +61,14 @@ This endpoint is used to update an existing wallet with prepaid credits. A termi \fB--name\fP="" The name of the wallet. +.PP +\fB--paid-top-up-max-amount-cents\fP="" + Maximum amount of cents that can be top-up with a single paid transaction. + +.PP +\fB--paid-top-up-min-amount-cents\fP="" + Minimum amount of cents that can be top-up with a single paid transaction. + .PP \fB--payment-method-payment-method-id\fP="" The unique identifier of the payment method (required when using a specific provider payment method). diff --git a/man/lago-wallets-update.1 b/man/lago-wallets-update.1 index bc839e3..9cd9a27 100644 --- a/man/lago-wallets-update.1 +++ b/man/lago-wallets-update.1 @@ -61,6 +61,14 @@ This endpoint is used to update an existing wallet with prepaid credits. A termi \fB--name\fP="" The name of the wallet. +.PP +\fB--paid-top-up-max-amount-cents\fP="" + Maximum amount of cents that can be top-up with a single paid transaction. + +.PP +\fB--paid-top-up-min-amount-cents\fP="" + Minimum amount of cents that can be top-up with a single paid transaction. + .PP \fB--payment-method-payment-method-id\fP="" The unique identifier of the payment method (required when using a specific provider payment method). diff --git a/man/lago-wallets-wallet-transactions.1 b/man/lago-wallets-wallet-transactions.1 index 6770db2..24174d4 100644 --- a/man/lago-wallets-wallet-transactions.1 +++ b/man/lago-wallets-wallet-transactions.1 @@ -25,6 +25,10 @@ This endpoint is used to list all wallet transactions. \fB--limit\fP="" Results per page (1-1000) +.PP +\fB--metadata[key]\fP="" + Filter wallet transactions by metadata. Replace 'key' with the actual metadata key you want to match, and provide the corresponding value. For example, 'metadata[color]=blue'. + .PP \fB--page\fP="" Page number. diff --git a/spec/openapi.yaml b/spec/openapi.yaml index 5e4af33..3b89551 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: Lago API documentation description: Lago API allows your application to push customer information and metrics (events) from your application to the billing application. - version: 1.52.1 + version: 1.53.0 license: name: AGPLv3 url: https://github.com/getlago/lago-openapi/blob/main/LICENSE @@ -2433,6 +2433,7 @@ paths: - $ref: '#/components/parameters/external_customer_id_path' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' + - $ref: '#/components/parameters/currency' - $ref: '#/components/parameters/payment_status' - name: billing_entity_codes[] in: query @@ -2510,6 +2511,13 @@ paths: - $ref: '#/components/parameters/external_customer_id_path' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' + - name: external_id + in: query + description: The subscription external unique identifier (provided by your own application). + required: false + schema: + type: string + example: subscription_premium - name: plan_code in: query 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 plans. @@ -2598,6 +2606,7 @@ paths: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' + - $ref: '#/components/parameters/currency' - name: billing_entity_codes[] in: query description: Filter wallets by billing entity codes. @@ -2817,6 +2826,9 @@ paths: summary: List wallet alerts description: This endpoint enables the retrieval of all alerts for a wallet. operationId: getCustomerWalletAlerts + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per_page' responses: '200': description: Wallet alerts @@ -3242,10 +3254,10 @@ paths: - payment_methods operationId: paymentMethodSetAsDefault summary: Set the payment method as default - description: Use the payment method as default when not selected a payment method + description: This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset. responses: '200': - description: Return a 200 status to indicate that the data was received successfully + description: Payment method set as default content: application/json: schema: @@ -4728,10 +4740,11 @@ paths: parameters: - name: lago_id in: path - description: Payment receipt ID + description: Unique identifier of the payment receipt. required: true schema: type: string + format: uuid example: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba get: tags: @@ -6309,6 +6322,8 @@ paths: operationId: getSubscriptionAlerts parameters: - $ref: '#/components/parameters/subscription_status' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per_page' responses: '200': description: Subscription alerts @@ -7510,6 +7525,14 @@ paths: schema: type: string example: inbound + - name: metadata[key] + in: query + description: Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. For example, `metadata[color]=blue`. + required: false + explode: true + schema: + type: string + example: someValue responses: '200': description: Wallet transactions @@ -8766,9 +8789,10 @@ webhooks: description: Return a 200 status to indicate that the data was received successfully invoice_add_on_added: post: + deprecated: true operationId: invoiceAddOnAdded summary: A new add on invoice has been emitted - description: A new add on invoice has been emitted + description: '**Deprecated.** This webhook is no longer emitted by Lago. Use `invoice.one_off_created` for invoices created from add-ons.' parameters: - $ref: '#/components/parameters/webhook_signature' - $ref: '#/components/parameters/webhook_signature_algorithm' @@ -10721,6 +10745,15 @@ components: schema: type: string example: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba + currency: + name: currency + in: query + description: Filter the results by currency, expressed as an ISO 4217 code. + required: false + explode: true + schema: + type: string + example: EUR payment_status: name: payment_status in: query @@ -10769,15 +10802,6 @@ components: type: string format: uuid example: 1a901a90-1a90-1a90-1a90-1a901a901a90 - currency: - name: currency - in: query - description: Filter the results by currency, expressed as an ISO 4217 code. - required: false - explode: true - schema: - type: string - example: EUR plan_code: name: code in: path @@ -11003,9 +11027,11 @@ components: - SOS - SRD - STD + - SYP - SZL - THB - TJS + - TND - TOP - TRY - TTD @@ -13108,9 +13134,11 @@ components: - SOS - SRD - STD + - SYP - SZL - THB - TJS + - TND - TOP - TRY - TTD @@ -13162,6 +13190,12 @@ components: type: string description: The name of the coupon. example: Startup Deal + coupon_description: + type: + - string + - 'null' + description: The description of the parent coupon. + example: I am a coupon description coupon_status: type: string enum: @@ -16780,6 +16814,7 @@ components: - lago_customer_id - external_customer_id - invoice_ids + - invoice_numbers - lago_payable_id - payable_type - amount_cents @@ -16864,12 +16899,16 @@ components: - provider example: manual reference: - type: string - description: Reference for the payment. + type: + - string + - 'null' + description: Reference for the payment. Set on manual payments only; it is always `null` for payments collected through a payment provider. example: ref1 payment_provider_code: - type: string - description: Code of the payment provider + type: + - string + - 'null' + description: Code of the payment provider. It is `null` for manual payments, which are not attached to a payment provider. example: stripe_prod payment_provider_type: type: string @@ -16894,16 +16933,11 @@ components: description: Unique identifier of the payment within the payment provider (if applicable). example: pi_5eb0285741bc6ba provider_customer_id: - type: string - description: Unique identifier of the customer within the payment provider - example: cus_5eb0285bcf941bc6ba - payment_method_id: type: - string - 'null' - format: uuid - description: The unique identifier of the payment method used for this payment. - example: 1a901a90-1a90-1a90-1a90-1a901a901a90 + description: Unique identifier of the customer within the payment provider. It is `null` for manual payments. + example: cus_5eb0285bcf941bc6ba next_action: type: object additionalProperties: true @@ -16948,10 +16982,12 @@ components: description: Unique identifier of the payment request, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 email: - type: string + type: + - string + - 'null' format: email example: dinesh@piedpiper.test - description: The customer's email address used for sending dunning notifications + description: The email address used for sending dunning notifications. It defaults to the customer's own email address, and is `null` when the customer has none. amount_cents: type: integer description: The sum of the total amounts of all the invoices included in the payment request, expressed in cents. @@ -17537,7 +17573,6 @@ components: - currency - rate_amount - credits_balance - - balance - balance_cents - consumed_credits - created_at @@ -17748,6 +17783,8 @@ components: - eu_bank_details WalletCreateInput: type: object + required: + - wallet properties: wallet: type: object @@ -17841,6 +17878,12 @@ components: - 'null' description: The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`. example: Tokens for models 'high-fidelity-boost' + transaction_priority: + type: integer + minimum: 1 + maximum: 50 + description: 'The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.' + example: 50 purchase_order_number: type: - string @@ -18060,6 +18103,18 @@ components: type: boolean description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false. example: false + paid_top_up_min_amount_cents: + type: + - integer + - 'null' + description: Minimum amount of cents that can be top-up with a single paid transaction. + example: 100 + paid_top_up_max_amount_cents: + type: + - integer + - 'null' + description: Maximum amount of cents that can be top-up with a single paid transaction. + example: 1000 billing_entity_code: type: string example: default @@ -19078,6 +19133,8 @@ components: required: - lago_id - is_default + - payment_provider_code + - payment_provider_name - payment_provider_type - provider_method_id - created_at @@ -19104,9 +19161,12 @@ components: description: Human-readable name of the payment provider. example: Stripe payment_provider_type: - type: string - description: The type of the payment provider. + type: + - string + - 'null' + description: The type of the payment provider. It is `null` when the payment method is no longer attached to a payment provider. enum: + - null - adyen - cashfree - gocardless @@ -21543,6 +21603,18 @@ components: type: string description: The unique number assigned to the payment receipt. example: LAG-1234-001-002 + file_url: + type: + - string + - 'null' + description: The PDF file of the payment receipt. It is `null` while no PDF has been generated. + example: https://getlago.com/payment_receipt/file + xml_url: + type: + - string + - 'null' + description: The e-invoicing XML file of the payment receipt. It is `null` while no XML file has been generated. + example: https://getlago.com/payment_receipt/xml payment: $ref: '#/components/schemas/PaymentObject' PaymentReceiptsPaginated: @@ -21572,7 +21644,6 @@ components: payment_request: type: object required: - - email - external_customer_id - lago_invoice_ids properties: @@ -21584,7 +21655,7 @@ components: type: string format: email example: dinesh@piedpiper.test - description: The customer's email address used for sending dunning notifications + description: The email address used for sending dunning notifications. When omitted, the customer's own email address is used. lago_invoice_ids: type: array description: A list of Lago IDs for the customer's overdue invoices to start the dunning process @@ -21624,6 +21695,7 @@ components: description: The payment amount in cents reference: type: string + maxLength: 40 example: ref1 description: Reference for the payment paid_at: @@ -24990,6 +25062,19 @@ components: pattern: ^[0-9]+.?[0-9]*$ description: The number of voided credits. example: '5.0' + voided_transaction_id: + type: + - string + - 'null' + format: uuid + description: Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount. + example: 1a901a90-1a90-1a90-1a90-1a901a901a90 + priority: + type: integer + minimum: 1 + maximum: 50 + description: 'The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50.' + example: 50 invoice_requires_successful_payment: type: boolean description: A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false. @@ -25063,6 +25148,10 @@ components: format: uuid description: Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet's record within the Lago system. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 + billing_entity_code: + type: string + example: default + description: The code of the billing entity associated with the wallet transaction. Falls back to the wallet's billing entity when the transaction does not carry one. lago_invoice_id: type: - string diff --git a/spec/operations.json b/spec/operations.json index 1f29c6f..cdbe10e 100644 --- a/spec/operations.json +++ b/spec/operations.json @@ -276,9 +276,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -598,9 +600,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -815,9 +819,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -994,9 +1000,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -1165,9 +1173,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -1336,9 +1346,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -1507,9 +1519,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -1699,9 +1713,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -3125,9 +3141,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -4022,9 +4040,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -4544,9 +4564,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -4785,9 +4807,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -5290,9 +5314,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -6700,9 +6726,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -8147,6 +8175,14 @@ "required": false, "description": "Number of records per page." }, + { + "name": "currency", + "flag": "currency", + "in": "query", + "type": "string", + "required": false, + "description": "Filter the results by currency, expressed as an ISO 4217 code." + }, { "name": "payment_status", "flag": "payment-status", @@ -8320,6 +8356,14 @@ "required": false, "description": "Number of records per page." }, + { + "name": "external_id", + "flag": "external-id", + "in": "query", + "type": "string", + "required": false, + "description": "The subscription external unique identifier (provided by your own application)." + }, { "name": "plan_code", "flag": "plan-code", @@ -9524,9 +9568,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -9850,9 +9896,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -10766,9 +10814,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -12484,9 +12534,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -12884,7 +12936,7 @@ "method": "PUT", "path": "/customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default", "summary": "Set the payment method as default", - "description": "Use the payment method as default when not selected a payment method", + "description": "This endpoint sets a payment method as the customer's default one. It is the payment method Lago uses when a payment is triggered without an explicit one. Any other default payment method of the customer is unset.", "docs_url": "https://getlago.com/docs/api-reference/payment-methods/payment-method-object", "parameters": [ { @@ -12925,7 +12977,7 @@ "in": "path", "type": "string", "required": true, - "description": "Payment receipt ID" + "description": "Unique identifier of the payment receipt." } ], "idempotent": true, @@ -12991,9 +13043,9 @@ ], "flag": "email", "type": "string", - "required": true, + "required": false, "complex": false, - "description": "The customer's email address used for sending dunning notifications" + "description": "The email address used for sending dunning notifications. When omitted, the customer's own email address is used." }, { "path": [ @@ -13461,9 +13513,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -15269,9 +15323,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -16705,11 +16761,27 @@ "terminated", "canceled" ] + }, + { + "name": "page", + "flag": "page", + "in": "query", + "type": "integer", + "required": false, + "description": "Page number." + }, + { + "name": "per_page", + "flag": "per-page", + "in": "query", + "type": "integer", + "required": false, + "description": "Number of records per page." } ], "idempotent": true, "dangerous": false, - "paginated": false, + "paginated": true, "mutation": false }, { @@ -17093,9 +17165,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -19082,9 +19156,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -19985,7 +20061,7 @@ ], "flag": "currency", "type": "string", - "required": false, + "required": true, "complex": false, "description": "The currency of the wallet.", "enum": [ @@ -20104,9 +20180,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -20146,7 +20224,7 @@ ], "flag": "external-customer-id", "type": "string", - "required": false, + "required": true, "complex": false, "description": "The customer external unique identifier (provided by your own application)" }, @@ -20311,7 +20389,7 @@ ], "flag": "rate-amount", "type": "string", - "required": false, + "required": true, "complex": false, "description": "The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction." }, @@ -20347,6 +20425,16 @@ "nullable": true, "complex": false, "description": "The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`." + }, + { + "path": [ + "transaction_priority" + ], + "flag": "transaction-priority", + "type": "integer", + "required": false, + "complex": false, + "description": "The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50." } ], "required": true @@ -20429,7 +20517,7 @@ ], "flag": "currency", "type": "string", - "required": false, + "required": true, "complex": false, "description": "The currency of the wallet.", "enum": [ @@ -20548,9 +20636,11 @@ "SOS", "SRD", "STD", + "SYP", "SZL", "THB", "TJS", + "TND", "TOP", "TRY", "TTD", @@ -20590,7 +20680,7 @@ ], "flag": "external-customer-id", "type": "string", - "required": false, + "required": true, "complex": false, "description": "The customer external unique identifier (provided by your own application)" }, @@ -20755,7 +20845,7 @@ ], "flag": "rate-amount", "type": "string", - "required": false, + "required": true, "complex": false, "description": "The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction." }, @@ -20791,6 +20881,16 @@ "nullable": true, "complex": false, "description": "The name of the wallet transactions triggered when creating the wallet. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either `Prepaid credits - {{wallet_name}}` if the wallet name is set, or `Prepaid credits`." + }, + { + "path": [ + "transaction_priority" + ], + "flag": "transaction-priority", + "type": "integer", + "required": false, + "complex": false, + "description": "The priority of the wallet transactions triggered when creating the wallet. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50." } ], "required": true @@ -20959,6 +21059,16 @@ "manual" ] }, + { + "path": [ + "priority" + ], + "flag": "priority", + "type": "integer", + "required": false, + "complex": false, + "description": "The priority of the wallet transaction. It drives the order in which credits are consumed. Allowed values: 1-50, where 1 is highest priority and 50 is lowest. Defaults to 50." + }, { "path": [ "purchase_order_number" @@ -20981,6 +21091,17 @@ "complex": false, "description": "The number of voided credits." }, + { + "path": [ + "voided_transaction_id" + ], + "flag": "voided-transaction-id", + "type": "string", + "required": false, + "nullable": true, + "complex": false, + "description": "Unique identifier of the inbound wallet transaction to void. Only available on traceable wallets, and the target transaction must still have a remaining amount." + }, { "path": [ "wallet_id" @@ -21352,11 +21473,27 @@ "type": "string", "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." + }, + { + "name": "page", + "flag": "page", + "in": "query", + "type": "integer", + "required": false, + "description": "Page number." + }, + { + "name": "per_page", + "flag": "per-page", + "in": "query", + "type": "integer", + "required": false, + "description": "Number of records per page." } ], "idempotent": true, "dangerous": false, - "paginated": false, + "paginated": true, "mutation": false }, { @@ -21473,6 +21610,14 @@ "required": false, "description": "Number of records per page." }, + { + "name": "currency", + "flag": "currency", + "in": "query", + "type": "string", + "required": false, + "description": "Filter the results by currency, expressed as an ISO 4217 code." + }, { "name": "billing_entity_codes[]", "flag": "billing-entity-codes", @@ -21850,6 +21995,28 @@ "complex": false, "description": "The name of the wallet." }, + { + "path": [ + "paid_top_up_max_amount_cents" + ], + "flag": "paid-top-up-max-amount-cents", + "type": "integer", + "required": false, + "nullable": true, + "complex": false, + "description": "Maximum amount of cents that can be top-up with a single paid transaction." + }, + { + "path": [ + "paid_top_up_min_amount_cents" + ], + "flag": "paid-top-up-min-amount-cents", + "type": "integer", + "required": false, + "nullable": true, + "complex": false, + "description": "Minimum amount of cents that can be top-up with a single paid transaction." + }, { "path": [ "payment_method", @@ -22054,6 +22221,28 @@ "complex": false, "description": "The name of the wallet." }, + { + "path": [ + "paid_top_up_max_amount_cents" + ], + "flag": "paid-top-up-max-amount-cents", + "type": "integer", + "required": false, + "nullable": true, + "complex": false, + "description": "Maximum amount of cents that can be top-up with a single paid transaction." + }, + { + "path": [ + "paid_top_up_min_amount_cents" + ], + "flag": "paid-top-up-min-amount-cents", + "type": "integer", + "required": false, + "nullable": true, + "complex": false, + "description": "Minimum amount of cents that can be top-up with a single paid transaction." + }, { "path": [ "payment_method", @@ -22277,6 +22466,14 @@ "type": "string", "required": false, "description": "The transaction type of the wallet transaction. Possible values are `inbound` (increasing the wallet balance) or `outbound` (decreasing the wallet balance)." + }, + { + "name": "metadata[key]", + "flag": "metadata[key]", + "in": "query", + "type": "string", + "required": false, + "description": "Filter wallet transactions by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. For example, `metadata[color]=blue`." } ], "idempotent": true, @@ -22539,6 +22736,6 @@ "mutation": false } ], - "spec_sha256": "ce82ac3701caa4ab59bb35557a4e592adb0b81ce69fa37549fde391fc241aa1a", - "spec_version": "1.52.1" + "spec_sha256": "f41f86039f834a9b7594d5043ddb0a733a931b6cdc8927c706e51e3cae23ea6b", + "spec_version": "1.53.0" }