Core API
- Checkout
- Checkout Links
- Custom Checkout Fields
- Customers
- Subscriptions
- Orders
- Discounts
- Refunds
- Products
- Events
- Meters
- Benefits
- Customer Meters
- License Keys
- Files
- Organizations
- Metrics
Customer Portal API
- GETGet Customer
- GETGet Organization
- Sessions
- Subscriptions
- Orders
- License Keys
- File Downloads
Webhook Events
- Customer Events
- Billing Events
- Organization Events
OAuth 2.0 API
- Connect
- Clients
Customers
Get Customer State
Get a customer state by ID.
The customer state includes information about the customer’s active subscriptions and benefits.
It’s the ideal endpoint to use when you need to get a full overview of a customer’s status.
Scopes: customers:read
customers:write
GET
/
v1
/
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
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The customer ID.
Response
200
application/json
Successful Response
A customer along with additional state information:
- Active subscriptions
- Granted benefits
- Active meters
Was this page helpful?
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"
}
Assistant
Responses are generated using AI and may contain mistakes.