POpolar
customer_portal
customer-session
public

Get Authenticated Portal User

Get information about the currently authenticated portal user.

Scopes: customer_portal:read customer_portal:write

get/v1/customer-portal/customer-session/user

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customer-portal/customer-session/user
  • Auth
    • HTTP bearer
    • or HTTP bearer

Response

Successful Response

typestring required

Type of authenticated user: 'customer' or 'member'

namestring nullable required

User's name, if available.

emailstring required

User's email address.

customer_idstring uuid4 required

Associated customer ID.

member_idstring uuid4 nullable

Member ID. Only set for members.

rolestring nullable

Member role (owner, billing_manager, member). Only set for members.

Changes

No recorded changes to this operation across all 11 revisions of this API.