Skip to content

Latest commit

 

History

History
31 lines (26 loc) · 11.6 KB

customerupdate.md

File metadata and controls

31 lines (26 loc) · 11.6 KB

CustomerUpdate

Example Usage

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

let value: CustomerUpdate = {
  externalId: "usr_1337",
  email: "[email protected]",
  name: "John Doe",
  billingAddress: {
    country: "SE",
  },
  taxId: [
    "911144442",
    "us_ein",
  ],
};

Fields

Field Type Required Description Example
metadata Record<string, components.CustomerUpdateMetadata> ➖ 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.CustomerUpdateTaxId[] ➖ N/A [
"911144442",
"us_ein"
]