Skip to content

Latest commit

 

History

History
33 lines (28 loc) · 13.1 KB

customercreate.md

File metadata and controls

33 lines (28 loc) · 13.1 KB

CustomerCreate

Example Usage

import { CustomerCreate } from "@polar-sh/sdk/models/components/customercreate.js";

let value: CustomerCreate = {
  externalId: "usr_1337",
  email: "[email protected]",
  name: "John Doe",
  billingAddress: {
    country: "US",
  },
  taxId: [
    "911144442",
    "us_ein",
  ],
  organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
};

Fields

Field Type Required Description Example
metadata Record<string, components.CustomerCreateMetadata> ➖ 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 boolean

You can store up to 50 key-value pairs.
externalId string ➖ The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. usr_1337
email string ✔️ The email address of the customer. This must be unique within the organization. [email protected]
name string ➖ The name of the customer. John Doe
billingAddress components.Address ➖ N/A
taxId components.CustomerCreateTaxId[] ➖ N/A [
"911144442",
"us_ein"
]
organizationId string ➖ The ID of the organization owning the customer. Required unless you use an organization token. 1dbfc517-0bbf-4301-9ba8-555ca42b9737