Skip to main content
PUT
/
organization
/
settings
/
quota
Update quota settings
curl --request PUT \
  --url https://api.beyondwords.io/v1/organization/settings/quota \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "content_overage_enabled": true,
  "content_overage_limit": 123
}
'
import requests

url = "https://api.beyondwords.io/v1/organization/settings/quota"

payload = {
"content_overage_enabled": True,
"content_overage_limit": 123
}
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({content_overage_enabled: true, content_overage_limit: 123})
};

fetch('https://api.beyondwords.io/v1/organization/settings/quota', 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.beyondwords.io/v1/organization/settings/quota",
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([
'content_overage_enabled' => true,
'content_overage_limit' => 123
]),
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://api.beyondwords.io/v1/organization/settings/quota"

payload := strings.NewReader("{\n \"content_overage_enabled\": true,\n \"content_overage_limit\": 123\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://api.beyondwords.io/v1/organization/settings/quota")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content_overage_enabled\": true,\n \"content_overage_limit\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/organization/settings/quota")

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 \"content_overage_enabled\": true,\n \"content_overage_limit\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "stripe": {
    "customer_id": "<string>",
    "plan_id": "<string>",
    "pending_plan_id": "<string>",
    "subscription_id": "<string>"
  },
  "plan": {
    "id": 123,
    "name": "<string>",
    "interval": "<string>",
    "currency": "<string>",
    "amount": 123,
    "permission": "<string>",
    "custom": true,
    "overage_enabled": true,
    "overage_billing_threshold": 123,
    "overage_price": 123,
    "promotion_codes": [
      {
        "type": "<string>",
        "value": 123
      }
    ]
  },
  "pending_plan": {
    "id": 123,
    "name": "<string>",
    "interval": "<string>",
    "currency": "<string>",
    "amount": 123,
    "permission": "<string>",
    "custom": true,
    "overage_enabled": true,
    "overage_billing_threshold": 123,
    "overage_price": 123,
    "promotion_codes": [
      {
        "type": "<string>",
        "value": 123
      }
    ]
  },
  "subscription": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "quota": {
    "type": "<string>",
    "interval": "<string>",
    "limit": 123,
    "content_overage_enabled": true,
    "content_overage_limit": 123,
    "remaining": 123,
    "used": 123,
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "features": {}
}

Authorizations

X-Api-Key
string
header
required

Body

application/json
content_overage_enabled
boolean

Overage articles enabled

content_overage_limit
integer | null

Overage articles limit

Response

200 - application/json

successful

stripe
object
plan
object
pending_plan
object | null
subscription
object
quota
object
features
object