Update Product

PATCH

products

{id}

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.products.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.products.update(
  "00000000-0000-4000-8000-000000000000",
  {
    "external_id": "ext_1337"
  },
);
console.log(response);

curl --request PATCH \
  --url https://api.polar.sh/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "ext_1337",
  "metadata": {},
  "trial_interval_count": 500,
  "name": "<string>",
  "description": "<string>",
  "recurring_interval_count": 500,
  "is_archived": true,
  "prices": [
    {
      "id": "<string>"
    }
  ],
  "medias": [
    "<string>"
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "required": true
    }
  ],
  "trial_payment_setup_required": true
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: 'ext_1337',
    metadata: {},
    trial_interval_count: 500,
    name: '<string>',
    description: '<string>',
    recurring_interval_count: 500,
    is_archived: true,
    prices: [{id: '<string>'}],
    medias: ['<string>'],
    attached_custom_fields: [{custom_field_id: '<string>', required: true}],
    trial_payment_setup_required: true
  })
};

fetch('https://api.polar.sh/v1/products/{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/products/{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' => [
        
    ],
    'trial_interval_count' => 500,
    'name' => '<string>',
    'description' => '<string>',
    'recurring_interval_count' => 500,
    'is_archived' => true,
    'prices' => [
        [
                'id' => '<string>'
        ]
    ],
    'medias' => [
        '<string>'
    ],
    'attached_custom_fields' => [
        [
                'custom_field_id' => '<string>',
                'required' => true
        ]
    ],
    'trial_payment_setup_required' => true
  ]),
  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/products/{id}"

	payload := strings.NewReader("{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recurring_interval_count\": 500,\n  \"is_archived\": true,\n  \"prices\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"trial_payment_setup_required\": true\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/products/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recurring_interval_count\": 500,\n  \"is_archived\": true,\n  \"prices\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"trial_payment_setup_required\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/products/{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  \"trial_interval_count\": 500,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recurring_interval_count\": 500,\n  \"is_archived\": true,\n  \"prices\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"trial_payment_setup_required\": true\n}"

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

{
  "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>",
  "trial_payment_setup_required": true,
  "catalog_id": "<string>",
  "is_current": true,
  "external_id": "ext_1337",
  "metadata": {},
  "is_deletable": true,
  "prices": [
    {
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "id": "<string>",
      "source": "catalog",
      "amount_type": "fixed",
      "price_currency": "<string>",
      "tax_behavior": "location",
      "is_archived": true,
      "product_id": "<string>",
      "price_amount": 123
    }
  ],
  "benefits": [
    {
      "id": "<string>",
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "type": "custom",
      "description": "<string>",
      "selectable": true,
      "deletable": true,
      "is_deleted": true,
      "organization_id": "<string>",
      "external_id": "ext_1337",
      "metadata": {},
      "visibility": "draft",
      "catalog_id": "<string>",
      "is_current": true,
      "properties": {
        "note": "<string>"
      },
      "visibility_configurable": true
    }
  ],
  "medias": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "path": "<string>",
      "mime_type": "<string>",
      "size": 123,
      "storage_version": "<string>",
      "checksum_etag": "<string>",
      "checksum_sha256_base64": "<string>",
      "checksum_sha256_hex": "<string>",
      "last_modified_at": "2026-01-01T00:00:00.000000Z",
      "version": "<string>",
      "service": "product_media",
      "is_uploaded": true,
      "created_at": "2026-01-01T00:00:00.000000Z",
      "size_readable": "<string>",
      "public_url": "<string>"
    }
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "custom_field": {
        "created_at": "2026-01-01T00:00:00.000000Z",
        "modified_at": "2026-01-01T00:00:00.000000Z",
        "id": "<string>",
        "metadata": {},
        "type": "text",
        "slug": "<string>",
        "name": "<string>",
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        "properties": {
          "form_label": "<string>",
          "form_help_text": "<string>",
          "form_placeholder": "<string>",
          "textarea": true,
          "min_length": 1073741823,
          "max_length": 1073741823
        }
      },
      "order": 123,
      "required": true
    }
  ]
}

{
  "error": "NotPermitted",
  "detail": "<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

products:write

pat

products:write

oat

Path Parameters

string<uuid4>

required

The product ID.

Body

application/json

Schema to update a product.

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

trial_interval

enum<string> | null

The interval unit for the trial period.

Available options:

day,

week,

month,

year

trial_interval_count

integer | null

The number of interval units for the trial period.

Required range: 1 <= x <= 1000

name

string | null

The name of the product.

Required string length: 3 - 64

description

string | null

The description of the product.

recurring_interval

enum<string> | null

The recurring interval of the product. If None, the product is a one-time purchase. Can only be set on legacy recurring products. Once set, it can't be changed.

Available options:

day,

week,

month,

year

recurring_interval_count

integer | null

Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. Once set, it can't be changed.**

Required range: 1 <= x <= 999

is_archived

boolean | null

Whether the product is archived. If true, the product won't be available for purchase anymore. Existing customers will still have access to their benefits, and subscriptions will continue normally.

visibility

enum<string> | null

The visibility of the product.

Available options:

draft,

private,

public

prices

List of available prices for this product. If you want to keep existing prices, include them in the list as an ExistingProductPrice object.

A price that already exists for this product.

Useful when updating a product if you want to keep an existing price.

Show child attributes

medias

string<uuid4>[] | null

List of file IDs. Each one must be on the same organization as the product, of type product_media and correctly uploaded.

attached_custom_fields

AttachedCustomFieldCreate · object[] | null

List of custom fields to attach.

Show child attributes

trial_payment_setup_required

boolean | null

Whether customers must provide a payment method to start a trial. If false, customers can start a trial without entering payment details.

Response

Product updated.

A product.

string<uuid4>

required

The ID of the object.

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"

trial_interval

enum<string> | null

required

The interval unit for the trial period.

Available options:

day,

week,

month,

year

trial_interval_count

integer | null

required

The number of interval units for the trial period.

name

string

required

The name of the product.

description

string | null

required

The description of the product.

visibility

enum<string>

required

The visibility of the product.

Available options:

draft,

private,

public

recurring_interval

enum<string> | null

required

The recurring interval of the product. If None, the product is a one-time purchase.

Available options:

day,

week,

month,

year

recurring_interval_count

integer | null

required

Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.

meter_interval

enum<string> | null

required

The meter cycle of the product, independent of the billing interval. If None, metered concerns follow the billing interval.

Available options:

day,

week,

month,

year

meter_interval_count

integer | null

required

Number of meter interval units. None when no meter cycle is set.

is_recurring

boolean

required

Whether the product is a subscription.

is_archived

boolean

required

Whether the product is archived and no longer available.

organization_id

string<uuid4>

required

The ID of the organization owning the product.

trial_payment_setup_required

boolean

required

Whether customers must provide a payment method to start a trial. If false, customers can start a trial without entering payment details.

catalog_id

string<uuid4> | null

required

ID of the catalog that introduced this version of the product. None for products not managed by declarative config.

is_current

boolean

required

Whether this is the current version of the product.

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

is_deletable

boolean

required

Whether the product can be permanently deleted. Products referenced by an order, subscription, trial or discount cannot be deleted.

prices

required

List of prices for this product.

A fixed price for a product.

Show child attributes

benefits

required

List of benefits granted by the product.

A benefit of type custom.

Use it to grant any kind of benefit that doesn't fit in the other types.

Show child attributes

medias

ProductMediaFileRead · object[]

required

List of medias associated to the product.

Show child attributes

attached_custom_fields

AttachedCustomField · object[]

required

List of custom fields attached to the product.

Show child attributes

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.products.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.products.update(
  "00000000-0000-4000-8000-000000000000",
  {
    "external_id": "ext_1337"
  },
);
console.log(response);

curl --request PATCH \
  --url https://api.polar.sh/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "ext_1337",
  "metadata": {},
  "trial_interval_count": 500,
  "name": "<string>",
  "description": "<string>",
  "recurring_interval_count": 500,
  "is_archived": true,
  "prices": [
    {
      "id": "<string>"
    }
  ],
  "medias": [
    "<string>"
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "required": true
    }
  ],
  "trial_payment_setup_required": true
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: 'ext_1337',
    metadata: {},
    trial_interval_count: 500,
    name: '<string>',
    description: '<string>',
    recurring_interval_count: 500,
    is_archived: true,
    prices: [{id: '<string>'}],
    medias: ['<string>'],
    attached_custom_fields: [{custom_field_id: '<string>', required: true}],
    trial_payment_setup_required: true
  })
};

fetch('https://api.polar.sh/v1/products/{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/products/{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' => [
        
    ],
    'trial_interval_count' => 500,
    'name' => '<string>',
    'description' => '<string>',
    'recurring_interval_count' => 500,
    'is_archived' => true,
    'prices' => [
        [
                'id' => '<string>'
        ]
    ],
    'medias' => [
        '<string>'
    ],
    'attached_custom_fields' => [
        [
                'custom_field_id' => '<string>',
                'required' => true
        ]
    ],
    'trial_payment_setup_required' => true
  ]),
  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/products/{id}"

	payload := strings.NewReader("{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recurring_interval_count\": 500,\n  \"is_archived\": true,\n  \"prices\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"trial_payment_setup_required\": true\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/products/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"ext_1337\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recurring_interval_count\": 500,\n  \"is_archived\": true,\n  \"prices\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"trial_payment_setup_required\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/products/{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  \"trial_interval_count\": 500,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"recurring_interval_count\": 500,\n  \"is_archived\": true,\n  \"prices\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"trial_payment_setup_required\": true\n}"

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

{
  "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>",
  "trial_payment_setup_required": true,
  "catalog_id": "<string>",
  "is_current": true,
  "external_id": "ext_1337",
  "metadata": {},
  "is_deletable": true,
  "prices": [
    {
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "id": "<string>",
      "source": "catalog",
      "amount_type": "fixed",
      "price_currency": "<string>",
      "tax_behavior": "location",
      "is_archived": true,
      "product_id": "<string>",
      "price_amount": 123
    }
  ],
  "benefits": [
    {
      "id": "<string>",
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "type": "custom",
      "description": "<string>",
      "selectable": true,
      "deletable": true,
      "is_deleted": true,
      "organization_id": "<string>",
      "external_id": "ext_1337",
      "metadata": {},
      "visibility": "draft",
      "catalog_id": "<string>",
      "is_current": true,
      "properties": {
        "note": "<string>"
      },
      "visibility_configurable": true
    }
  ],
  "medias": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "path": "<string>",
      "mime_type": "<string>",
      "size": 123,
      "storage_version": "<string>",
      "checksum_etag": "<string>",
      "checksum_sha256_base64": "<string>",
      "checksum_sha256_hex": "<string>",
      "last_modified_at": "2026-01-01T00:00:00.000000Z",
      "version": "<string>",
      "service": "product_media",
      "is_uploaded": true,
      "created_at": "2026-01-01T00:00:00.000000Z",
      "size_readable": "<string>",
      "public_url": "<string>"
    }
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "custom_field": {
        "created_at": "2026-01-01T00:00:00.000000Z",
        "modified_at": "2026-01-01T00:00:00.000000Z",
        "id": "<string>",
        "metadata": {},
        "type": "text",
        "slug": "<string>",
        "name": "<string>",
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        "properties": {
          "form_label": "<string>",
          "form_help_text": "<string>",
          "form_placeholder": "<string>",
          "textarea": true,
          "min_length": 1073741823,
          "max_length": 1073741823
        }
      },
      "order": 123,
      "required": true
    }
  ]
}

{
  "error": "NotPermitted",
  "detail": "<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 Product

Authorizations

Scopes

Path Parameters

Body

Response