POpolar
discounts
public

List Discounts

Changed on

List discounts.

Scopes: discounts:read discounts:write

get/v1/discounts/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/discounts/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: discounts:read, discounts:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737
querystring nullable

Filter by name.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sortingDiscountSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response

Example response

{
  "items": [
    {
      "amount": 1000,
      "currency": "usd",
      "amounts": {
        "eur": 900,
        "usd": 1000
      },
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
    }
  ]
}

Changes

  • 8ae937367e87Revision changes
    • 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

    • info

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