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"
}
'
import requests

url = "https://api.example.com/api/v2/external/orgs/{slug}"

payload = {
"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"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};

fetch('https://api.example.com/api/v2/external/orgs/{slug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v2/external/orgs/{slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v2/external/orgs/{slug}"

payload := strings.NewReader("{\n \"billing_company_name\": \"<string>\",\n \"billing_address_line1\": \"<string>\",\n \"billing_address_line2\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_state\": \"<string>\",\n \"billing_postal_code\": \"<string>\",\n \"billing_country\": \"<string>\",\n \"billing_tax_id\": \"<string>\",\n \"billing_tax_id_type\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"billing_email\": \"jsmith@example.com\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v2/external/orgs/{slug}")
.header("Content-Type", "application/json")
.body("{\n \"billing_company_name\": \"<string>\",\n \"billing_address_line1\": \"<string>\",\n \"billing_address_line2\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_state\": \"<string>\",\n \"billing_postal_code\": \"<string>\",\n \"billing_country\": \"<string>\",\n \"billing_tax_id\": \"<string>\",\n \"billing_tax_id_type\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"billing_email\": \"jsmith@example.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/external/orgs/{slug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"billing_company_name\": \"<string>\",\n \"billing_address_line1\": \"<string>\",\n \"billing_address_line2\": \"<string>\",\n \"billing_city\": \"<string>\",\n \"billing_state\": \"<string>\",\n \"billing_postal_code\": \"<string>\",\n \"billing_country\": \"<string>\",\n \"billing_tax_id\": \"<string>\",\n \"billing_tax_id_type\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"billing_email\": \"jsmith@example.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

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 | null

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).