Skip to main content
POST
/
organizations
/
{id}
/
billing-addresses
Add Organization Billing Address
curl --request POST \
  --url https://{deploymentHost}/organizations/{id}/billing-addresses \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "company": "<string>",
  "address_line_1": "<string>",
  "address_line_2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postal_code": "<string>",
  "country": "<string>",
  "is_default": true
}'
{
  "status": 201,
  "message": "",
  "data": {
    "billing_address": {
      "id": "billing_123456789",
      "name": "New Office Location",
      "company": "Acme Corporation",
      "address_line_1": "789 New Street",
      "address_line_2": "Floor 3",
      "city": "Los Angeles",
      "state": "CA",
      "postal_code": "90210",
      "country": "US",
      "is_default": false,
      "created_at": "2024-01-15T19:30:00Z",
      "updated_at": "2024-01-15T19:30:00Z"
    }
  },
  "session": {
    "signin_attempts": [],
    "signins": [
      {
        "id": "signin_987654321",
        "user_id": "user_456789123",
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "signup_attempts": [],
    "active_signin": {
      "id": "signin_987654321",
      "user_id": "user_456789123",
      "created_at": "2024-01-01T12:00:00Z"
    }
  },
  "errors": []
}

Authorizations

​
__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Path Parameters

​
id
string
required

Organization ID

Body

application/json
​
name
string
required

Display name for the billing address

​
company
string
required

Company name

​
address_line_1
string
required

Primary address line

​
city
string
required

City

​
state
string
required

State or province

​
postal_code
string
required

Postal or ZIP code

​
country
string
required

Country code (ISO 3166-1 alpha-2)

​
address_line_2
string

Secondary address line (optional)

​
is_default
boolean

Whether this should be the default billing address

Response

Billing address added successfully

​
status
integer
required

HTTP status code

​
message
string
required

Response message (empty for success)

​
data
any
required

Response data (can be any type)

​
session
object
required
​
errors
object[]
required

Array of error objects (empty for success)