v6

latestOpenAPI 3.1.02026-07-311856741.1 MB

organizations

public

Get Organization

Get an organization by ID.

Scopes: organizations:read organizations:write

get/v1/organizations/{id}

Path parameters

idstring uuid4 required

The organization ID.

Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Response

Successful Response

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

namestring required

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

slugstring required

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

avatar_urlstring nullable required

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

proration_behavior'invoice' | 'prorate' | 'next_period' | 'reset' required

allow_customer_updatesboolean required

Whether customers can update their subscriptions from the customer portal.

emailstring nullable required

Public support email.

websitestring nullable required

Official website of the organization.

details_submitted_atstring date-time nullable required

When the business details were submitted for review.

onboarding_resubmission_requested_atstring date-time nullable required

When Polar requested that the organization review and resubmit its onboarding information, if applicable.

sso_enforcedboolean required

Whether members must access this organization through its SSO connection.

default_presentment_currencystring required

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

default_tax_behavior'location' | 'inclusive' | 'exclusive' required

embed_hostsstring[] required

Hosts allowed to embed this organization's checkout. An entry is a host and an optional port, without a scheme: HTTPS is always allowed, and HTTP too for local hosts — localhost, any .localhost or .local name, and loopback or private addresses. *.example.com matches any subdomain, but not example.com itself. An app origin such as chrome-extension://abcdef carries its scheme, having no host to match on.

embed_hosts_enforcedboolean required

Whether an embedding page's origin must match embed_hosts. Organizations that have not configured a list yet embed unchecked until the allowlist is enforced for everyone.

country'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' nullable

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

account_idstring uuid4 nullable required

ID of the transactions account.

payout_account_idstring uuid4 nullable required

ID of the payout account.