Skip to main content
PATCH
/
api
/
v2
/
external
/
orgs
/
{slug}
Update Org
curl --request PATCH \
  --url https://api.example.com/api/v2/external/orgs/{slug} \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_company_name": "<string>",
  "billing_address_line1": "<string>",
  "billing_address_line2": "<string>",
  "billing_city": "<string>",
  "billing_state": "<string>",
  "billing_postal_code": "<string>",
  "billing_country": "<string>",
  "billing_tax_id": "<string>",
  "billing_tax_id_type": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "billing_email": "jsmith@example.com"
}
'
{
  "slug": "<string>",
  "name": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "billing_email": "<string>",
  "billing_details": {
    "billing_company_name": "<string>",
    "billing_address_line1": "<string>",
    "billing_address_line2": "<string>",
    "billing_city": "<string>",
    "billing_state": "<string>",
    "billing_postal_code": "<string>",
    "billing_country": "<string>",
    "billing_tax_id": "<string>",
    "billing_tax_id_type": "<string>"
  }
}

Path Parameters

​
slug
string
required

Body

application/json

Partial update. All fields optional — only set ones get applied.

Inherits the billing_* company-detail fields from OrgBillingDetailsPatch.

​
billing_company_name
string | null
Maximum string length: 255
​
billing_address_line1
string | null
Maximum string length: 255
​
billing_address_line2
string | null
Maximum string length: 255
​
billing_city
string | null
Maximum string length: 128
​
billing_state
string | null
Maximum string length: 128
​
billing_postal_code
string | null
Maximum string length: 32
​
billing_country
string | null
Maximum string length: 2
​
billing_tax_id
string | null
Maximum string length: 64
​
billing_tax_id_type
string | null
Maximum string length: 32
​
name
string | null
Required string length: 1 - 100
​
slug
string | null
Required string length: 1 - 64
Pattern: ^[a-z0-9][a-z0-9-]*$
​
billing_email
string<email> | null

Response

Successful Response

​
slug
string
required
Required string length: 1 - 64
Pattern: ^[a-z0-9][a-z0-9-]*$
​
name
string
required
Required string length: 1 - 100
​
id
string
required
​
created_at
string<date-time>
required
​
billing_email
string | null
​
billing_details
OrgBillingDetails · object

An org's company billing details (stored in org_billing_details, 1:1 with the org). Synced onto the Stripe customer at checkout so they render on the generated invoice (Bill to / VAT). All optional — an org with none set falls back to Stripe's default (customer email only).