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.CreateProductCreateOneTimePricesCustom(
                    components.ProductPriceCustomCreate{},
                ),
            },
            OrganizationID: polargo.Pointer("1dbfc517-0bbf-4301-9ba8-555ca42b9737"),
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Product != nil {
        // handle response
    }
}

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval": "day",
  "trial_interval_count": 123,
  "name": "<string>",
  "description": "<string>",
  "recurring_interval": "day",
  "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>",
      "source": "catalog",
      "amount_type": "<string>",
      "is_archived": true,
      "product_id": "<string>",
      "type": "<string>",
      "recurring_interval": "day",
      "price_currency": "<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,
      "organization_id": "<string>",
      "metadata": {},
      "properties": {
        "note": "<string>"
      }
    }
  ],
  "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": 1,
          "max_length": 1
        }
      },
      "order": 123,
      "required": true
    }
  ]
}

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.

Minimum string length: 3

prices

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

required

List of available prices for this product. It should contain at most one static price (fixed, custom or free), and any number of metered prices. 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

prices.amount_type

string

required

Allowed value: "fixed"

prices.price_amount

integer

required

The price in cents.

Required range: 50 <= x <= 99999999

prices.price_currency

string

default:usd

The currency. Currently, only usd is supported.

recurring_interval

enum<string>

required

The recurring interval of the product. Note that the day and week values are for internal Polar staff use only.

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

metadata.{key}

Required string length: 1 - 500

description

string | null

The description of the product.

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

attached_custom_fields.custom_field_id

string<uuid4>

required

ID of the custom field to attach.

attached_custom_fields.required

boolean

required

Whether the value is required for this custom field.

organization_id

string<uuid4> | null

The ID of the organization owning the product. Required unless you use an organization token.

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.

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

Metadata · object

required

Show child attributes

metadata.{key}

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.

LegacyRecurringProductPriceFixed
LegacyRecurringProductPriceCustom
LegacyRecurringProductPriceFree
ProductPriceFixed
ProductPriceCustom
ProductPriceFree
ProductPriceSeatBased
ProductPriceMeteredUnit

Show child attributes

prices.created_at

string<date-time>

required

Creation timestamp of the object.

prices.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

prices.id

string<uuid4>

required

The ID of the price.

prices.source

enum<string>

required

The source of the price . catalog is a predefined price, while ad_hoc is a price created dynamically on a Checkout session.

Available options:

catalog,

ad_hoc

prices.amount_type

string

required

Allowed value: "fixed"

prices.is_archived

boolean

required

Whether the price is archived and no longer available.

prices.product_id

string<uuid4>

required

The ID of the product owning the price.

prices.type

string

required

The type of the price.

Allowed value: "recurring"

prices.recurring_interval

enum<string>

required

The recurring interval of the price.

Available options:

day,

week,

month,

year

prices.price_currency

string

required

The currency.

prices.price_amount

integer

required

The price in cents.

prices.legacy

boolean

required

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.

BenefitCustom
BenefitDiscord
BenefitGitHubRepository
BenefitDownloadables
BenefitLicenseKeys
BenefitMeterCredit

Show child attributes

benefits.id

string<uuid4>

required

The ID of the benefit.

benefits.created_at

string<date-time>

required

Creation timestamp of the object.

benefits.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

benefits.type

string

required

Allowed value: "custom"

benefits.description

string

required

The description of the benefit.

benefits.selectable

boolean

required

Whether the benefit is selectable when creating a product.

benefits.deletable

boolean

required

Whether the benefit is deletable.

benefits.organization_id

string<uuid4>

required

The ID of the organization owning the benefit.

benefits.metadata

Metadata · object

required

Show child attributes

benefits.metadata.{key}

benefits.properties

BenefitCustomProperties · object

required

Properties for a benefit of type custom.

Show child attributes

benefits.properties.note

string · null · null

required

Private note to be shared with customers who have this benefit granted.

medias

ProductMediaFileRead · object[]

required

List of medias associated to the product.

Show child attributes

medias.id

string<uuid4>

required

The ID of the object.

medias.organization_id

string<uuid4>

required

medias.name

string

required

medias.path

string

required

medias.mime_type

string

required

medias.size

integer

required

medias.storage_version

string | null

required

medias.checksum_etag

string | null

required

medias.checksum_sha256_base64

string | null

required

medias.checksum_sha256_hex

string | null

required

medias.last_modified_at

string<date-time> | null

required

medias.version

string | null

required

medias.service

string

required

Allowed value: "product_media"

medias.is_uploaded

boolean

required

medias.created_at

string<date-time>

required

medias.size_readable

string

required

medias.public_url

string

required

attached_custom_fields

AttachedCustomField · object[]

required

List of custom fields attached to the product.

Show child attributes

attached_custom_fields.custom_field_id

string<uuid4>

required

ID of the custom field.

attached_custom_fields.custom_field

CustomFieldText · object

required

Schema for a custom field of type text.

CustomFieldText
CustomFieldNumber
CustomFieldDate
CustomFieldCheckbox
CustomFieldSelect

Show child attributes

attached_custom_fields.custom_field.created_at

string<date-time>

required

Creation timestamp of the object.

attached_custom_fields.custom_field.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

attached_custom_fields.custom_field.id

string<uuid4>

required

The ID of the object.

attached_custom_fields.custom_field.metadata

Metadata · object

required

Show child attributes

attached_custom_fields.custom_field.metadata.{key}

attached_custom_fields.custom_field.type

string

required

Allowed value: "text"

attached_custom_fields.custom_field.slug

string

required

Identifier of the custom field. It'll be used as key when storing the value.

attached_custom_fields.custom_field.name

string

required

Name of the custom field.

attached_custom_fields.custom_field.organization_id

string<uuid4>

required

The ID of the organization owning the custom field.

attached_custom_fields.custom_field.properties

CustomFieldTextProperties · object

required

Show child attributes

attached_custom_fields.custom_field.properties.form_label

string

Minimum string length: 1

attached_custom_fields.custom_field.properties.form_help_text

string

Minimum string length: 1

attached_custom_fields.custom_field.properties.form_placeholder

string

Minimum string length: 1

attached_custom_fields.custom_field.properties.textarea

boolean

attached_custom_fields.custom_field.properties.min_length

integer

Required range: x >= 0

attached_custom_fields.custom_field.properties.max_length

integer

Required range: x >= 0

attached_custom_fields.order

integer

required

Order of the custom field in the resource.

attached_custom_fields.required

boolean

required

Whether the value is required for this custom field.

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.CreateProductCreateOneTimePricesCustom(
                    components.ProductPriceCustomCreate{},
                ),
            },
            OrganizationID: polargo.Pointer("1dbfc517-0bbf-4301-9ba8-555ca42b9737"),
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Product != nil {
        // handle response
    }
}

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval": "day",
  "trial_interval_count": 123,
  "name": "<string>",
  "description": "<string>",
  "recurring_interval": "day",
  "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>",
      "source": "catalog",
      "amount_type": "<string>",
      "is_archived": true,
      "product_id": "<string>",
      "type": "<string>",
      "recurring_interval": "day",
      "price_currency": "<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,
      "organization_id": "<string>",
      "metadata": {},
      "properties": {
        "note": "<string>"
      }
    }
  ],
  "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": 1,
          "max_length": 1
        }
      },
      "order": 123,
      "required": true
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Create Product

Authorizations

Body

Response