Update a tenant

Use when changing tenant details (e.g. name or billing info). Request body contains the fields to update.

PUT /tenants/update

Update a tenant

cURL

curl --request PUT \
  --url https://us.api.flexprice.io/v1/tenants/update \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "billing_details": {
    "address": {
      "address_city": "<string>",
      "address_country": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "address_postal_code": "<string>",
      "address_state": "<string>"
    },
    "email": "<string>",
    "help_email": "<string>",
    "phone": "<string>"
  },
  "metadata": {},
  "name": "<string>"
}
'

import requests

url = "https://us.api.flexprice.io/v1/tenants/update"

payload = {
    "billing_details": {
        "address": {
            "address_city": "<string>",
            "address_country": "<string>",
            "address_line1": "<string>",
            "address_line2": "<string>",
            "address_postal_code": "<string>",
            "address_state": "<string>"
        },
        "email": "<string>",
        "help_email": "<string>",
        "phone": "<string>"
    },
    "metadata": {},
    "name": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billing_details: {
      address: {
        address_city: '<string>',
        address_country: '<string>',
        address_line1: '<string>',
        address_line2: '<string>',
        address_postal_code: '<string>',
        address_state: '<string>'
      },
      email: '<string>',
      help_email: '<string>',
      phone: '<string>'
    },
    metadata: {},
    name: '<string>'
  })
};

fetch('https://us.api.flexprice.io/v1/tenants/update', 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://us.api.flexprice.io/v1/tenants/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'billing_details' => [
        'address' => [
                'address_city' => '<string>',
                'address_country' => '<string>',
                'address_line1' => '<string>',
                'address_line2' => '<string>',
                'address_postal_code' => '<string>',
                'address_state' => '<string>'
        ],
        'email' => '<string>',
        'help_email' => '<string>',
        'phone' => '<string>'
    ],
    'metadata' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://us.api.flexprice.io/v1/tenants/update"

	payload := strings.NewReader("{\n  \"billing_details\": {\n    \"address\": {\n      \"address_city\": \"<string>\",\n      \"address_country\": \"<string>\",\n      \"address_line1\": \"<string>\",\n      \"address_line2\": \"<string>\",\n      \"address_postal_code\": \"<string>\",\n      \"address_state\": \"<string>\"\n    },\n    \"email\": \"<string>\",\n    \"help_email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.put("https://us.api.flexprice.io/v1/tenants/update")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_details\": {\n    \"address\": {\n      \"address_city\": \"<string>\",\n      \"address_country\": \"<string>\",\n      \"address_line1\": \"<string>\",\n      \"address_line2\": \"<string>\",\n      \"address_postal_code\": \"<string>\",\n      \"address_state\": \"<string>\"\n    },\n    \"email\": \"<string>\",\n    \"help_email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/tenants/update")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_details\": {\n    \"address\": {\n      \"address_city\": \"<string>\",\n      \"address_country\": \"<string>\",\n      \"address_line1\": \"<string>\",\n      \"address_line2\": \"<string>\",\n      \"address_postal_code\": \"<string>\",\n      \"address_state\": \"<string>\"\n    },\n    \"email\": \"<string>\",\n    \"help_email\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "billing_details": {
    "address": {
      "address_city": "<string>",
      "address_country": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "address_postal_code": "<string>",
      "address_state": "<string>"
    },
    "email": "<string>",
    "help_email": "<string>",
    "phone": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Update tenant request

billing_details · object

Show child attributes

metadata · object

Show child attributes

name · string

Response

200

application/json

Updated tenant

billing_details · object

Show child attributes

created_at · string<date-time>

id · string

metadata · object

Show child attributes

name · string

status · string

updated_at · string<date-time>