Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json
first_name
string
required
Maximum string length: 255
last_name
string
required
Maximum string length: 255
email
string<email>
required
Maximum string length: 255
street_line_1
string
required
Maximum string length: 255
city
string
required
Maximum string length: 255
region
string
required

A Squire region id, such as ca-on.

postal_code
string
required

A postal code has at most 12 characters, which the column holds.

Maximum string length: 12
country
string
required

A Squire country id, such as ca.

company_name
string | null
Maximum string length: 255
phone
string | null
Maximum string length: 255
street_line_2
string | null
Maximum string length: 255

Response

BillingAddressResource

data
BillingAddressResource · object
required