> ## 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. # Create Customer Session > Create a customer session. For organizations with `member_model_enabled`, this will automatically create a member session for the owner member of the customer. **Scopes**: `customer_sessions:write` ## OpenAPI ````yaml post /v1/customer-sessions/ 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-sessions/: post: tags: - customer-sessions - public summary: Create Customer Session description: |- Create a customer session. For organizations with `member_model_enabled`, this will automatically create a member session for the owner member of the customer. **Scopes**: `customer_sessions:write` operationId: customer-sessions:create requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/CustomerSessionCustomerIDCreate' - $ref: '#/components/schemas/CustomerSessionCustomerExternalIDCreate' title: Customer Session Create required: true responses: '201': description: Customer session created. content: application/json: schema: $ref: '#/components/schemas/CustomerSession' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-codeSamples: - lang: go label: Go (SDK) source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tpolargo \"github.com/polarsource/polar-go\"\n\t\"github.com/polarsource/polar-go/models/components\"\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 polargo.WithSecurity(os.Getenv(\"POLAR_ACCESS_TOKEN\")),\n )\n\n res, err := s.CustomerSessions.Create(ctx, operations.CreateCustomerSessionsCreateCustomerSessionCreateCustomerSessionCustomerExternalIDCreate(\n components.CustomerSessionCustomerExternalIDCreate{\n ExternalCustomerID: \"\",\n },\n ))\n if err != nil {\n log.Fatal(err)\n }\n if res.CustomerSession != nil {\n switch res.CustomerSession.Customer.Type {\n case components.CustomerUnionTypeIndividual:\n // res.CustomerSession.Customer.CustomerIndividual is populated\n case components.CustomerUnionTypeTeam:\n // res.CustomerSession.Customer.CustomerTeam is populated\n }\n\n }\n}" - lang: python label: Python (SDK) source: |- from polar_sdk import Polar with Polar( access_token="", ) as polar: res = polar.customer_sessions.create(request={ "return_url": "https://example.com/account", "external_customer_id": "", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { Polar } from "@polar-sh/sdk"; const polar = new Polar({ accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await polar.customerSessions.create({ externalCustomerId: "", }); console.log(result); } run(); - lang: php label: PHP (SDK) source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Polar; use Polar\Models\Components; $sdk = Polar\Polar::builder() ->setSecurity( '' ) ->build(); $request = new Components\CustomerSessionCustomerExternalIDCreate( externalCustomerId: '', ); $response = $sdk->customerSessions->create( request: $request ); if ($response->customerSession !== null) { // handle response } components: schemas: CustomerSessionCustomerIDCreate: properties: member_id: anyOf: - type: string format: uuid4 - type: 'null' title: Member Id description: >- ID of the member to create a session for. When not provided and the organization has `member_model_enabled`, the owner member of the customer will be used for individual customers. external_member_id: anyOf: - type: string - type: 'null' title: External Member Id description: >- External ID of the member to create a session for. Alternative to `member_id`. return_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Return Url description: >- When set, a back button will be shown in the customer portal to return to this URL. examples: - https://example.com/account customer_id: type: string format: uuid4 title: Customer Id description: ID of the customer to create a session for. type: object required: - customer_id title: CustomerSessionCustomerIDCreate description: Schema for creating a customer session using a customer ID. CustomerSessionCustomerExternalIDCreate: properties: member_id: anyOf: - type: string format: uuid4 - type: 'null' title: Member Id description: >- ID of the member to create a session for. When not provided and the organization has `member_model_enabled`, the owner member of the customer will be used for individual customers. external_member_id: anyOf: - type: string - type: 'null' title: External Member Id description: >- External ID of the member to create a session for. Alternative to `member_id`. return_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Return Url description: >- When set, a back button will be shown in the customer portal to return to this URL. examples: - https://example.com/account external_customer_id: type: string title: External Customer Id description: External ID of the customer to create a session for. type: object required: - external_customer_id title: CustomerSessionCustomerExternalIDCreate description: Schema for creating a customer session using an external customer ID. CustomerSession: 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. token: type: string title: Token expires_at: type: string format: date-time title: Expires At return_url: anyOf: - type: string - type: 'null' title: Return Url customer_portal_url: type: string title: Customer Portal Url customer_id: type: string format: uuid4 title: Customer Id customer: $ref: '#/components/schemas/Customer' type: object required: - created_at - modified_at - id - token - expires_at - return_url - customer_portal_url - customer_id - customer title: CustomerSession description: A customer session that can be used to authenticate as a customer. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError Customer: oneOf: - $ref: '#/components/schemas/CustomerIndividual' - $ref: '#/components/schemas/CustomerTeam' discriminator: propertyName: type mapping: individual: $ref: '#/components/schemas/CustomerIndividual' team: $ref: '#/components/schemas/CustomerTeam' ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError CustomerIndividual: properties: id: type: string format: uuid4 title: Id description: The ID of the customer. examples: - 992fae2a-2a17-4b7a-8d9e-e287cf90131b 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. metadata: $ref: '#/components/schemas/MetadataOutputType' external_id: anyOf: - type: string - type: 'null' title: External Id description: >- The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. examples: - usr_1337 email: type: string title: Email description: >- The email address of the customer. This must be unique within the organization. examples: - customer@example.com email_verified: type: boolean title: Email Verified description: >- Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address. examples: - true type: type: string const: individual title: Type description: The type of customer. examples: - individual name: anyOf: - type: string - type: 'null' title: Name description: The name of the customer. examples: - John Doe 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 locale: anyOf: - type: string - type: 'null' title: Locale organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the customer. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: Timestamp for when the customer was soft deleted. avatar_url: type: string title: Avatar Url examples: - https://www.gravatar.com/avatar/xxx?d=404 type: object required: - id - created_at - modified_at - metadata - email - email_verified - type - name - billing_address - tax_id - organization_id - deleted_at - avatar_url title: CustomerIndividual description: A customer in an organization. CustomerTeam: properties: id: type: string format: uuid4 title: Id description: The ID of the customer. examples: - 992fae2a-2a17-4b7a-8d9e-e287cf90131b 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. metadata: $ref: '#/components/schemas/MetadataOutputType' external_id: anyOf: - type: string - type: 'null' title: External Id description: >- The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. examples: - usr_1337 email: anyOf: - type: string - type: 'null' title: Email description: >- The email address of the customer. This must be unique within the organization. examples: - customer@example.com email_verified: type: boolean title: Email Verified description: >- Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address. examples: - true type: type: string const: team title: Type description: The type of customer. Team customers can have multiple members. examples: - team name: anyOf: - type: string - type: 'null' title: Name description: The name of the customer. examples: - John Doe 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 locale: anyOf: - type: string - type: 'null' title: Locale organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the customer. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: Timestamp for when the customer was soft deleted. avatar_url: type: string title: Avatar Url examples: - https://www.gravatar.com/avatar/xxx?d=404 type: object required: - id - created_at - modified_at - metadata - email_verified - type - name - billing_address - tax_id - organization_id - deleted_at - avatar_url title: CustomerTeam description: A team customer in an organization. MetadataOutputType: additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object 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 securitySchemes: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. ````