POpolar
customers
public

Get Customer State by External ID

Changed on

Get a customer state by external 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/external/{external_id}/state

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customers/external/{external_id}/state
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: customers:read, customers:write)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

external_idstring required

The customer external ID.

Response

Successful Response

CustomerState required(unresolved $ref)

Changes

  • f9688fd328d6Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status