Get Customer State

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

GET

customers

{id}

state

package main

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

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

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Customers.GetState(ctx, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerState != nil {
        // handle response
    }
}

{
  "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "external_id": "usr_1337",
  "email": "customer@example.com",
  "email_verified": true,
  "name": "John Doe",
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "US"
  },
  "tax_id": [
    "911144442",
    "us_ein"
  ],
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "deleted_at": "2023-11-07T05:31:56Z",
  "active_subscriptions": [
    {
      "id": "e5149aae-e521-42b9-b24c-abb3d71eea2e",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "custom_field_data": {},
      "metadata": {},
      "status": "active",
      "amount": 1000,
      "currency": "usd",
      "recurring_interval": "month",
      "current_period_start": "2025-02-03T13:37:00Z",
      "current_period_end": "2025-03-03T13:37:00Z",
      "cancel_at_period_end": false,
      "canceled_at": null,
      "started_at": "2025-01-03T13:37:00Z",
      "ends_at": null,
      "product_id": "d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23",
      "discount_id": null,
      "meters": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "consumed_units": 25,
          "credited_units": 100,
          "amount": 0,
          "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22"
        }
      ]
    }
  ],
  "granted_benefits": [
    {
      "id": "d322132c-a9d0-4e0d-b8d3-d81ad021a3a9",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "granted_at": "2025-01-03T13:37:00Z",
      "benefit_id": "397a17aa-15cf-4cb4-9333-18040203cf98",
      "benefit_type": "custom",
      "properties": {
        "account_id": "<string>",
        "guild_id": "<string>",
        "role_id": "<string>"
      }
    }
  ],
  "active_meters": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22",
      "consumed_units": 25,
      "credited_units": 100,
      "balance": 75
    }
  ],
  "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
}

Authorizations

Authorization

string

header

required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

string

required

The customer ID.

Response

200

application/json

Successful Response

A customer along with additional state information:

Active subscriptions
Granted benefits
Active meters

string

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

created_at

string

required

Creation timestamp of the object.

modified_at

string | null

required

Last modification timestamp of the object.

metadata

object

required

external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

string

required

The email address of the customer. This must be unique within the organization.

Example:

"customer@example.com"

email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

name

string | null

required

The name of the customer.

Example:

"John Doe"

billing_address

object | null

required

tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

organization_id

string

required

The ID of the organization owning the customer.

Example:

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

deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

active_subscriptions

object[]

required

The customer's active subscriptions.

An active customer subscription.

active_subscriptions.id

string

required

The ID of the subscription.

Example:

"e5149aae-e521-42b9-b24c-abb3d71eea2e"

active_subscriptions.created_at

string

required

Creation timestamp of the object.

active_subscriptions.modified_at

string | null

required

Last modification timestamp of the object.

active_subscriptions.metadata

object

required

active_subscriptions.status

string

required

Allowed value: "active"

Example:

"active"

active_subscriptions.amount

integer

required

The amount of the subscription.

Example:

1000

active_subscriptions.currency

string

required

The currency of the subscription.

Example:

"usd"

active_subscriptions.recurring_interval

enum<string>

required

The interval at which the subscription recurs.

Available options:

month,

year

active_subscriptions.current_period_start

string

required

The start timestamp of the current billing period.

Example:

"2025-02-03T13:37:00Z"

active_subscriptions.current_period_end

string | null

required

The end timestamp of the current billing period.

Example:

"2025-03-03T13:37:00Z"

active_subscriptions.cancel_at_period_end

boolean

required

Whether the subscription will be canceled at the end of the current period.

Example:

false

active_subscriptions.canceled_at

string | null

required

The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.

Example:

null

active_subscriptions.started_at

string | null

required

The timestamp when the subscription started.

Example:

"2025-01-03T13:37:00Z"

active_subscriptions.ends_at

string | null

required

The timestamp when the subscription will end.

Example:

null

active_subscriptions.product_id

string

required

The ID of the subscribed product.

Example:

"d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23"

active_subscriptions.discount_id

string | null

required

The ID of the applied discount, if any.

Example:

null

active_subscriptions.meters

object[]

required

List of meters associated with the subscription.

Current consumption and spending for a subscription meter.

active_subscriptions.custom_field_data

object

Key-value object storing custom field values.

granted_benefits

object[]

required

The customer's active benefit grants.

An active benefit grant for a customer.

active_meters

object[]

required

The customer's active meters.

An active meter for a customer, with latest consumed and credited units.

avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

Delete Custom Field

Get Customer State by External ID

package main

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

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

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Customers.GetState(ctx, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerState != nil {
        // handle response
    }
}

{
  "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "external_id": "usr_1337",
  "email": "customer@example.com",
  "email_verified": true,
  "name": "John Doe",
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "US"
  },
  "tax_id": [
    "911144442",
    "us_ein"
  ],
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "deleted_at": "2023-11-07T05:31:56Z",
  "active_subscriptions": [
    {
      "id": "e5149aae-e521-42b9-b24c-abb3d71eea2e",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "custom_field_data": {},
      "metadata": {},
      "status": "active",
      "amount": 1000,
      "currency": "usd",
      "recurring_interval": "month",
      "current_period_start": "2025-02-03T13:37:00Z",
      "current_period_end": "2025-03-03T13:37:00Z",
      "cancel_at_period_end": false,
      "canceled_at": null,
      "started_at": "2025-01-03T13:37:00Z",
      "ends_at": null,
      "product_id": "d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23",
      "discount_id": null,
      "meters": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "consumed_units": 25,
          "credited_units": 100,
          "amount": 0,
          "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22"
        }
      ]
    }
  ],
  "granted_benefits": [
    {
      "id": "d322132c-a9d0-4e0d-b8d3-d81ad021a3a9",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "granted_at": "2025-01-03T13:37:00Z",
      "benefit_id": "397a17aa-15cf-4cb4-9333-18040203cf98",
      "benefit_type": "custom",
      "properties": {
        "account_id": "<string>",
        "guild_id": "<string>",
        "role_id": "<string>"
      }
    }
  ],
  "active_meters": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22",
      "consumed_units": 25,
      "credited_units": 100,
      "balance": 75
    }
  ],
  "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
}