Get Organization

GET

customer-portal

organizations

{slug}

Go (SDK)

package main

import(
	"context"
	polargo "github.com/polarsource/polar-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New()

    res, err := s.CustomerPortal.Organizations.Get(ctx, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerOrganization != nil {
        // handle response
    }
}

{
  "organization": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "avatar_url": "<string>",
    "proration_behavior": "invoice",
    "allow_customer_updates": true
  },
  "products": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "trial_interval": "day",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "recurring_interval": "day",
      "recurring_interval_count": 123,
      "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>",
          "source": "catalog",
          "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>"
        }
      ]
    }
  ]
}

Path Parameters

slug

string

required

The organization slug.

Response

Successful Response

Schema of an organization and related data for customer portal.

organization

CustomerOrganization · object

required

Show child attributes

organization.created_at

string<date-time>

required

Creation timestamp of the object.

organization.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

organization.id

string<uuid4>

required

The ID of the object.

organization.name

string

required

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

organization.slug

string

required

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

organization.avatar_url

string | null

required

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

organization.proration_behavior

enum<string>

required

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

Available options:

invoice,

prorate

organization.allow_customer_updates

boolean

required

Whether customers can update their subscriptions from the customer portal.

products

CustomerProduct · object[]

required

Show child attributes

products.id

string<uuid4>

required

The ID of the object.

products.created_at

string<date-time>

required

Creation timestamp of the object.

products.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

products.trial_interval

enum<string> | null

required

The interval unit for the trial period.

Available options:

day,

week,

month,

year

products.trial_interval_count

integer | null

required

The number of interval units for the trial period.

products.name

string

required

The name of the product.

products.description

string | null

required

The description of the product.

products.recurring_interval

enum<string> | null

required

The recurring interval of the product. If None, the product is a one-time purchase.

Available options:

day,

week,

month,

year

products.recurring_interval_count

integer | null

required

Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.

products.is_recurring

boolean

required

Whether the product is a subscription.

products.is_archived

boolean

required

Whether the product is archived and no longer available.

products.organization_id

string<uuid4>

required

The ID of the organization owning the product.

products.prices

required

List of available prices for this product.

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

LegacyRecurringProductPriceFixed
LegacyRecurringProductPriceCustom
LegacyRecurringProductPriceFree
ProductPriceFixed
ProductPriceCustom
ProductPriceFree
ProductPriceSeatBased
ProductPriceMeteredUnit

Show child attributes

products.prices.created_at

string<date-time>

required

Creation timestamp of the object.

products.prices.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

products.prices.id

string<uuid4>

required

The ID of the price.

products.prices.source

enum<string>

required

The source of the price . catalog is a predefined price, while ad_hoc is a price created dynamically on a Checkout session.

Available options:

catalog,

ad_hoc

products.prices.amount_type

string

required

Allowed value: "fixed"

products.prices.is_archived

boolean

required

Whether the price is archived and no longer available.

products.prices.product_id

string<uuid4>

required

The ID of the product owning the price.

products.prices.type

string

required

The type of the price.

Allowed value: "recurring"

products.prices.recurring_interval

enum<string>

required

The recurring interval of the price.

Available options:

day,

week,

month,

year

products.prices.price_currency

string

required

The currency.

products.prices.price_amount

integer

required

The price in cents.

products.prices.legacy

boolean

required

products.benefits

BenefitPublic · object[]

required

The benefits granted by the product.

Show child attributes

products.benefits.id

string<uuid4>

required

The ID of the benefit.

products.benefits.created_at

string<date-time>

required

Creation timestamp of the object.

products.benefits.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

products.benefits.type

enum<string>

required

The type of the benefit.

Available options:

custom,

discord,

github_repository,

downloadables,

license_keys,

meter_credit

products.benefits.description

string

required

The description of the benefit.

products.benefits.selectable

boolean

required

Whether the benefit is selectable when creating a product.

products.benefits.deletable

boolean

required

Whether the benefit is deletable.

products.benefits.organization_id

string<uuid4>

required

The ID of the organization owning the benefit.

products.medias

ProductMediaFileRead · object[]

required

The medias associated to the product.

Show child attributes

products.medias.id

string<uuid4>

required

The ID of the object.

products.medias.organization_id

string<uuid4>

required

products.medias.name

string

required

products.medias.path

string

required

products.medias.mime_type

string

required

products.medias.size

integer

required

products.medias.storage_version

string | null

required

products.medias.checksum_etag

string | null

required

products.medias.checksum_sha256_base64

string | null

required

products.medias.checksum_sha256_hex

string | null

required

products.medias.last_modified_at

string<date-time> | null

required

products.medias.version

string | null

required

products.medias.service

string

required

Allowed value: "product_media"

products.medias.is_uploaded

boolean

required

products.medias.created_at

string<date-time>

required

products.medias.size_readable

string

required

products.medias.public_url

string

required

Create Customer SessionCreate a customer session. **Scopes**: `customer_sessions:write`

⌘I

Go (SDK)

package main

import(
	"context"
	polargo "github.com/polarsource/polar-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New()

    res, err := s.CustomerPortal.Organizations.Get(ctx, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerOrganization != nil {
        // handle response
    }
}

{
  "organization": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "avatar_url": "<string>",
    "proration_behavior": "invoice",
    "allow_customer_updates": true
  },
  "products": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "trial_interval": "day",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "recurring_interval": "day",
      "recurring_interval_count": 123,
      "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>",
          "source": "catalog",
          "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>"
        }
      ]
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Get Organization

Path Parameters

Response