Skip to main content
GET
/
v1
/
customers
/
external
/
{external_id}
/
state
Go (SDK)
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.GetStateExternal(ctx, "<id>")
    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": "[email protected]",
  "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": "day",
      "current_period_start": "2025-02-03T13:37:00Z",
      "current_period_end": "2025-03-03T13:37:00Z",
      "trial_start": "2025-02-03T13:37:00Z",
      "trial_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",
      "benefit_metadata": {
        "key": "value"
      },
      "properties": {
        "account_id": "<string>",
        "guild_id": "<string>",
        "role_id": "<string>",
        "granted_account_id": "<string>"
      }
    }
  ],
  "active_meters": [
    {
      "id": "<string>",
      "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=404"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
external_id
string
required

Response

​
id
string<uuid4>
required
Examples:
​
created_at
string<date-time>
required
​
modified_at
string<date-time> | null
required
​
metadata
object
required
​
external_id
string | null
required
Examples:
​
email
string
required
Examples:
​
email_verified
boolean
required
Examples:
​
name
string | null
required
Examples:
​
billing_address
object | null
required
​
tax_id
any[] | null
required
Required array length: 2 elements
Examples:
​
organization_id
string<uuid4>
required
Examples:
​
deleted_at
string<date-time> | null
required
​
active_subscriptions
CustomerStateSubscription · object[]
required
​
granted_benefits
CustomerStateBenefitGrant · object[]
required
​
active_meters
CustomerStateMeter · object[]
required
​
avatar_url
string
required
Examples: