> ## Documentation Index
> Fetch the complete documentation index at: https://docs.meteroid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List coupons



## OpenAPI

````yaml https://api.meteroid.com/api-docs/openapi.json get /api/v1/coupons
openapi: 3.1.0
info:
  title: meteroid
  description: ''
  license:
    name: LicenseRef-Proprietary
    identifier: LicenseRef-Proprietary
  version: 0.1.0
servers: []
security: []
tags:
  - name: Meteroid
    description: Meteroid API
  - name: Add-ons
  - name: Batch Jobs
  - name: Checkout Sessions
  - name: Connect
    description: Manage connected accounts (Express & Standard)
  - name: Coupons
  - name: Credit Notes
  - name: Customers
  - name: Entitlements
  - name: Events
  - name: Features
  - name: Invoices
  - name: Metrics
  - name: OAuth
    description: OAuth 2.0 token endpoints (public, client-credentials auth)
  - name: OAuth Apps
    description: Manage OAuth applications for Connect integrations
  - name: Plans
  - name: Product Families
  - name: Products
  - name: Subscriptions
  - name: Usage
paths:
  /api/v1/coupons:
    get:
      tags:
        - Coupons
      summary: List coupons
      operationId: list_coupons
      parameters:
        - name: search
          in: query
          required: false
          schema:
            type: string
        - name: filter
          in: query
          required: false
          schema:
            type: string
            title: CouponFilter
            enum:
              - ALL
              - ACTIVE
              - INACTIVE
              - ARCHIVED
        - name: order_by
          in: query
          description: >-
            Sort order. Format: `column.direction`. Allowed columns: `code`,
            `created_at`, `expires_at`. Direction: `asc` or `desc`. Default:
            `created_at.desc`.
          required: false
          schema:
            type: string
        - name: page
          in: query
          description: Page number (0-indexed)
          required: false
          schema:
            type: integer
            format: int32
            minimum: 0
        - name: per_page
          in: query
          description: Number of items per page
          required: false
          schema:
            type: integer
            format: int32
            maximum: 100
            minimum: 1
      responses:
        '200':
          description: List of coupons
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouponListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    CouponListResponse:
      type: object
      required:
        - data
        - pagination_meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Coupon'
        pagination_meta:
          $ref: '#/components/schemas/PaginationResponse'
    RestErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
    Coupon:
      type: object
      required:
        - id
        - code
        - description
        - discount
        - reusable
        - disabled
      properties:
        code:
          type: string
        description:
          type: string
        disabled:
          type: boolean
        discount:
          $ref: '#/components/schemas/CouponDiscount'
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
        id:
          $ref: '#/components/schemas/CouponId'
        recurring_value:
          type:
            - integer
            - 'null'
          format: int32
        redemption_limit:
          type:
            - integer
            - 'null'
          format: int32
        reusable:
          type: boolean
    PaginationResponse:
      type: object
      required:
        - page
        - per_page
        - total_items
        - total_pages
      properties:
        page:
          type: integer
          format: int32
          minimum: 0
        per_page:
          type: integer
          format: int32
          minimum: 0
        total_items:
          type: integer
          format: int64
          minimum: 0
        total_pages:
          type: integer
          format: int32
          minimum: 0
    ErrorCode:
      type: string
      enum:
        - BAD_REQUEST
        - NOT_FOUND
        - CONFLICT
        - FORBIDDEN
        - UNAUTHORIZED
        - TOO_MANY_REQUESTS
        - INTERNAL_SERVER_ERROR
    CouponDiscount:
      oneOf:
        - $ref: '#/components/schemas/PercentageDiscount'
        - $ref: '#/components/schemas/FixedDiscount'
      discriminator:
        propertyName: type
        mapping:
          FIXED:
            $ref: '#/components/schemas/FixedDiscount'
          PERCENTAGE:
            $ref: '#/components/schemas/PercentageDiscount'
    CouponId:
      type: string
      format: MeteroidId
      examples:
        - cou_7n42DGM5Tflk9n8mt7Fhc7
    PercentageDiscount:
      type: object
      required:
        - percentage
      properties:
        percentage:
          type: string
    FixedDiscount:
      type: object
      required:
        - currency
        - amount
      properties:
        amount:
          type: string
        currency:
          type: string
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````