Coupons

Query coupons

Changed on

Use when listing or searching coupons (e.g. promo management). Returns a paginated list; supports filtering and sorting.

post/coupons/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/coupons/search
  • Auth
    API key in header x-api-key

Request body

coupon_codesstring[]
coupon_idsstring[]
expandstring
limitinteger
offsetinteger
order'asc' | 'desc'
status'published' | 'deleted' | 'archived'

Response

OK

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • info

      added the new gte enum value to the request property //

  • 7d57386313c7Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the / request property type changed from no type to object

    • breaking

      the / request property type changed from no type to object

    • breaking

      the request property type changed from no type to string

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to object for status

    • warning

      added the new archived enum value to the // response property for the response status

    • warning

      added the new deleted enum value to the // response property for the response status

    • warning

      added the new published enum value to the // response property for the response status

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new archived enum value to the request property

    • info

      added the new deleted enum value to the request property

    • info

      added the new published enum value to the request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status