Create Custom Field

POST

custom-fields

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.custom_fields.create(
    type='text',
    slug='string',
    name='string',
    properties={},
)
print(response)

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

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

const response = await polar.customFields.create(
  {
    "type": "text",
    "slug": "string",
    "name": "string",
    "properties": {}
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/custom-fields/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "text",
  "slug": "<string>",
  "name": "<string>",
  "properties": {
    "form_label": "<string>",
    "form_help_text": "<string>",
    "form_placeholder": "<string>",
    "textarea": true,
    "min_length": 1073741823,
    "max_length": 1073741823
  },
  "metadata": {},
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'text',
    slug: '<string>',
    name: '<string>',
    properties: {
      form_label: '<string>',
      form_help_text: '<string>',
      form_placeholder: '<string>',
      textarea: true,
      min_length: 1073741823,
      max_length: 1073741823
    },
    metadata: {},
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  })
};

fetch('https://api.polar.sh/v1/custom-fields/', 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/custom-fields/",
  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([
    'type' => 'text',
    'slug' => '<string>',
    'name' => '<string>',
    'properties' => [
        'form_label' => '<string>',
        'form_help_text' => '<string>',
        'form_placeholder' => '<string>',
        'textarea' => true,
        'min_length' => 1073741823,
        'max_length' => 1073741823
    ],
    'metadata' => [
        
    ],
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  ]),
  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/custom-fields/"

	payload := strings.NewReader("{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\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/custom-fields/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/custom-fields/")

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  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}"

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

{
  "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
  }
}

{
  "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

custom_fields:write

pat

custom_fields:write

oat

Body

application/json

CustomFieldCreateText
CustomFieldCreateNumber
CustomFieldCreateDate
CustomFieldCreateCheckbox
CustomFieldCreateSelect

Schema to create a custom field of type text.

type

string

required

Allowed value: "text"

slug

string

required

Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens.

Minimum string length: 1

Pattern: ^[a-z0-9-_]+$

name

string

required

Name of the custom field.

Minimum string length: 1

properties

CustomFieldTextProperties · object

required

Show child attributes

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

organization_id

string<uuid4> | null

The organization ID.

Example:

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

Response

Custom field created.

CustomFieldText
CustomFieldNumber
CustomFieldDate
CustomFieldCheckbox
CustomFieldSelect

Schema for a custom field of type text.

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.

metadata

object

required

Show child attributes

type

string

required

Allowed value: "text"

slug

string

required

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

name

string

required

Name of the custom field.

organization_id

string<uuid4>

required

The ID of the organization owning the custom field.

Example:

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

properties

CustomFieldTextProperties · object

required

Show child attributes

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.custom_fields.create(
    type='text',
    slug='string',
    name='string',
    properties={},
)
print(response)

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

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

const response = await polar.customFields.create(
  {
    "type": "text",
    "slug": "string",
    "name": "string",
    "properties": {}
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/custom-fields/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "text",
  "slug": "<string>",
  "name": "<string>",
  "properties": {
    "form_label": "<string>",
    "form_help_text": "<string>",
    "form_placeholder": "<string>",
    "textarea": true,
    "min_length": 1073741823,
    "max_length": 1073741823
  },
  "metadata": {},
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'text',
    slug: '<string>',
    name: '<string>',
    properties: {
      form_label: '<string>',
      form_help_text: '<string>',
      form_placeholder: '<string>',
      textarea: true,
      min_length: 1073741823,
      max_length: 1073741823
    },
    metadata: {},
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  })
};

fetch('https://api.polar.sh/v1/custom-fields/', 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/custom-fields/",
  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([
    'type' => 'text',
    'slug' => '<string>',
    'name' => '<string>',
    'properties' => [
        'form_label' => '<string>',
        'form_help_text' => '<string>',
        'form_placeholder' => '<string>',
        'textarea' => true,
        'min_length' => 1073741823,
        'max_length' => 1073741823
    ],
    'metadata' => [
        
    ],
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  ]),
  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/custom-fields/"

	payload := strings.NewReader("{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\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/custom-fields/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/custom-fields/")

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  \"type\": \"text\",\n  \"slug\": \"<string>\",\n  \"name\": \"<string>\",\n  \"properties\": {\n    \"form_label\": \"<string>\",\n    \"form_help_text\": \"<string>\",\n    \"form_placeholder\": \"<string>\",\n    \"textarea\": true,\n    \"min_length\": 1073741823,\n    \"max_length\": 1073741823\n  },\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}"

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

{
  "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
  }
}

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

General

Core API

Customer Portal API

Webhook Events

Integrations

Create Custom Field

Authorizations

Scopes

Body

Response