Polar home pagelight logodark logo
  • llms.txt
  • llms-full.txt
  • Discord
  • GitHub
  • Get Started
  • Get Started
  • Docs
  • API Reference
  • Changelog
  • Support
    • General
    • Rate Limits
    Core API
    • Checkout
    • Checkout Links
    • Custom Checkout Fields
    • Customers
      • GET
        Get Customer State
      • GET
        Get Customer State by External ID
      • GET
        List Customers
      • POST
        Create Customer
      • GET
        Get Customer
      • PATCH
        Update Customer
      • DEL
        Delete Customer
      • GET
        Get Customer by External ID
      • PATCH
        Update Customer by External ID
      • DEL
        Delete Customer by External ID
    • Subscriptions
    • Orders
    • Discounts
    • Refunds
    • Products
    • Events
    • Meters
    • Benefits
    • Customer Meters
    • License Keys
    • Files
    • Organizations
    • Metrics
    Customer Portal API
    • GET
      Get Customer
    • GET
      Get Organization
    • Sessions
    • Subscriptions
    • Orders
    • License Keys
    • File Downloads
    Webhook Events
    • Customer Events
    • Billing Events
    • Organization Events
    Integrations
    • OpenID Connect
    • Webhooks
    Customers

    Get Customer State by External ID

    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

    Was this page helpful?

    Get Customer State
    Previous
    List Customers
    Next
    xgithubdiscord
    Powered by Mintlify
    Assistant
    Responses are generated using AI and may contain mistakes.