Update Organization - Polar

Documentation Index

Fetch the complete documentation index at: /docs/llms.txt

Use this file to discover all available pages before exploring further.

PATCH

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

Try it

Python

from polar.v2026_04 import Polar

polar = Polar("polar_oat_xxx")

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

JavaScript

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

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": {
    "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,
    "payment_method_expiration_reminder": 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,
      "update_units": true,
      "pause": true
    },
    "customer": {
      "allow_email_change": true
    }
  },
  "dispute_settings": {
    "auto_accept_below_amount": 5000
  },
  "embed_hosts": [
    "example.com",
    "*.example.com",
    "localhost:3000"
  ],
  "sso_enforced": true
}
'

Request Options

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: {
      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,
      payment_method_expiration_reminder: 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, update_units: true, pause: true},
      customer: {allow_email_change: true}
    },
    dispute_settings: {auto_accept_below_amount: 5000},
    embed_hosts: ['example.com', '*.example.com', 'localhost:3000'],
    sso_enforced: true
  })
};

Response Examples

Successful Response

{
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "avatar_url": "<string>",
  "proration_behavior": "invoice",
  "allow_customer_updates": true,
  "email": "<string>",
  "website": "<string>",
  "socials": [
    {
      "platform": "x",
      "url": "<string>"
    }
  ],
  "status": "created",
  "details_submitted_at": "2026-01-01T00:00:00.000000Z",
  "onboarding_resubmission_requested_at": "2026-01-01T00:00:00.000000Z",
  "sso_enforced": true,
  "default_presentment_currency": "<string>",
  "default_tax_behavior": "location",
  "feature_settings": {
    "issue_funding_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,
    "meter_cycling_enabled": false,
    "slack_benefit_enabled": false,
    "preview_access_enabled": false,
    "disputes_enabled": false,
    "sso_enabled": false,
    "dispute_auto_accept_enabled": false,
    "compass_enabled": false,
    "merchant_migration_enabled": false,
    "frame_ancestors_enforced": false
  },
  "subscription_settings": {
    "allow_multiple_subscriptions": true,
    "proration_behavior": "invoice",
    "benefit_revocation_grace_period": 123,
    "prevent_trial_abuse": true,
    "allow_customer_updates": true
  },
  "customer_email_settings": {
    "order_confirmation": true,
    "payment_method_expiration_reminder": 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,
      "update_units": true,
      "pause": true
    },
    "customer": {
      "allow_email_change": true
    }
  },
  "dispute_settings": {
    "auto_accept_below_amount": 123
  },
  "embed_hosts": [
    "<string>"
  ],
  "account_id": "<string>",
  "payout_account_id": "<string>",
  "capabilities": {
    "checkout_payments": true,
    "subscription_renewals": true,
    "payouts": true,
    "refunds": true,
    "api_access": true,
    "dashboard_access": true
  },
  "country": "AD"
}

Error Response

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