GET
/
v1
/
discounts
/
{id}
Typescript (SDK)
import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.discounts.get({
    id: "<value>",
  });

  console.log(result);
}

run();
{
  "duration": "once",
  "type": "fixed",
  "amount": 123,
  "currency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "code": "<string>",
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "max_redemptions": 123,
  "redemptions_count": 123,
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "products": [
    {
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "recurring_interval": "day",
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

​
id
string<uuid4>
required

The discount ID.

Response

Successful Response

Schema for a fixed amount discount that is applied once or forever.

​
duration
enum<string>
required
Available options:
once,
forever,
repeating
​
type
enum<string>
required
Available options:
fixed,
percentage
​
amount
integer
required
​
currency
string
required
​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
id
string<uuid4>
required

The ID of the object.

​
metadata
object
required
​
name
string
required

Name of the discount. Will be displayed to the customer when the discount is applied.

​
code
string | null
required

Code customers can use to apply the discount during checkout.

​
starts_at
string<date-time> | null
required

Timestamp after which the discount is redeemable.

​
ends_at
string<date-time> | null
required

Timestamp after which the discount is no longer redeemable.

​
max_redemptions
integer | null
required

Maximum number of times the discount can be redeemed.

​
redemptions_count
integer
required

Number of times the discount has been redeemed.

​
organization_id
string<uuid4>
required

The organization ID.

Examples:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

​
products
DiscountProduct · object[]
required