Path Parameters
The organization slug.
Get a customer portal’s organization by slug.
import { Polar } from "@polar-sh/sdk";
const polar = new Polar();
async function run() {
const result = await polar.customerPortal.organizations.get({
slug: "<value>",
});
console.log(result);
}
run();
{
"organization": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
"name": "<string>",
"slug": "<string>",
"avatar_url": "<string>",
"email": "<string>",
"website": "<string>",
"socials": [
{
"platform": "x",
"url": "<string>"
}
],
"status": "created",
"details_submitted_at": "2023-11-07T05:31:56Z",
"feature_settings": {
"issue_funding_enabled": false
},
"subscription_settings": {
"allow_multiple_subscriptions": true,
"allow_customer_updates": true,
"proration_behavior": "invoice"
},
"notification_settings": {
"new_order": true,
"new_subscription": true
}
},
"products": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"recurring_interval": "day",
"is_recurring": true,
"is_archived": true,
"organization_id": "<string>",
"prices": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"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": "custom",
"description": "<string>",
"selectable": true,
"deletable": true,
"organization_id": "<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>"
}
]
}
]
}
The organization slug.
Was this page helpful?
import { Polar } from "@polar-sh/sdk";
const polar = new Polar();
async function run() {
const result = await polar.customerPortal.organizations.get({
slug: "<value>",
});
console.log(result);
}
run();
{
"organization": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
"name": "<string>",
"slug": "<string>",
"avatar_url": "<string>",
"email": "<string>",
"website": "<string>",
"socials": [
{
"platform": "x",
"url": "<string>"
}
],
"status": "created",
"details_submitted_at": "2023-11-07T05:31:56Z",
"feature_settings": {
"issue_funding_enabled": false
},
"subscription_settings": {
"allow_multiple_subscriptions": true,
"allow_customer_updates": true,
"proration_behavior": "invoice"
},
"notification_settings": {
"new_order": true,
"new_subscription": true
}
},
"products": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"recurring_interval": "day",
"is_recurring": true,
"is_archived": true,
"organization_id": "<string>",
"prices": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"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": "custom",
"description": "<string>",
"selectable": true,
"deletable": true,
"organization_id": "<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>"
}
]
}
]
}