> ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get Customer > Get authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write` ## OpenAPI ````yaml get /v1/customer-portal/customers/me openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: Read the docs at https://polar.sh/docs/api-reference version: 0.1.0 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox security: - access_token: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints enabled in the MCP server. paths: /v1/customer-portal/customers/me: get: tags: - customer_portal - customers - public summary: Get Customer description: |- Get authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write` operationId: customer_portal:customers:get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerPortalCustomer' security: - customer_session: - customer_portal:read - customer_portal:write - member_session: - customer_portal:read - customer_portal:write x-codeSamples: - lang: go label: Go (SDK) source: "package main\n\nimport(\n\t\"context\"\n\tpolargo \"github.com/polarsource/polar-go\"\n\t\"os\"\n\t\"github.com/polarsource/polar-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := polargo.New()\n\n res, err := s.CustomerPortal.Customers.Get(ctx, operations.CustomerPortalCustomersGetSecurity{\n CustomerSession: polargo.Pointer(os.Getenv(\"POLAR_CUSTOMER_SESSION\")),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.CustomerPortalCustomer != nil {\n // handle response\n }\n}" - lang: python label: Python (SDK) source: |- import polar_sdk from polar_sdk import Polar with Polar() as polar: res = polar.customer_portal.customers.get(security=polar_sdk.CustomerPortalCustomersGetSecurity( customer_session="", )) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { Polar } from "@polar-sh/sdk"; const polar = new Polar(); async function run() { const result = await polar.customerPortal.customers.get({ customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "", }); console.log(result); } run(); - lang: php label: PHP (SDK) source: >- declare(strict_types=1); require 'vendor/autoload.php'; use Polar; use Polar\Models\Operations; $sdk = Polar\Polar::builder()->build(); $requestSecurity = new Operations\CustomerPortalCustomersGetSecurity( customerSession: '', ); $response = $sdk->customerPortal->customers->get( security: $requestSecurity ); if ($response->customerPortalCustomer !== null) { // handle response } components: schemas: CustomerPortalCustomer: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. email: anyOf: - type: string - type: 'null' title: Email email_verified: type: boolean title: Email Verified name: anyOf: - type: string - type: 'null' title: Name billing_name: anyOf: - type: string - type: 'null' title: Billing Name billing_address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' tax_id: anyOf: - prefixItems: - type: string - $ref: '#/components/schemas/TaxIDFormat' type: array maxItems: 2 minItems: 2 examples: - - '911144442' - us_ein - - FR61954506077 - eu_vat - type: 'null' title: Tax Id oauth_accounts: additionalProperties: $ref: '#/components/schemas/CustomerPortalOAuthAccount' type: object title: Oauth Accounts default_payment_method_id: anyOf: - type: string format: uuid4 - type: 'null' title: Default Payment Method Id type: anyOf: - $ref: '#/components/schemas/CustomerType' - type: 'null' type: object required: - created_at - modified_at - id - email - email_verified - name - billing_name - billing_address - tax_id - oauth_accounts title: CustomerPortalCustomer Address: properties: line1: anyOf: - type: string - type: 'null' title: Line1 line2: anyOf: - type: string - type: 'null' title: Line2 postal_code: anyOf: - type: string - type: 'null' title: Postal Code city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State country: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: CountryAlpha2 examples: - US - SE - FR x-speakeasy-enums: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW type: object required: - country title: Address CustomerPortalOAuthAccount: properties: account_id: type: string title: Account Id account_username: anyOf: - type: string - type: 'null' title: Account Username type: object required: - account_id - account_username title: CustomerPortalOAuthAccount CustomerType: type: string enum: - individual - team title: CustomerType securitySchemes: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. customer_session: type: http description: >- Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the [Create Customer Session endpoint](/api-reference/customer-portal/sessions/create). scheme: bearer member_session: type: http description: >- Member session tokens are specific tokens that are used to authenticate members on your organization. You can create those sessions programmatically using the [Create Member Session endpoint](/api-reference/member-portal/sessions/create). scheme: bearer ````