Coupons

List coupons

Changed on
get/api/v1/coupons

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

searchstring
filter'ALL' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED'
order_bystring

Sort order. Format: column.direction. Allowed columns: code, created_at, expires_at. Direction: asc or desc. Default: created_at.desc.

pageinteger

Page number (0-indexed)

per_pageinteger

Number of items per page

Response

List of coupons

Example response

{
  "data": [
    {
      "id": "cou_7n42DGM5Tflk9n8mt7Fhc7",
      "plan_ids": [
        "plan_7n42DGM5Tflk9n8mt7Fhc7"
      ]
    }
  ]
}

Changes

  • v14e013b4e4a8fRevision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became optional for the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • v1ee465c53a423Revision changes
    • breaking

      the /////// response's property format changed from decimal to no format for status

    • breaking

      the /////// response's property format changed from decimal to no format for status

    • info

      response discriminator property name changed for // response property from discriminator to type for the response status