Organization settings
Get settings
Users should be able to get their organization settings
GET
/
organization
/
settings
Organization settings
curl --request GET \
--url https://api.beyondwords.io/v1/organization/settings \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.beyondwords.io/v1/organization/settings"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.beyondwords.io/v1/organization/settings', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.beyondwords.io/v1/organization/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.beyondwords.io/v1/organization/settings")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/organization/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
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": {}
}Was this page helpful?
⌘I
Organization settings
curl --request GET \
--url https://api.beyondwords.io/v1/organization/settings \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.beyondwords.io/v1/organization/settings"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.beyondwords.io/v1/organization/settings', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.beyondwords.io/v1/organization/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.beyondwords.io/v1/organization/settings")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/organization/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
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": {}
}