Update Discount

PATCH

discounts

{id}

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.discounts.update(
    '00000000-0000-4000-8000-000000000000',
    external_id='ext_1337',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.discounts.update(
  "00000000-0000-4000-8000-000000000000",
  {
    "external_id": "ext_1337"
  },
);
console.log(response);

curl --request PATCH \
  --url https://api.polar.sh/v1/discounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "ext_1337",
  "metadata": {},
  "name": "<string>",
  "code": "<string>",
  "starts_at": "2026-01-01T00:00:00.000000Z",
  "ends_at": "2026-01-01T00:00:00.000000Z",
  "max_redemptions": 1073741824,
  "max_redemptions_per_customer": 1073741824,
  "duration_in_months": 500,
  "basis_points": 5000,
  "products": [
    "<string>"
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: 'ext_1337',
    metadata: {},
    name: '<string>',
    code: '<string>',
    starts_at: '2026-01-01T00:00:00.000000Z',
    ends_at: '2026-01-01T00:00:00.000000Z',
    max_redemptions: 1073741824,
    max_redemptions_per_customer: 1073741824,
    duration_in_months: 500,
    basis_points: 5000,
    products: ['<string>']
  })
};

fetch('https://api.polar.sh/v1/discounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polar.sh/v1/discounts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'external_id' => 'ext_1337',
    'metadata' => [
        
    ],
    'name' => '<string>',
    'code' => '<string>',
    'starts_at' => '2026-01-01T00:00:00.000000Z',
    'ends_at' => '2026-01-01T00:00:00.000000Z',
    'max_redemptions' => 1073741824,
    'max_redemptions_per_customer' => 1073741824,
    'duration_in_months' => 500,
    'basis_points' => 5000,
    'products' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polar.sh/v1/discounts/{id}"

	payload := strings.NewReader("{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"starts_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"ends_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"max_redemptions\": 1073741824,\n  \"max_redemptions_per_customer\": 1073741824,\n  \"duration_in_months\": 500,\n  \"basis_points\": 5000,\n  \"products\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.polar.sh/v1/discounts/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"starts_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"ends_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"max_redemptions\": 1073741824,\n  \"max_redemptions_per_customer\": 1073741824,\n  \"duration_in_months\": 500,\n  \"basis_points\": 5000,\n  \"products\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/discounts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"starts_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"ends_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"max_redemptions\": 1073741824,\n  \"max_redemptions_per_customer\": 1073741824,\n  \"duration_in_months\": 500,\n  \"basis_points\": 5000,\n  \"products\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "duration": "once",
  "type": "fixed",
  "amounts": {
    "eur": 900,
    "usd": 1000
  },
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "external_id": "ext_1337",
  "metadata": {},
  "name": "<string>",
  "code": "<string>",
  "starts_at": "2026-01-01T00:00:00.000000Z",
  "ends_at": "2026-01-01T00:00:00.000000Z",
  "max_redemptions": 123,
  "max_redemptions_per_customer": 123,
  "redemptions_count": 123,
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "products": [
    {
      "metadata": {},
      "id": "<string>",
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "trial_interval": "day",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "visibility": "draft",
      "recurring_interval": "day",
      "recurring_interval_count": 123,
      "meter_interval": "day",
      "meter_interval_count": 123,
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>"
    }
  ]
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Scopes

discounts:write

pat

discounts:write

oat

Path Parameters

string<uuid4>

required

The discount ID.

Body

application/json

Schema to update a discount.

external_id

string | null

An ID from your own system to reference this resource. It must be unique within the organization for this type of resource. It must start with a letter or digit and contain only letters, digits, _, -, . and :.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$

Example:

"ext_1337"

metadata

Metadata · object

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

A string with a maximum length of 500 characters
An integer
A floating-point number
A boolean

You can store up to 50 key-value pairs.

Show child attributes

name

string | null

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

Minimum string length: 1

code

string | null

Code customers can use to apply the discount during checkout. Must be between 3 and 256 characters long and contain only alphanumeric characters.If not provided, the discount can only be applied via the API.

starts_at

string<date-time> | null

Optional timestamp after which the discount is redeemable.

Example:

"2026-01-01T00:00:00.000000Z"

ends_at

string<date-time> | null

Optional timestamp after which the discount is no longer redeemable.

Example:

"2026-01-01T00:00:00.000000Z"

max_redemptions

integer | null

Optional maximum number of times the discount can be redeemed.

Required range: 1 <= x <= 2147483647

max_redemptions_per_customer

integer | null

Optional maximum number of times the discount can be redeemed by a single customer.

Required range: 1 <= x <= 2147483647

duration

enum<string> | null

Available options:

once,

forever,

repeating

duration_in_months

integer | null

Number of months the discount should be applied.

For this to work on yearly pricing, you should multiply this by 12. For example, to apply the discount for 2 years, set this to 24.

Required range: 1 <= x <= 999

type

enum<string> | null

Available options:

fixed,

percentage

amounts

Amounts · object | null

Map of currency to fixed amount to discount from the total. This allows specifying different discount amounts for different currencies.

Show child attributes

basis_points

integer | null

Discount percentage in basis points.

A basis point is 1/100th of a percent. For example, to create a 25.5% discount, set this to 2550.

Required range: 1 <= x <= 10000

products

string<uuid4>[] | null

List of product IDs the discount can be applied to.

Response

Discount updated.

DiscountFixedOnceForeverDuration
DiscountFixedRepeatDuration
DiscountPercentageOnceForeverDuration
DiscountPercentageRepeatDuration

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

amounts

Amounts · object

required

Map of currency to fixed amount to discount from the total.

Show child attributes

Example:

{ "eur": 900, "usd": 1000 }

created_at

string<date-time>

required

Creation timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

string<uuid4>

required

The ID of the object.

external_id

string | null

required

An ID from your own system to reference this resource. It must be unique within the organization for this type of resource.

Example:

"ext_1337"

metadata

object

required

Show child attributes

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.

Example:

"2026-01-01T00:00:00.000000Z"

ends_at

string<date-time> | null

required

Timestamp after which the discount is no longer redeemable.

Example:

"2026-01-01T00:00:00.000000Z"

max_redemptions

integer | null

required

Maximum number of times the discount can be redeemed.

max_redemptions_per_customer

integer | null

required

Maximum number of times the discount can be redeemed by a single customer.

redemptions_count

integer

required

Number of times the discount has been redeemed.

organization_id

string<uuid4>

required

The organization ID.

Example:

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

products

DiscountProduct · object[]

required

Show child attributes

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.discounts.update(
    '00000000-0000-4000-8000-000000000000',
    external_id='ext_1337',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.discounts.update(
  "00000000-0000-4000-8000-000000000000",
  {
    "external_id": "ext_1337"
  },
);
console.log(response);

curl --request PATCH \
  --url https://api.polar.sh/v1/discounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "ext_1337",
  "metadata": {},
  "name": "<string>",
  "code": "<string>",
  "starts_at": "2026-01-01T00:00:00.000000Z",
  "ends_at": "2026-01-01T00:00:00.000000Z",
  "max_redemptions": 1073741824,
  "max_redemptions_per_customer": 1073741824,
  "duration_in_months": 500,
  "basis_points": 5000,
  "products": [
    "<string>"
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: 'ext_1337',
    metadata: {},
    name: '<string>',
    code: '<string>',
    starts_at: '2026-01-01T00:00:00.000000Z',
    ends_at: '2026-01-01T00:00:00.000000Z',
    max_redemptions: 1073741824,
    max_redemptions_per_customer: 1073741824,
    duration_in_months: 500,
    basis_points: 5000,
    products: ['<string>']
  })
};

fetch('https://api.polar.sh/v1/discounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polar.sh/v1/discounts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'external_id' => 'ext_1337',
    'metadata' => [
        
    ],
    'name' => '<string>',
    'code' => '<string>',
    'starts_at' => '2026-01-01T00:00:00.000000Z',
    'ends_at' => '2026-01-01T00:00:00.000000Z',
    'max_redemptions' => 1073741824,
    'max_redemptions_per_customer' => 1073741824,
    'duration_in_months' => 500,
    'basis_points' => 5000,
    'products' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polar.sh/v1/discounts/{id}"

	payload := strings.NewReader("{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"starts_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"ends_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"max_redemptions\": 1073741824,\n  \"max_redemptions_per_customer\": 1073741824,\n  \"duration_in_months\": 500,\n  \"basis_points\": 5000,\n  \"products\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.polar.sh/v1/discounts/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"starts_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"ends_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"max_redemptions\": 1073741824,\n  \"max_redemptions_per_customer\": 1073741824,\n  \"duration_in_months\": 500,\n  \"basis_points\": 5000,\n  \"products\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/discounts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"starts_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"ends_at\": \"2026-01-01T00:00:00.000000Z\",\n  \"max_redemptions\": 1073741824,\n  \"max_redemptions_per_customer\": 1073741824,\n  \"duration_in_months\": 500,\n  \"basis_points\": 5000,\n  \"products\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "duration": "once",
  "type": "fixed",
  "amounts": {
    "eur": 900,
    "usd": 1000
  },
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "external_id": "ext_1337",
  "metadata": {},
  "name": "<string>",
  "code": "<string>",
  "starts_at": "2026-01-01T00:00:00.000000Z",
  "ends_at": "2026-01-01T00:00:00.000000Z",
  "max_redemptions": 123,
  "max_redemptions_per_customer": 123,
  "redemptions_count": 123,
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "products": [
    {
      "metadata": {},
      "id": "<string>",
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "trial_interval": "day",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "visibility": "draft",
      "recurring_interval": "day",
      "recurring_interval_count": 123,
      "meter_interval": "day",
      "meter_interval_count": 123,
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>"
    }
  ]
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Update Discount

Authorizations

Scopes

Path Parameters

Body

Response