Create Product

POST

products

Go (SDK)

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Products.Create(ctx, components.CreateProductCreateProductCreateOneTime(
        components.ProductCreateOneTime{
            Name: "<value>",
            Prices: []components.ProductCreateOneTimePrices{
                components.CreateProductCreateOneTimePricesFixed(
                    components.ProductPriceFixedCreate{
                        PriceCurrency: components.PresentmentCurrencyUsd.ToPointer(),
                        PriceAmount: 677078,
                    },
                ),
                components.CreateProductCreateOneTimePricesCustom(
                    components.ProductPriceCustomCreate{
                        PriceCurrency: components.PresentmentCurrencyUsd.ToPointer(),
                    },
                ),
            },
            OrganizationID: polargo.Pointer("1dbfc517-0bbf-4301-9ba8-555ca42b9737"),
            RecurringInterval: "year",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Product != nil {
        // handle response
    }
}

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.products.create(request={
        "name": "<value>",
        "prices": [
            {
                "amount_type": "custom",
                "minimum_amount": 50,
            },
        ],
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    })

    # Handle response
    print(res)

import { Polar } from "@polar-sh/sdk";

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

async function run() {
  const result = await polar.products.create({
    name: "<value>",
    prices: [
      {
        amountType: "fixed",
        priceCurrency: "usd",
        priceAmount: 677078,
      },
      {
        amountType: "free",
      },
    ],
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    recurringInterval: "year",
  });

  console.log(result);
}

run();

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\ProductCreateOneTime(
    name: '<value>',
    prices: [
        new Components\ProductPriceFixedCreate(
            priceCurrency: Components\PresentmentCurrency::Usd,
            priceAmount: 677078,
        ),
        new Components\ProductPriceCustomCreate(
            priceCurrency: Components\PresentmentCurrency::Usd,
        ),
    ],
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    recurringInterval: 'year',
);

$response = $sdk->products->create(
    request: $request
);

if ($response->product !== null) {
    // handle response
}

curl --request POST \
  --url https://api.polar.sh/v1/products/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "prices": [
    {
      "amount_type": "<string>",
      "price_amount": 1,
      "price_currency": "usd"
    }
  ],
  "metadata": {},
  "description": "<string>",
  "visibility": "public",
  "medias": [
    "<string>"
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "required": true
    }
  ],
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "trial_interval_count": 500,
  "recurring_interval_count": 1
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    prices: [{amount_type: '<string>', price_amount: 1, price_currency: 'usd'}],
    metadata: {},
    description: '<string>',
    visibility: 'public',
    medias: ['<string>'],
    attached_custom_fields: [{custom_field_id: '<string>', required: true}],
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    trial_interval_count: 500,
    recurring_interval_count: 1
  })
};

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

HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/products/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/products/")

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  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}"

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

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval_count": 123,
  "name": "<string>",
  "description": "<string>",
  "recurring_interval_count": 123,
  "is_recurring": true,
  "is_archived": true,
  "organization_id": "<string>",
  "metadata": {},
  "prices": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "amount_type": "<string>",
      "price_currency": "<string>",
      "is_archived": true,
      "product_id": "<string>",
      "type": "<string>",
      "price_amount": 123,
      "legacy": true
    }
  ],
  "benefits": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "description": "<string>",
      "selectable": true,
      "deletable": true,
      "is_deleted": true,
      "organization_id": "<string>",
      "metadata": {},
      "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": "2023-11-07T05:31:56Z",
      "version": "<string>",
      "service": "<string>",
      "is_uploaded": true,
      "created_at": "2023-11-07T05:31:56Z",
      "size_readable": "<string>",
      "public_url": "<string>"
    }
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "custom_field": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "metadata": {},
        "type": "<string>",
        "slug": "<string>",
        "name": "<string>",
        "organization_id": "<string>",
        "properties": {
          "form_label": "<string>",
          "form_help_text": "<string>",
          "form_placeholder": "<string>",
          "textarea": true,
          "min_length": 1073741823,
          "max_length": 1073741823
        }
      },
      "order": 123,
      "required": true
    }
  ]
}

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

Authorizations

Authorization

string

header

required

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

Body

application/json

ProductCreateRecurring
ProductCreateOneTime

name

string

required

The name of the product.

Required string length: 3 - 64

prices

(ProductPriceFixedCreate · object | ProductPriceCustomCreate · object | ProductPriceFreeCreate · object | ProductPriceSeatBasedCreate · object | ProductPriceMeteredUnitCreate · object)[]

required

List of available prices for this product. It may combine at most one fixed price with one seat-based price (billed as fixed + seat_charge), or contain a single custom or free price, plus any number of metered prices. A free price cannot be combined with other prices, and a custom price cannot be combined with a fixed or seat-based price. Metered prices are not supported on one-time purchase products.

Minimum array length: 1

Schema to create a fixed price.

ProductPriceFixedCreate
ProductPriceCustomCreate
ProductPriceFreeCreate
ProductPriceSeatBasedCreate
ProductPriceMeteredUnitCreate

Show child attributes

recurring_interval

enum<string>

required

The recurring interval of the product.

Available options:

day,

week,

month,

year

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

description

string | null

The description of the product.

visibility

enum<string>

default:public

The visibility of the product.

Available options:

draft,

private,

public

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[]

List of custom fields to attach.

Show child attributes

organization_id

string<uuid4> | null

The organization ID.

Example:

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

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

recurring_interval_count

integer

default:1

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.

Required range: 1 <= x <= 999

Response

Product created.

A product.

string<uuid4>

required

The ID of the object.

created_at

string<date-time>

required

Creation timestamp of the object.

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

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.

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.

metadata

object

required

Show child attributes

prices

required

List of prices for this product.

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

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

Update ProductUpdate a product. **Scopes**: `products:write`

⌘I

Go (SDK)

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Products.Create(ctx, components.CreateProductCreateProductCreateOneTime(
        components.ProductCreateOneTime{
            Name: "<value>",
            Prices: []components.ProductCreateOneTimePrices{
                components.CreateProductCreateOneTimePricesFixed(
                    components.ProductPriceFixedCreate{
                        PriceCurrency: components.PresentmentCurrencyUsd.ToPointer(),
                        PriceAmount: 677078,
                    },
                ),
                components.CreateProductCreateOneTimePricesCustom(
                    components.ProductPriceCustomCreate{
                        PriceCurrency: components.PresentmentCurrencyUsd.ToPointer(),
                    },
                ),
            },
            OrganizationID: polargo.Pointer("1dbfc517-0bbf-4301-9ba8-555ca42b9737"),
            RecurringInterval: "year",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Product != nil {
        // handle response
    }
}

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.products.create(request={
        "name": "<value>",
        "prices": [
            {
                "amount_type": "custom",
                "minimum_amount": 50,
            },
        ],
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    })

    # Handle response
    print(res)

import { Polar } from "@polar-sh/sdk";

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

async function run() {
  const result = await polar.products.create({
    name: "<value>",
    prices: [
      {
        amountType: "fixed",
        priceCurrency: "usd",
        priceAmount: 677078,
      },
      {
        amountType: "free",
      },
    ],
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    recurringInterval: "year",
  });

  console.log(result);
}

run();

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\ProductCreateOneTime(
    name: '<value>',
    prices: [
        new Components\ProductPriceFixedCreate(
            priceCurrency: Components\PresentmentCurrency::Usd,
            priceAmount: 677078,
        ),
        new Components\ProductPriceCustomCreate(
            priceCurrency: Components\PresentmentCurrency::Usd,
        ),
    ],
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    recurringInterval: 'year',
);

$response = $sdk->products->create(
    request: $request
);

if ($response->product !== null) {
    // handle response
}

curl --request POST \
  --url https://api.polar.sh/v1/products/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "prices": [
    {
      "amount_type": "<string>",
      "price_amount": 1,
      "price_currency": "usd"
    }
  ],
  "metadata": {},
  "description": "<string>",
  "visibility": "public",
  "medias": [
    "<string>"
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "required": true
    }
  ],
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "trial_interval_count": 500,
  "recurring_interval_count": 1
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    prices: [{amount_type: '<string>', price_amount: 1, price_currency: 'usd'}],
    metadata: {},
    description: '<string>',
    visibility: 'public',
    medias: ['<string>'],
    attached_custom_fields: [{custom_field_id: '<string>', required: true}],
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    trial_interval_count: 500,
    recurring_interval_count: 1
  })
};

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

HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/products/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/products/")

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  \"name\": \"<string>\",\n  \"prices\": [\n    {\n      \"amount_type\": \"<string>\",\n      \"price_amount\": 1,\n      \"price_currency\": \"usd\"\n    }\n  ],\n  \"metadata\": {},\n  \"description\": \"<string>\",\n  \"visibility\": \"public\",\n  \"medias\": [\n    \"<string>\"\n  ],\n  \"attached_custom_fields\": [\n    {\n      \"custom_field_id\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"trial_interval_count\": 500,\n  \"recurring_interval_count\": 1\n}"

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

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval_count": 123,
  "name": "<string>",
  "description": "<string>",
  "recurring_interval_count": 123,
  "is_recurring": true,
  "is_archived": true,
  "organization_id": "<string>",
  "metadata": {},
  "prices": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "amount_type": "<string>",
      "price_currency": "<string>",
      "is_archived": true,
      "product_id": "<string>",
      "type": "<string>",
      "price_amount": 123,
      "legacy": true
    }
  ],
  "benefits": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "description": "<string>",
      "selectable": true,
      "deletable": true,
      "is_deleted": true,
      "organization_id": "<string>",
      "metadata": {},
      "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": "2023-11-07T05:31:56Z",
      "version": "<string>",
      "service": "<string>",
      "is_uploaded": true,
      "created_at": "2023-11-07T05:31:56Z",
      "size_readable": "<string>",
      "public_url": "<string>"
    }
  ],
  "attached_custom_fields": [
    {
      "custom_field_id": "<string>",
      "custom_field": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "metadata": {},
        "type": "<string>",
        "slug": "<string>",
        "name": "<string>",
        "organization_id": "<string>",
        "properties": {
          "form_label": "<string>",
          "form_help_text": "<string>",
          "form_placeholder": "<string>",
          "textarea": true,
          "min_length": 1073741823,
          "max_length": 1073741823
        }
      },
      "order": 123,
      "required": true
    }
  ]
}

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

General

Core API

Customer Portal API

Webhook Events

Integrations

Create Product

Authorizations

Body

Response