Update Organization

PATCH

organizations

{id}

python (new sdk)

from polar.v2026_04 import Polar

polar = Polar("polar_oat_xxx")

response = polar.organizations.update(
    '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2026-04";

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

const response = await polar.organizations.update(
  "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  {},
);
console.log(response);

curl --request PATCH \
  --url https://api.polar.sh/v1/organizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "avatar_url": "<string>",
  "email": "jsmith@example.com",
  "website": "<string>",
  "socials": [
    {
      "url": "<string>"
    }
  ],
  "details": {
    "about": "<string>",
    "product_description": "<string>",
    "selling_categories": [
      "<string>"
    ],
    "pricing_models": [
      "<string>"
    ],
    "intended_use": "<string>",
    "customer_acquisition": [
      "<string>"
    ],
    "future_annual_revenue": 1,
    "switching": false,
    "previous_annual_revenue": 1
  },
  "feature_settings": {
    "seat_based_pricing_enabled": false,
    "member_model_enabled": false,
    "checkout_localization_enabled": false,
    "overview_metrics": [
      "<string>"
    ]
  },
  "subscription_settings": {
    "allow_multiple_subscriptions": true,
    "benefit_revocation_grace_period": 123,
    "prevent_trial_abuse": true,
    "allow_customer_updates": true
  },
  "customer_email_settings": {
    "order_confirmation": true,
    "subscription_cancellation": true,
    "subscription_confirmation": true,
    "subscription_cycled": true,
    "subscription_cycled_after_trial": true,
    "subscription_past_due": true,
    "subscription_paused": true,
    "subscription_resumed": true,
    "subscription_renewal_reminder": true,
    "subscription_revoked": true,
    "subscription_trial_conversion_reminder": true,
    "subscription_uncanceled": true,
    "subscription_updated": true
  },
  "customer_portal_settings": {
    "usage": {
      "show": true
    },
    "subscription": {
      "update_seats": true,
      "update_plan": true,
      "pause": true
    },
    "customer": {
      "allow_email_change": true
    }
  },
  "sso_enforced": true
}
'

import requests

url = "https://api.polar.sh/v1/organizations/{id}"

payload = {
    "name": "<string>",
    "avatar_url": "<string>",
    "email": "jsmith@example.com",
    "website": "<string>",
    "socials": [{ "url": "<string>" }],
    "details": {
        "about": "<string>",
        "product_description": "<string>",
        "selling_categories": ["<string>"],
        "pricing_models": ["<string>"],
        "intended_use": "<string>",
        "customer_acquisition": ["<string>"],
        "future_annual_revenue": 1,
        "switching": False,
        "previous_annual_revenue": 1
    },
    "feature_settings": {
        "seat_based_pricing_enabled": False,
        "member_model_enabled": False,
        "checkout_localization_enabled": False,
        "overview_metrics": ["<string>"]
    },
    "subscription_settings": {
        "allow_multiple_subscriptions": True,
        "benefit_revocation_grace_period": 123,
        "prevent_trial_abuse": True,
        "allow_customer_updates": True
    },
    "customer_email_settings": {
        "order_confirmation": True,
        "subscription_cancellation": True,
        "subscription_confirmation": True,
        "subscription_cycled": True,
        "subscription_cycled_after_trial": True,
        "subscription_past_due": True,
        "subscription_paused": True,
        "subscription_resumed": True,
        "subscription_renewal_reminder": True,
        "subscription_revoked": True,
        "subscription_trial_conversion_reminder": True,
        "subscription_uncanceled": True,
        "subscription_updated": True
    },
    "customer_portal_settings": {
        "usage": { "show": True },
        "subscription": {
            "update_seats": True,
            "update_plan": True,
            "pause": True
        },
        "customer": { "allow_email_change": True }
    },
    "sso_enforced": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    avatar_url: '<string>',
    email: 'jsmith@example.com',
    website: '<string>',
    socials: [{url: '<string>'}],
    details: {
      about: '<string>',
      product_description: '<string>',
      selling_categories: ['<string>'],
      pricing_models: ['<string>'],
      intended_use: '<string>',
      customer_acquisition: ['<string>'],
      future_annual_revenue: 1,
      switching: false,
      previous_annual_revenue: 1
    },
    feature_settings: {
      seat_based_pricing_enabled: false,
      member_model_enabled: false,
      checkout_localization_enabled: false,
      overview_metrics: ['<string>']
    },
    subscription_settings: {
      allow_multiple_subscriptions: true,
      benefit_revocation_grace_period: 123,
      prevent_trial_abuse: true,
      allow_customer_updates: true
    },
    customer_email_settings: {
      order_confirmation: true,
      subscription_cancellation: true,
      subscription_confirmation: true,
      subscription_cycled: true,
      subscription_cycled_after_trial: true,
      subscription_past_due: true,
      subscription_paused: true,
      subscription_resumed: true,
      subscription_renewal_reminder: true,
      subscription_revoked: true,
      subscription_trial_conversion_reminder: true,
      subscription_uncanceled: true,
      subscription_updated: true
    },
    customer_portal_settings: {
      usage: {show: true},
      subscription: {update_seats: true, update_plan: true, pause: true},
      customer: {allow_email_change: true}
    },
    sso_enforced: true
  })
};

fetch('https://api.polar.sh/v1/organizations/{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/organizations/{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([
    'name' => '<string>',
    'avatar_url' => '<string>',
    'email' => 'jsmith@example.com',
    'website' => '<string>',
    'socials' => [
        [
                'url' => '<string>'
        ]
    ],
    'details' => [
        'about' => '<string>',
        'product_description' => '<string>',
        'selling_categories' => [
                '<string>'
        ],
        'pricing_models' => [
                '<string>'
        ],
        'intended_use' => '<string>',
        'customer_acquisition' => [
                '<string>'
        ],
        'future_annual_revenue' => 1,
        'switching' => false,
        'previous_annual_revenue' => 1
    ],
    'feature_settings' => [
        'seat_based_pricing_enabled' => false,
        'member_model_enabled' => false,
        'checkout_localization_enabled' => false,
        'overview_metrics' => [
                '<string>'
        ]
    ],
    'subscription_settings' => [
        'allow_multiple_subscriptions' => true,
        'benefit_revocation_grace_period' => 123,
        'prevent_trial_abuse' => true,
        'allow_customer_updates' => true
    ],
    'customer_email_settings' => [
        'order_confirmation' => true,
        'subscription_cancellation' => true,
        'subscription_confirmation' => true,
        'subscription_cycled' => true,
        'subscription_cycled_after_trial' => true,
        'subscription_past_due' => true,
        'subscription_paused' => true,
        'subscription_resumed' => true,
        'subscription_renewal_reminder' => true,
        'subscription_revoked' => true,
        'subscription_trial_conversion_reminder' => true,
        'subscription_uncanceled' => true,
        'subscription_updated' => true
    ],
    'customer_portal_settings' => [
        'usage' => [
                'show' => true
        ],
        'subscription' => [
                'update_seats' => true,
                'update_plan' => true,
                'pause' => true
        ],
        'customer' => [
                'allow_email_change' => true
        ]
    ],
    'sso_enforced' => 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/organizations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"website\": \"<string>\",\n  \"socials\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"details\": {\n    \"about\": \"<string>\",\n    \"product_description\": \"<string>\",\n    \"selling_categories\": [\n      \"<string>\"\n    ],\n    \"pricing_models\": [\n      \"<string>\"\n    ],\n    \"intended_use\": \"<string>\",\n    \"customer_acquisition\": [\n      \"<string>\"\n    ],\n    \"future_annual_revenue\": 1,\n    \"switching\": false,\n    \"previous_annual_revenue\": 1\n  },\n  \"feature_settings\": {\n    \"seat_based_pricing_enabled\": false,\n    \"member_model_enabled\": false,\n    \"checkout_localization_enabled\": false,\n    \"overview_metrics\": [\n      \"<string>\"\n    ]\n  },\n  \"subscription_settings\": {\n    \"allow_multiple_subscriptions\": true,\n    \"benefit_revocation_grace_period\": 123,\n    \"prevent_trial_abuse\": true,\n    \"allow_customer_updates\": true\n  },\n  \"customer_email_settings\": {\n    \"order_confirmation\": true,\n    \"subscription_cancellation\": true,\n    \"subscription_confirmation\": true,\n    \"subscription_cycled\": true,\n    \"subscription_cycled_after_trial\": true,\n    \"subscription_past_due\": true,\n    \"subscription_paused\": true,\n    \"subscription_resumed\": true,\n    \"subscription_renewal_reminder\": true,\n    \"subscription_revoked\": true,\n    \"subscription_trial_conversion_reminder\": true,\n    \"subscription_uncanceled\": true,\n    \"subscription_updated\": true\n  },\n  \"customer_portal_settings\": {\n    \"usage\": {\n      \"show\": true\n    },\n    \"subscription\": {\n      \"update_seats\": true,\n      \"update_plan\": true,\n      \"pause\": true\n    },\n    \"customer\": {\n      \"allow_email_change\": true\n    }\n  },\n  \"sso_enforced\": 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/organizations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"website\": \"<string>\",\n  \"socials\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"details\": {\n    \"about\": \"<string>\",\n    \"product_description\": \"<string>\",\n    \"selling_categories\": [\n      \"<string>\"\n    ],\n    \"pricing_models\": [\n      \"<string>\"\n    ],\n    \"intended_use\": \"<string>\",\n    \"customer_acquisition\": [\n      \"<string>\"\n    ],\n    \"future_annual_revenue\": 1,\n    \"switching\": false,\n    \"previous_annual_revenue\": 1\n  },\n  \"feature_settings\": {\n    \"seat_based_pricing_enabled\": false,\n    \"member_model_enabled\": false,\n    \"checkout_localization_enabled\": false,\n    \"overview_metrics\": [\n      \"<string>\"\n    ]\n  },\n  \"subscription_settings\": {\n    \"allow_multiple_subscriptions\": true,\n    \"benefit_revocation_grace_period\": 123,\n    \"prevent_trial_abuse\": true,\n    \"allow_customer_updates\": true\n  },\n  \"customer_email_settings\": {\n    \"order_confirmation\": true,\n    \"subscription_cancellation\": true,\n    \"subscription_confirmation\": true,\n    \"subscription_cycled\": true,\n    \"subscription_cycled_after_trial\": true,\n    \"subscription_past_due\": true,\n    \"subscription_paused\": true,\n    \"subscription_resumed\": true,\n    \"subscription_renewal_reminder\": true,\n    \"subscription_revoked\": true,\n    \"subscription_trial_conversion_reminder\": true,\n    \"subscription_uncanceled\": true,\n    \"subscription_updated\": true\n  },\n  \"customer_portal_settings\": {\n    \"usage\": {\n      \"show\": true\n    },\n    \"subscription\": {\n      \"update_seats\": true,\n      \"update_plan\": true,\n      \"pause\": true\n    },\n    \"customer\": {\n      \"allow_email_change\": true\n    }\n  },\n  \"sso_enforced\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/organizations/{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  \"name\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"website\": \"<string>\",\n  \"socials\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"details\": {\n    \"about\": \"<string>\",\n    \"product_description\": \"<string>\",\n    \"selling_categories\": [\n      \"<string>\"\n    ],\n    \"pricing_models\": [\n      \"<string>\"\n    ],\n    \"intended_use\": \"<string>\",\n    \"customer_acquisition\": [\n      \"<string>\"\n    ],\n    \"future_annual_revenue\": 1,\n    \"switching\": false,\n    \"previous_annual_revenue\": 1\n  },\n  \"feature_settings\": {\n    \"seat_based_pricing_enabled\": false,\n    \"member_model_enabled\": false,\n    \"checkout_localization_enabled\": false,\n    \"overview_metrics\": [\n      \"<string>\"\n    ]\n  },\n  \"subscription_settings\": {\n    \"allow_multiple_subscriptions\": true,\n    \"benefit_revocation_grace_period\": 123,\n    \"prevent_trial_abuse\": true,\n    \"allow_customer_updates\": true\n  },\n  \"customer_email_settings\": {\n    \"order_confirmation\": true,\n    \"subscription_cancellation\": true,\n    \"subscription_confirmation\": true,\n    \"subscription_cycled\": true,\n    \"subscription_cycled_after_trial\": true,\n    \"subscription_past_due\": true,\n    \"subscription_paused\": true,\n    \"subscription_resumed\": true,\n    \"subscription_renewal_reminder\": true,\n    \"subscription_revoked\": true,\n    \"subscription_trial_conversion_reminder\": true,\n    \"subscription_uncanceled\": true,\n    \"subscription_updated\": true\n  },\n  \"customer_portal_settings\": {\n    \"usage\": {\n      \"show\": true\n    },\n    \"subscription\": {\n      \"update_seats\": true,\n      \"update_plan\": true,\n      \"pause\": true\n    },\n    \"customer\": {\n      \"allow_email_change\": true\n    }\n  },\n  \"sso_enforced\": true\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "avatar_url": "<string>",
  "allow_customer_updates": true,
  "email": "<string>",
  "website": "<string>",
  "socials": [
    {
      "url": "<string>"
    }
  ],
  "details_submitted_at": "2023-11-07T05:31:56Z",
  "sso_enforced": true,
  "default_presentment_currency": "<string>",
  "feature_settings": {
    "issue_funding_enabled": false,
    "seat_based_pricing_enabled": false,
    "wallets_enabled": false,
    "member_model_enabled": false,
    "checkout_localization_enabled": false,
    "overview_metrics": [
      "<string>"
    ],
    "reset_proration_behavior_enabled": false,
    "off_session_charges_enabled": false,
    "slack_benefit_enabled": false,
    "preview_access_enabled": false,
    "disputes_enabled": false,
    "sso_enabled": false,
    "compass_enabled": false,
    "merchant_migration_enabled": false
  },
  "subscription_settings": {
    "allow_multiple_subscriptions": true,
    "benefit_revocation_grace_period": 123,
    "prevent_trial_abuse": true,
    "allow_customer_updates": true
  },
  "customer_email_settings": {
    "order_confirmation": true,
    "subscription_cancellation": true,
    "subscription_confirmation": true,
    "subscription_cycled": true,
    "subscription_cycled_after_trial": true,
    "subscription_past_due": true,
    "subscription_paused": true,
    "subscription_resumed": true,
    "subscription_renewal_reminder": true,
    "subscription_revoked": true,
    "subscription_trial_conversion_reminder": true,
    "subscription_uncanceled": true,
    "subscription_updated": true
  },
  "customer_portal_settings": {
    "usage": {
      "show": true
    },
    "subscription": {
      "update_seats": true,
      "update_plan": true,
      "pause": true
    },
    "customer": {
      "allow_email_change": true
    }
  },
  "account_id": "<string>",
  "payout_account_id": "<string>",
  "capabilities": {
    "checkout_payments": true,
    "subscription_renewals": true,
    "payouts": true,
    "refunds": true,
    "api_access": true,
    "dashboard_access": true
  }
}

{
  "error": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "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.

Path Parameters

string<uuid4>

required

The organization ID.

Example:

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

Body

application/json

name

string | null

Minimum string length: 3

avatar_url

string<uri> | null

Required string length: 1 - 2083

string<email> | null

Public support email.

website

string<uri> | null

Official website of the organization.

Required string length: 1 - 2083

socials

OrganizationSocialLink · object[] | null

Links to social profiles.

Show child attributes

details

OrganizationDetails · object | null

Additional, private, business details Polar needs about active organizations for compliance (KYC).

Show child attributes

country

enum<string> | null

Two-letter country code (ISO 3166-1 alpha-2).

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW

feature_settings

OrganizationFeatureSettingsUpdate · object | null

Feature settings that organizations can update themselves.

Other feature settings are managed by Polar staff: they're ignored if provided and keep their current value.

Show child attributes

subscription_settings

OrganizationSubscriptionSettings · object | null

Show child attributes

customer_email_settings

OrganizationCustomerEmailSettings · object | null

Show child attributes

customer_portal_settings

OrganizationCustomerPortalSettings · object | null

Show child attributes

default_presentment_currency

enum<string> | null

Default presentment currency for the organization

Available options:

aed,

all,

amd,

aoa,

ars,

aud,

awg,

azn,

bam,

bbd,

bdt,

bif,

bmd,

bnd,

bob,

brl,

bsd,

bwp,

bzd,

cad,

cdf,

chf,

clp,

cny,

cop,

crc,

cve,

czk,

djf,

dkk,

dop,

dzd,

egp,

etb,

eur,

fjd,

fkp,

gbp,

gel,

gip,

gmd,

gnf,

gtq,

gyd,

hkd,

hnl,

htg,

huf,

idr,

ils,

inr,

isk,

jmd,

jpy,

kes,

kgs,

khr,

kmf,

krw,

kyd,

kzt,

lak,

lkr,

lrd,

lsl,

mad,

mdl,

mga,

mkd,

mnt,

mop,

mur,

mvr,

mwk,

mxn,

myr,

mzn,

nad,

ngn,

nio,

nok,

npr,

nzd,

pab,

pen,

pgk,

php,

pkr,

pln,

pyg,

qar,

ron,

rsd,

rwf,

sar,

sbd,

scr,

sek,

sgd,

shp,

sos,

srd,

szl,

thb,

tjs,

top,

try,

ttd,

twd,

tzs,

uah,

ugx,

usd,

uyu,

uzs,

vnd,

vuv,

wst,

xaf,

xcd,

xcg,

xof,

xpf,

yer,

zar,

zmw

default_tax_behavior

enum<string> | null

Default tax behavior applied on products.

Available options:

location,

inclusive,

exclusive

sso_enforced

boolean | null

Whether members must access this organization through its SSO connection. Turning this on requires an active SSO session for this organization and at least one enabled SSO connection.

Response

Organization updated.

created_at

string<date-time>

required

Creation timestamp of the object.

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

string<uuid4>

required

The ID of the object.

name

string

required

Organization name shown in checkout, customer portal, emails etc.

slug

string

required

Unique organization slug in checkout, customer portal and credit card statements.

avatar_url

string | null

required

Avatar URL shown in checkout, customer portal, emails etc.

proration_behavior

enum<string>

required

Proration behavior applied when customer updates their subscription from the portal.

Available options:

invoice,

prorate,

next_period,

reset

allow_customer_updates

boolean

required

Whether customers can update their subscriptions from the customer portal.

string | null

required

Public support email.

website

string | null

required

Official website of the organization.

socials

OrganizationSocialLink · object[]

required

Links to social profiles.

Show child attributes

status

enum<string>

required

Current organization status

Available options:

created,

review,

snoozed,

denied,

active,

blocked,

offboarding,

offboarded

details_submitted_at

string<date-time> | null

required

When the business details were submitted for review.

sso_enforced

boolean

required

Whether members must access this organization through its SSO connection.

default_presentment_currency

string

required

Default presentment currency. Used as fallback in checkout and customer portal, if the customer's local currency is not available.

default_tax_behavior

enum<string>

required

Default tax behavior applied on products.

Available options:

location,

inclusive,

exclusive

feature_settings

OrganizationFeatureSettings · object | null

required

Organization feature settings

Show child attributes

subscription_settings

OrganizationSubscriptionSettings · object

required

Settings related to subscriptions management

Show child attributes

customer_email_settings

OrganizationCustomerEmailSettings · object

required

Settings related to customer emails

Show child attributes

customer_portal_settings

OrganizationCustomerPortalSettings · object

required

Settings related to the customer portal

Show child attributes

account_id

string<uuid4> | null

required

ID of the transactions account.

payout_account_id

string<uuid4> | null

required

ID of the payout account.

capabilities

OrganizationCapabilities · object

required

Capabilities currently granted to the organization.

Show child attributes

country

enum<string> | null

Two-letter country code (ISO 3166-1 alpha-2).

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW

Get MetricsGet metrics about your orders and subscriptions. Currency values are output in cents. **Scopes**: `metrics:read`

⌘I

python (new sdk)

from polar.v2026_04 import Polar

polar = Polar("polar_oat_xxx")

response = polar.organizations.update(
    '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2026-04";

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

const response = await polar.organizations.update(
  "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  {},
);
console.log(response);

curl --request PATCH \
  --url https://api.polar.sh/v1/organizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "avatar_url": "<string>",
  "email": "jsmith@example.com",
  "website": "<string>",
  "socials": [
    {
      "url": "<string>"
    }
  ],
  "details": {
    "about": "<string>",
    "product_description": "<string>",
    "selling_categories": [
      "<string>"
    ],
    "pricing_models": [
      "<string>"
    ],
    "intended_use": "<string>",
    "customer_acquisition": [
      "<string>"
    ],
    "future_annual_revenue": 1,
    "switching": false,
    "previous_annual_revenue": 1
  },
  "feature_settings": {
    "seat_based_pricing_enabled": false,
    "member_model_enabled": false,
    "checkout_localization_enabled": false,
    "overview_metrics": [
      "<string>"
    ]
  },
  "subscription_settings": {
    "allow_multiple_subscriptions": true,
    "benefit_revocation_grace_period": 123,
    "prevent_trial_abuse": true,
    "allow_customer_updates": true
  },
  "customer_email_settings": {
    "order_confirmation": true,
    "subscription_cancellation": true,
    "subscription_confirmation": true,
    "subscription_cycled": true,
    "subscription_cycled_after_trial": true,
    "subscription_past_due": true,
    "subscription_paused": true,
    "subscription_resumed": true,
    "subscription_renewal_reminder": true,
    "subscription_revoked": true,
    "subscription_trial_conversion_reminder": true,
    "subscription_uncanceled": true,
    "subscription_updated": true
  },
  "customer_portal_settings": {
    "usage": {
      "show": true
    },
    "subscription": {
      "update_seats": true,
      "update_plan": true,
      "pause": true
    },
    "customer": {
      "allow_email_change": true
    }
  },
  "sso_enforced": true
}
'

import requests

url = "https://api.polar.sh/v1/organizations/{id}"

payload = {
    "name": "<string>",
    "avatar_url": "<string>",
    "email": "jsmith@example.com",
    "website": "<string>",
    "socials": [{ "url": "<string>" }],
    "details": {
        "about": "<string>",
        "product_description": "<string>",
        "selling_categories": ["<string>"],
        "pricing_models": ["<string>"],
        "intended_use": "<string>",
        "customer_acquisition": ["<string>"],
        "future_annual_revenue": 1,
        "switching": False,
        "previous_annual_revenue": 1
    },
    "feature_settings": {
        "seat_based_pricing_enabled": False,
        "member_model_enabled": False,
        "checkout_localization_enabled": False,
        "overview_metrics": ["<string>"]
    },
    "subscription_settings": {
        "allow_multiple_subscriptions": True,
        "benefit_revocation_grace_period": 123,
        "prevent_trial_abuse": True,
        "allow_customer_updates": True
    },
    "customer_email_settings": {
        "order_confirmation": True,
        "subscription_cancellation": True,
        "subscription_confirmation": True,
        "subscription_cycled": True,
        "subscription_cycled_after_trial": True,
        "subscription_past_due": True,
        "subscription_paused": True,
        "subscription_resumed": True,
        "subscription_renewal_reminder": True,
        "subscription_revoked": True,
        "subscription_trial_conversion_reminder": True,
        "subscription_uncanceled": True,
        "subscription_updated": True
    },
    "customer_portal_settings": {
        "usage": { "show": True },
        "subscription": {
            "update_seats": True,
            "update_plan": True,
            "pause": True
        },
        "customer": { "allow_email_change": True }
    },
    "sso_enforced": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    avatar_url: '<string>',
    email: 'jsmith@example.com',
    website: '<string>',
    socials: [{url: '<string>'}],
    details: {
      about: '<string>',
      product_description: '<string>',
      selling_categories: ['<string>'],
      pricing_models: ['<string>'],
      intended_use: '<string>',
      customer_acquisition: ['<string>'],
      future_annual_revenue: 1,
      switching: false,
      previous_annual_revenue: 1
    },
    feature_settings: {
      seat_based_pricing_enabled: false,
      member_model_enabled: false,
      checkout_localization_enabled: false,
      overview_metrics: ['<string>']
    },
    subscription_settings: {
      allow_multiple_subscriptions: true,
      benefit_revocation_grace_period: 123,
      prevent_trial_abuse: true,
      allow_customer_updates: true
    },
    customer_email_settings: {
      order_confirmation: true,
      subscription_cancellation: true,
      subscription_confirmation: true,
      subscription_cycled: true,
      subscription_cycled_after_trial: true,
      subscription_past_due: true,
      subscription_paused: true,
      subscription_resumed: true,
      subscription_renewal_reminder: true,
      subscription_revoked: true,
      subscription_trial_conversion_reminder: true,
      subscription_uncanceled: true,
      subscription_updated: true
    },
    customer_portal_settings: {
      usage: {show: true},
      subscription: {update_seats: true, update_plan: true, pause: true},
      customer: {allow_email_change: true}
    },
    sso_enforced: true
  })
};

fetch('https://api.polar.sh/v1/organizations/{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/organizations/{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([
    'name' => '<string>',
    'avatar_url' => '<string>',
    'email' => 'jsmith@example.com',
    'website' => '<string>',
    'socials' => [
        [
                'url' => '<string>'
        ]
    ],
    'details' => [
        'about' => '<string>',
        'product_description' => '<string>',
        'selling_categories' => [
                '<string>'
        ],
        'pricing_models' => [
                '<string>'
        ],
        'intended_use' => '<string>',
        'customer_acquisition' => [
                '<string>'
        ],
        'future_annual_revenue' => 1,
        'switching' => false,
        'previous_annual_revenue' => 1
    ],
    'feature_settings' => [
        'seat_based_pricing_enabled' => false,
        'member_model_enabled' => false,
        'checkout_localization_enabled' => false,
        'overview_metrics' => [
                '<string>'
        ]
    ],
    'subscription_settings' => [
        'allow_multiple_subscriptions' => true,
        'benefit_revocation_grace_period' => 123,
        'prevent_trial_abuse' => true,
        'allow_customer_updates' => true
    ],
    'customer_email_settings' => [
        'order_confirmation' => true,
        'subscription_cancellation' => true,
        'subscription_confirmation' => true,
        'subscription_cycled' => true,
        'subscription_cycled_after_trial' => true,
        'subscription_past_due' => true,
        'subscription_paused' => true,
        'subscription_resumed' => true,
        'subscription_renewal_reminder' => true,
        'subscription_revoked' => true,
        'subscription_trial_conversion_reminder' => true,
        'subscription_uncanceled' => true,
        'subscription_updated' => true
    ],
    'customer_portal_settings' => [
        'usage' => [
                'show' => true
        ],
        'subscription' => [
                'update_seats' => true,
                'update_plan' => true,
                'pause' => true
        ],
        'customer' => [
                'allow_email_change' => true
        ]
    ],
    'sso_enforced' => 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/organizations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"website\": \"<string>\",\n  \"socials\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"details\": {\n    \"about\": \"<string>\",\n    \"product_description\": \"<string>\",\n    \"selling_categories\": [\n      \"<string>\"\n    ],\n    \"pricing_models\": [\n      \"<string>\"\n    ],\n    \"intended_use\": \"<string>\",\n    \"customer_acquisition\": [\n      \"<string>\"\n    ],\n    \"future_annual_revenue\": 1,\n    \"switching\": false,\n    \"previous_annual_revenue\": 1\n  },\n  \"feature_settings\": {\n    \"seat_based_pricing_enabled\": false,\n    \"member_model_enabled\": false,\n    \"checkout_localization_enabled\": false,\n    \"overview_metrics\": [\n      \"<string>\"\n    ]\n  },\n  \"subscription_settings\": {\n    \"allow_multiple_subscriptions\": true,\n    \"benefit_revocation_grace_period\": 123,\n    \"prevent_trial_abuse\": true,\n    \"allow_customer_updates\": true\n  },\n  \"customer_email_settings\": {\n    \"order_confirmation\": true,\n    \"subscription_cancellation\": true,\n    \"subscription_confirmation\": true,\n    \"subscription_cycled\": true,\n    \"subscription_cycled_after_trial\": true,\n    \"subscription_past_due\": true,\n    \"subscription_paused\": true,\n    \"subscription_resumed\": true,\n    \"subscription_renewal_reminder\": true,\n    \"subscription_revoked\": true,\n    \"subscription_trial_conversion_reminder\": true,\n    \"subscription_uncanceled\": true,\n    \"subscription_updated\": true\n  },\n  \"customer_portal_settings\": {\n    \"usage\": {\n      \"show\": true\n    },\n    \"subscription\": {\n      \"update_seats\": true,\n      \"update_plan\": true,\n      \"pause\": true\n    },\n    \"customer\": {\n      \"allow_email_change\": true\n    }\n  },\n  \"sso_enforced\": 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/organizations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"website\": \"<string>\",\n  \"socials\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"details\": {\n    \"about\": \"<string>\",\n    \"product_description\": \"<string>\",\n    \"selling_categories\": [\n      \"<string>\"\n    ],\n    \"pricing_models\": [\n      \"<string>\"\n    ],\n    \"intended_use\": \"<string>\",\n    \"customer_acquisition\": [\n      \"<string>\"\n    ],\n    \"future_annual_revenue\": 1,\n    \"switching\": false,\n    \"previous_annual_revenue\": 1\n  },\n  \"feature_settings\": {\n    \"seat_based_pricing_enabled\": false,\n    \"member_model_enabled\": false,\n    \"checkout_localization_enabled\": false,\n    \"overview_metrics\": [\n      \"<string>\"\n    ]\n  },\n  \"subscription_settings\": {\n    \"allow_multiple_subscriptions\": true,\n    \"benefit_revocation_grace_period\": 123,\n    \"prevent_trial_abuse\": true,\n    \"allow_customer_updates\": true\n  },\n  \"customer_email_settings\": {\n    \"order_confirmation\": true,\n    \"subscription_cancellation\": true,\n    \"subscription_confirmation\": true,\n    \"subscription_cycled\": true,\n    \"subscription_cycled_after_trial\": true,\n    \"subscription_past_due\": true,\n    \"subscription_paused\": true,\n    \"subscription_resumed\": true,\n    \"subscription_renewal_reminder\": true,\n    \"subscription_revoked\": true,\n    \"subscription_trial_conversion_reminder\": true,\n    \"subscription_uncanceled\": true,\n    \"subscription_updated\": true\n  },\n  \"customer_portal_settings\": {\n    \"usage\": {\n      \"show\": true\n    },\n    \"subscription\": {\n      \"update_seats\": true,\n      \"update_plan\": true,\n      \"pause\": true\n    },\n    \"customer\": {\n      \"allow_email_change\": true\n    }\n  },\n  \"sso_enforced\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/organizations/{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  \"name\": \"<string>\",\n  \"avatar_url\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"website\": \"<string>\",\n  \"socials\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"details\": {\n    \"about\": \"<string>\",\n    \"product_description\": \"<string>\",\n    \"selling_categories\": [\n      \"<string>\"\n    ],\n    \"pricing_models\": [\n      \"<string>\"\n    ],\n    \"intended_use\": \"<string>\",\n    \"customer_acquisition\": [\n      \"<string>\"\n    ],\n    \"future_annual_revenue\": 1,\n    \"switching\": false,\n    \"previous_annual_revenue\": 1\n  },\n  \"feature_settings\": {\n    \"seat_based_pricing_enabled\": false,\n    \"member_model_enabled\": false,\n    \"checkout_localization_enabled\": false,\n    \"overview_metrics\": [\n      \"<string>\"\n    ]\n  },\n  \"subscription_settings\": {\n    \"allow_multiple_subscriptions\": true,\n    \"benefit_revocation_grace_period\": 123,\n    \"prevent_trial_abuse\": true,\n    \"allow_customer_updates\": true\n  },\n  \"customer_email_settings\": {\n    \"order_confirmation\": true,\n    \"subscription_cancellation\": true,\n    \"subscription_confirmation\": true,\n    \"subscription_cycled\": true,\n    \"subscription_cycled_after_trial\": true,\n    \"subscription_past_due\": true,\n    \"subscription_paused\": true,\n    \"subscription_resumed\": true,\n    \"subscription_renewal_reminder\": true,\n    \"subscription_revoked\": true,\n    \"subscription_trial_conversion_reminder\": true,\n    \"subscription_uncanceled\": true,\n    \"subscription_updated\": true\n  },\n  \"customer_portal_settings\": {\n    \"usage\": {\n      \"show\": true\n    },\n    \"subscription\": {\n      \"update_seats\": true,\n      \"update_plan\": true,\n      \"pause\": true\n    },\n    \"customer\": {\n      \"allow_email_change\": true\n    }\n  },\n  \"sso_enforced\": true\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "avatar_url": "<string>",
  "allow_customer_updates": true,
  "email": "<string>",
  "website": "<string>",
  "socials": [
    {
      "url": "<string>"
    }
  ],
  "details_submitted_at": "2023-11-07T05:31:56Z",
  "sso_enforced": true,
  "default_presentment_currency": "<string>",
  "feature_settings": {
    "issue_funding_enabled": false,
    "seat_based_pricing_enabled": false,
    "wallets_enabled": false,
    "member_model_enabled": false,
    "checkout_localization_enabled": false,
    "overview_metrics": [
      "<string>"
    ],
    "reset_proration_behavior_enabled": false,
    "off_session_charges_enabled": false,
    "slack_benefit_enabled": false,
    "preview_access_enabled": false,
    "disputes_enabled": false,
    "sso_enabled": false,
    "compass_enabled": false,
    "merchant_migration_enabled": false
  },
  "subscription_settings": {
    "allow_multiple_subscriptions": true,
    "benefit_revocation_grace_period": 123,
    "prevent_trial_abuse": true,
    "allow_customer_updates": true
  },
  "customer_email_settings": {
    "order_confirmation": true,
    "subscription_cancellation": true,
    "subscription_confirmation": true,
    "subscription_cycled": true,
    "subscription_cycled_after_trial": true,
    "subscription_past_due": true,
    "subscription_paused": true,
    "subscription_resumed": true,
    "subscription_renewal_reminder": true,
    "subscription_revoked": true,
    "subscription_trial_conversion_reminder": true,
    "subscription_uncanceled": true,
    "subscription_updated": true
  },
  "customer_portal_settings": {
    "usage": {
      "show": true
    },
    "subscription": {
      "update_seats": true,
      "update_plan": true,
      "pause": true
    },
    "customer": {
      "allow_email_change": true
    }
  },
  "account_id": "<string>",
  "payout_account_id": "<string>",
  "capabilities": {
    "checkout_payments": true,
    "subscription_renewals": true,
    "payouts": true,
    "refunds": true,
    "api_access": true,
    "dashboard_access": true
  }
}

{
  "error": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "detail": "<string>"
}

{
  "error": "<string>",
  "detail": "<string>"
}

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

General

Core API

Customer Portal API

Webhook Events

Integrations

Update Organization

Authorizations

Path Parameters

Body

Response