Create Customer

POST

customers

Go (SDK)

package main

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

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

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

    res, err := s.Customers.Create(ctx, components.CreateCustomerCreateCustomerIndividualCreate(
        components.CustomerIndividualCreate{
            ExternalID: polargo.Pointer("usr_1337"),
            Name: polargo.Pointer("John Doe"),
            BillingAddress: &components.AddressInput{
                Country: components.AddressInputCountryAlpha2InputUs,
            },
            Locale: polargo.Pointer("en"),
            OrganizationID: polargo.Pointer("1dbfc517-0bbf-4301-9ba8-555ca42b9737"),
            Owner: &components.MemberOwnerCreate{
                Email: "member@example.com",
                Name: polargo.Pointer("Jane Doe"),
                ExternalID: polargo.Pointer("usr_1337"),
            },
            Email: "customer@example.com",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Customer != nil {
        switch res.Customer.Type {
            case components.CustomerUnionTypeIndividual:
                // res.Customer.CustomerIndividual is populated
            case components.CustomerUnionTypeTeam:
                // res.Customer.CustomerTeam is populated
        }

    }
}

import polar_sdk
from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.customers.create(request={
        "external_id": "usr_1337",
        "name": "John Doe",
        "billing_address": {
            "country": polar_sdk.AddressInputCountryAlpha2Input.US,
        },
        "locale": "en",
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        "owner": None,
        "type": "team",
        "email": "customer@example.com",
    })

    # Handle response
    print(res)

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.customers.create({
    externalId: "usr_1337",
    name: "John Doe",
    billingAddress: {
      country: "US",
    },
    locale: "en",
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    owner: {
      email: "member@example.com",
      name: "Jane Doe",
      externalId: "usr_1337",
    },
    type: "individual",
    email: "customer@example.com",
  });

  console.log(result);
}

run();

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\CustomerIndividualCreate(
    externalId: 'usr_1337',
    name: 'John Doe',
    billingAddress: new Components\AddressInput(
        country: Components\AddressInputCountryAlpha2Input::Us,
    ),
    locale: 'en',
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    owner: new Components\MemberOwnerCreate(
        email: 'member@example.com',
        name: 'Jane Doe',
        externalId: 'usr_1337',
    ),
    email: 'customer@example.com',
);

$response = $sdk->customers->create(
    request: $request
);

if ($response->customer !== null) {
    // handle response
}

curl --request POST \
  --url https://api.polar.sh/v1/customers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "metadata": {},
  "external_id": "usr_1337",
  "name": "John Doe",
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "tax_id": "<string>",
  "locale": "en",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "owner": {
    "email": "jsmith@example.com",
    "name": "Jane Doe",
    "external_id": "usr_1337"
  },
  "type": "individual"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'jsmith@example.com',
    metadata: {},
    external_id: 'usr_1337',
    name: 'John Doe',
    billing_address: {
      line1: '<string>',
      line2: '<string>',
      postal_code: '<string>',
      city: '<string>',
      state: '<string>'
    },
    tax_id: '<string>',
    locale: 'en',
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    owner: {email: 'jsmith@example.com', name: 'Jane Doe', external_id: 'usr_1337'},
    type: 'individual'
  })
};

fetch('https://api.polar.sh/v1/customers/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/customers/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"external_id\": \"usr_1337\",\n  \"name\": \"John Doe\",\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_id\": \"<string>\",\n  \"locale\": \"en\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"owner\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": \"Jane Doe\",\n    \"external_id\": \"usr_1337\"\n  },\n  \"type\": \"individual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/customers/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"external_id\": \"usr_1337\",\n  \"name\": \"John Doe\",\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_id\": \"<string>\",\n  \"locale\": \"en\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"owner\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": \"Jane Doe\",\n    \"external_id\": \"usr_1337\"\n  },\n  \"type\": \"individual\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "email": "<string>",
  "email_verified": true,
  "type": "<string>",
  "name": "John Doe",
  "billing_name": "John Doe",
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "tax_id": {
    "[0]": "<string>"
  },
  "organization_id": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "avatar_url": "<string>",
  "external_id": "usr_1337",
  "locale": "<string>",
  "default_payment_method_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

CustomerIndividualCreate
CustomerTeamCreate

string<email>

required

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

Example:

"customer@example.com"

metadata

Metadata · object

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

A string with a maximum length of 500 characters
An integer
A floating-point number
A boolean

You can store up to 50 key-value pairs.

Show child attributes

external_id

string | null

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"

name

string | null

The name of the customer.

Maximum string length: 256

Example:

"John Doe"

billing_address

AddressInput · object | null

Show child attributes

tax_id

string | null

locale

string | null

Locale of the customer, given as an IETF BCP 47 language tag. Supported: language code (e.g. en) or language + region (e.g. en-US). If null or unsupported, the locale will default to en.

Pattern: ^[a-zA-Z]{2,3}(-[a-zA-Z]{2}|-[0-9]{3})?$

Example:

"en"

organization_id

string<uuid4> | null

The organization ID.

Example:

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

owner

MemberOwnerCreate · object | null

Optional owner member to create with the customer. If not provided, an owner member will be automatically created using the customer's email and name.

Show child attributes

type

string

default:individual

Allowed value: "individual"

Response

Customer created.

CustomerIndividual
CustomerTeam

A customer in an organization.

string<uuid4>

required

The ID of the customer.

Example:

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

created_at

string<date-time>

required

Creation timestamp of the object.

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

metadata

object

required

Show child attributes

string

required

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

Example:

"customer@example.com"

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

type

string

required

The type of customer.

Allowed value: "individual"

Example:

"individual"

name

string | null

required

The name of the customer.

Example:

"John Doe"

billing_name

string | null

required

The name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.

Example:

"John Doe"

billing_address

Address · object | null

required

Show child attributes

tax_id

Tax Id · object | null

required

Show child attributes

organization_id

string<uuid4>

required

The ID of the organization owning the customer.

Example:

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

deleted_at

string<date-time> | null

required

Timestamp for when the customer was soft deleted.

avatar_url

string

required

Example:

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

external_id

string | null

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"

locale

string | null

default_payment_method_id

string<uuid4> | null

The ID of the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.

Get CustomerGet a customer by ID. **Scopes**: `customers:read` `customers:write`

⌘I

Go (SDK)

package main

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

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

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

    res, err := s.Customers.Create(ctx, components.CreateCustomerCreateCustomerIndividualCreate(
        components.CustomerIndividualCreate{
            ExternalID: polargo.Pointer("usr_1337"),
            Name: polargo.Pointer("John Doe"),
            BillingAddress: &components.AddressInput{
                Country: components.AddressInputCountryAlpha2InputUs,
            },
            Locale: polargo.Pointer("en"),
            OrganizationID: polargo.Pointer("1dbfc517-0bbf-4301-9ba8-555ca42b9737"),
            Owner: &components.MemberOwnerCreate{
                Email: "member@example.com",
                Name: polargo.Pointer("Jane Doe"),
                ExternalID: polargo.Pointer("usr_1337"),
            },
            Email: "customer@example.com",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Customer != nil {
        switch res.Customer.Type {
            case components.CustomerUnionTypeIndividual:
                // res.Customer.CustomerIndividual is populated
            case components.CustomerUnionTypeTeam:
                // res.Customer.CustomerTeam is populated
        }

    }
}

import polar_sdk
from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.customers.create(request={
        "external_id": "usr_1337",
        "name": "John Doe",
        "billing_address": {
            "country": polar_sdk.AddressInputCountryAlpha2Input.US,
        },
        "locale": "en",
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        "owner": None,
        "type": "team",
        "email": "customer@example.com",
    })

    # Handle response
    print(res)

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.customers.create({
    externalId: "usr_1337",
    name: "John Doe",
    billingAddress: {
      country: "US",
    },
    locale: "en",
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    owner: {
      email: "member@example.com",
      name: "Jane Doe",
      externalId: "usr_1337",
    },
    type: "individual",
    email: "customer@example.com",
  });

  console.log(result);
}

run();

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\CustomerIndividualCreate(
    externalId: 'usr_1337',
    name: 'John Doe',
    billingAddress: new Components\AddressInput(
        country: Components\AddressInputCountryAlpha2Input::Us,
    ),
    locale: 'en',
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    owner: new Components\MemberOwnerCreate(
        email: 'member@example.com',
        name: 'Jane Doe',
        externalId: 'usr_1337',
    ),
    email: 'customer@example.com',
);

$response = $sdk->customers->create(
    request: $request
);

if ($response->customer !== null) {
    // handle response
}

curl --request POST \
  --url https://api.polar.sh/v1/customers/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "metadata": {},
  "external_id": "usr_1337",
  "name": "John Doe",
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "tax_id": "<string>",
  "locale": "en",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "owner": {
    "email": "jsmith@example.com",
    "name": "Jane Doe",
    "external_id": "usr_1337"
  },
  "type": "individual"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'jsmith@example.com',
    metadata: {},
    external_id: 'usr_1337',
    name: 'John Doe',
    billing_address: {
      line1: '<string>',
      line2: '<string>',
      postal_code: '<string>',
      city: '<string>',
      state: '<string>'
    },
    tax_id: '<string>',
    locale: 'en',
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    owner: {email: 'jsmith@example.com', name: 'Jane Doe', external_id: 'usr_1337'},
    type: 'individual'
  })
};

fetch('https://api.polar.sh/v1/customers/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/customers/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"external_id\": \"usr_1337\",\n  \"name\": \"John Doe\",\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_id\": \"<string>\",\n  \"locale\": \"en\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"owner\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": \"Jane Doe\",\n    \"external_id\": \"usr_1337\"\n  },\n  \"type\": \"individual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/customers/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"external_id\": \"usr_1337\",\n  \"name\": \"John Doe\",\n  \"billing_address\": {\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_id\": \"<string>\",\n  \"locale\": \"en\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"owner\": {\n    \"email\": \"jsmith@example.com\",\n    \"name\": \"Jane Doe\",\n    \"external_id\": \"usr_1337\"\n  },\n  \"type\": \"individual\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "email": "<string>",
  "email_verified": true,
  "type": "<string>",
  "name": "John Doe",
  "billing_name": "John Doe",
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "tax_id": {
    "[0]": "<string>"
  },
  "organization_id": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "avatar_url": "<string>",
  "external_id": "usr_1337",
  "locale": "<string>",
  "default_payment_method_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Create Customer

Authorizations

Body

Response