--- title: "List all applied coupons" method: GET path: "/applied_coupons" tags: ["coupons"] --- # List all applied coupons `GET /applied_coupons` This endpoint is used to list all applied coupons. You can filter by coupon status and by customer. ## Query parameters - `page` integer - `per_page` integer - `status` 'active' | 'terminated' - `external_customer_id` string - `coupon_code[]` string[] ## Response `200` Applied Coupons - AppliedCouponsPaginated - `applied_coupons` AppliedCouponObjectExtended[], required - `lago_id` string, uuid, required — Unique identifier of the applied coupon, created by Lago. - `lago_coupon_id` string, uuid, required — Unique identifier of the coupon, created by Lago. - `coupon_code` string, required — Unique code used to identify the coupon. - `coupon_name` string, required — The name of the coupon. - `coupon_status` 'active' | 'terminated' — The status of the parent coupon. Can be either `active` or `terminated`. - `coupon_deleted_at` string, date-time, nullable — The date and time when the parent coupon was deleted. If null, the coupon still exists. It is expressed in UTC format according to the ISO 8601 datetime standard. - `lago_customer_id` string, uuid, required — Unique identifier of the customer, created by Lago. - `external_customer_id` string, required — The customer external unique identifier (provided by your own application) - `status` 'active' | 'terminated', required — The status of the coupon. Can be either `active` or `terminated`. - `amount_cents` integer, nullable — The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type. - `amount_cents_remaining` integer, nullable — The remaining amount in cents for a `fixed_amount` coupon with a frequency set to `once`. This field indicates the remaining balance or value that can still be utilized from the coupon. - `amount_currency` 'null' | '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', nullable - `percentage_rate` string, nullable — The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type. - `frequency` 'once' | 'recurring' | 'forever', required — The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`. - If set to `once`, the coupon is applicable only for a single use. - If set to `recurring`, the coupon can be used multiple times for recurring billing periods. - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely. - `frequency_duration` integer, nullable — Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type - `frequency_duration_remaining` integer, nullable — The remaining number of billing periods to which the coupon is applicable. This field determines the remaining usage or availability of the coupon based on the remaining billing periods. - `expiration_at` string, date-time, nullable — The date and time after which the coupon will stop applying to customer's invoices. Once the expiration date is reached, the coupon will no longer be applicable, and any further invoices generated for the customer will not include the coupon discount. - `created_at` string, date-time, required — The date and time when the coupon was assigned to a customer. It is expressed in UTC format according to the ISO 8601 datetime standard. - `terminated_at` string, date-time, nullable — This field indicates the specific moment when the coupon amount is fully utilized or when the coupon is removed from the customer's coupon list. It is expressed in UTC format according to the ISO 8601 datetime standard. - `credits` CreditObject[], required - `lago_id` string, uuid, required — Unique identifier assigned to the credit within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the credit's item record within the Lago system. - `amount_cents` integer, required — The amount of credit associated with the invoice, expressed in cents. - `amount_currency` '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', required - `before_taxes` boolean, required — Indicates whether the credit is applied on the amount before taxes (coupons) or after taxes (credit notes). This flag helps determine the order in which credits are applied to the invoice calculation - `item` object, required — The item attached to the credit. - `lago_item_id` string, uuid, required — Unique identifier assigned to the credit item within the Lago application. - `type` 'coupon' | 'credit_note' | 'invoice', required — The type of credit applied. Possible values are `coupon`, `credit_note` or `invoice` (for `progressive_billing` invoice). - `code` string, required — The code of the credit applied. It can be the code of the coupon attached to the credit, the credit note's number or the `progressive_billing` invoice number. - `name` string, required — The name of the credit applied. It can be the name of the coupon attached to the credit, the initial invoice's number linked to the credit note or the `progressive_billing` invoice number. - `invoice` object, required - `lago_id` string, uuid, required - `payment_status` 'pending' | 'succeeded' | 'failed', required - `meta` PaginationMeta, required - `current_page` integer, required — Current page. - `next_page` integer, nullable — Next page. - `prev_page` integer, nullable — Previous page. - `total_pages` integer, required — Total number of pages. - `total_count` integer, required — Total number of records. ## Other responses - `401` — Unauthorized error --- [API](https://skmtc.net/getlago/apis/lago-api-documentation.md) · [All operations](https://skmtc.net/getlago/apis/lago-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getlago/lago-api-documentation/versions/6e969ef3bb45/schema)