Save the billing address

Set or change the billing address. Use this when billing details change. A user has one billing address: the first call creates it and later calls replace it. The name on the address is taken from the user's profile. With signup_business_id, when that signup business allows it, its location's phone, address, city and postal code are set to the same values.

Prerequisites: a bearer token, the user's id (user_id) from List users, and a city_id from List cities.

Authentication: Partner or Account token. user_id must be a user inside your own account tree; otherwise 422.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 3011

The user the address is for. Must exist and be inside your account tree.

string
required
length ≤ 255
Defaults to Acme Corp

Company name on the bill. Up to 255 characters. Can't contain < or >.

string
required

Billing email address. The domain must accept mail (it's checked with a DNS lookup), so test domains like example.com are rejected with 422.

string | null
Defaults to +15555550100

Billing phone number. Up to 20 characters.

string
required
length ≤ 255
Defaults to 123 Main St

Street address. Up to 255 characters. Can't contain < or >.

string
required
length between 3 and 10
Defaults to 90210

Postal code. 3 to 10 characters.

integer
required
Defaults to 456

The city. Must exist.

integer | null
Defaults to null

A signup business id. Must exist. When that signup business allows it, its location gets the same phone, address, city and postal code.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json