Update Product Benefits

POST

products

{id}

benefits

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.products.update_benefits(
    '00000000-0000-4000-8000-000000000000',
    benefits=['00000000-0000-4000-8000-000000000000'],
)
print(response)

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

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

const response = await polar.products.updateBenefits(
  "00000000-0000-4000-8000-000000000000",
  {
    "benefits": [
      "00000000-0000-4000-8000-000000000000"
    ]
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/products/{id}/benefits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "benefits": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({benefits: ['<string>']})
};

fetch('https://api.polar.sh/v1/products/{id}/benefits', 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}/benefits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'benefits' => [
        '<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/products/{id}/benefits"

	payload := strings.NewReader("{\n  \"benefits\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.polar.sh/v1/products/{id}/benefits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"benefits\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"benefits\": [\n    \"<string>\"\n  ]\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 the benefits granted by a product.

benefits

string<uuid4>[]

required

List of benefit IDs. Each one must be on the same organization as the product.

The benefit ID.

Response

Product benefits 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_benefits(
    '00000000-0000-4000-8000-000000000000',
    benefits=['00000000-0000-4000-8000-000000000000'],
)
print(response)

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

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

const response = await polar.products.updateBenefits(
  "00000000-0000-4000-8000-000000000000",
  {
    "benefits": [
      "00000000-0000-4000-8000-000000000000"
    ]
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/products/{id}/benefits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "benefits": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({benefits: ['<string>']})
};

fetch('https://api.polar.sh/v1/products/{id}/benefits', 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}/benefits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'benefits' => [
        '<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/products/{id}/benefits"

	payload := strings.NewReader("{\n  \"benefits\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.polar.sh/v1/products/{id}/benefits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"benefits\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"benefits\": [\n    \"<string>\"\n  ]\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 Benefits

Authorizations

Scopes

Path Parameters

Body

Response