Create Customer Session

POST

customer-sessions

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.CustomerSessions.Create(ctx, operations.CreateCustomerSessionsCreateCustomerSessionCreateCustomerSessionCustomerIDCreate(
        components.CustomerSessionCustomerIDCreate{
            CustomerID: "<value>",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerSession != nil {
        // handle response
    }
}

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "token": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "customer_portal_url": "<string>",
  "customer_id": "<string>",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "external_id": "usr_1337",
    "email": "customer@example.com",
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US"
    },
    "tax_id": [
      "911144442",
      "us_ein"
    ],
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
  }
}

Authorizations

Authorization

string

header

required

You can generate an Organization Access Token from your organization's settings.

Body

application/json

Schema for creating a customer session using a customer ID.

customer_id

string

required

ID of the customer to create a session for.

Response

201

application/json

Customer session created.

A customer session that can be used to authenticate as a customer.

created_at

string

required

Creation timestamp of the object.

modified_at

string | null

required

Last modification timestamp of the object.

string

required

The ID of the object.

token

string

required

expires_at

string

required

customer_portal_url

string

required

customer_id

string

required

customer

object

required

A customer in an organization.

customer.id

string

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

customer.created_at

string

required

Creation timestamp of the object.

customer.modified_at

string | null

required

Last modification timestamp of the object.

customer.metadata

object

required

customer.external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

customer.email

string

required

The email address of the customer. This must be unique within the organization.

Example:

"customer@example.com"

customer.email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

customer.billing_address

object | null

required

customer.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

customer.organization_id

string

required

The ID of the organization owning the customer.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

customer.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

customer.avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

Was this page helpful?

Get Organization

Get Subscription

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.CustomerSessions.Create(ctx, operations.CreateCustomerSessionsCreateCustomerSessionCreateCustomerSessionCustomerIDCreate(
        components.CustomerSessionCustomerIDCreate{
            CustomerID: "<value>",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerSession != nil {
        // handle response
    }
}

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "token": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "customer_portal_url": "<string>",
  "customer_id": "<string>",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "external_id": "usr_1337",
    "email": "customer@example.com",
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US"
    },
    "tax_id": [
      "911144442",
      "us_ein"
    ],
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

Create Customer Session

Authorizations

Body

Response