Create a budget. - Spillway

POST

/

api

/

budgets

Create a budget.

curl --request POST \
  --url http://localhost:3000/api/budgets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "limitUsd": "<string>",
  "mode": "enforce",
  "onExceed": "block",
  "fallbackAlias": "<string>"
}
'

import requests

url = "http://localhost:3000/api/budgets"

payload = {
    "scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "limitUsd": "<string>",
    "mode": "enforce",
    "onExceed": "block",
    "fallbackAlias": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scopeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    limitUsd: '<string>',
    mode: 'enforce',
    onExceed: 'block',
    fallbackAlias: '<string>'
  })
};

fetch('http://localhost:3000/api/budgets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/budgets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scopeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'limitUsd' => '<string>',
    'mode' => 'enforce',
    'onExceed' => 'block',
    'fallbackAlias' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "http://localhost:3000/api/budgets"

	payload := strings.NewReader("{\n  \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limitUsd\": \"<string>\",\n  \"mode\": \"enforce\",\n  \"onExceed\": \"block\",\n  \"fallbackAlias\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("http://localhost:3000/api/budgets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limitUsd\": \"<string>\",\n  \"mode\": \"enforce\",\n  \"onExceed\": \"block\",\n  \"fallbackAlias\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/budgets")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limitUsd\": \"<string>\",\n  \"mode\": \"enforce\",\n  \"onExceed\": \"block\",\n  \"fallbackAlias\": \"<string>\"\n}"

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

{}

{
  "error": {
    "code": "budget_exceeded",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

WorkOS session access token (human dashboard sessions) on the control plane.

Headers

X-Spillway-Org

string<uuid>

Example:

"601c5d19-0b88-42f7-acda-d1d31abd100d"

Body

application/json

scopeType

enum<string>

required

Available options:

org,

team,

virtual_key,

provider

scopeId

string<uuid>

required

period

enum<string>

required

Available options:

day,

month,

rolling_30d

limitUsd

string

required

Pattern: ^\d{1,8}(\.\d{1,6})?$

mode

enum<string>

default:enforce

Available options:

enforce,

alert,

monitor

onExceed

enum<string>

default:block

Available options:

block,

fallback

fallbackAlias

string | null

Required string length: 1 - 120

Response

OK

Resource object.

{key}

any

Create a budget.

curl --request POST \
  --url http://localhost:3000/api/budgets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "limitUsd": "<string>",
  "mode": "enforce",
  "onExceed": "block",
  "fallbackAlias": "<string>"
}
'

import requests

url = "http://localhost:3000/api/budgets"

payload = {
    "scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "limitUsd": "<string>",
    "mode": "enforce",
    "onExceed": "block",
    "fallbackAlias": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scopeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    limitUsd: '<string>',
    mode: 'enforce',
    onExceed: 'block',
    fallbackAlias: '<string>'
  })
};

fetch('http://localhost:3000/api/budgets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/budgets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scopeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'limitUsd' => '<string>',
    'mode' => 'enforce',
    'onExceed' => 'block',
    'fallbackAlias' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "http://localhost:3000/api/budgets"

	payload := strings.NewReader("{\n  \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limitUsd\": \"<string>\",\n  \"mode\": \"enforce\",\n  \"onExceed\": \"block\",\n  \"fallbackAlias\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("http://localhost:3000/api/budgets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limitUsd\": \"<string>\",\n  \"mode\": \"enforce\",\n  \"onExceed\": \"block\",\n  \"fallbackAlias\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/budgets")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scopeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"limitUsd\": \"<string>\",\n  \"mode\": \"enforce\",\n  \"onExceed\": \"block\",\n  \"fallbackAlias\": \"<string>\"\n}"

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

{}

{
  "error": {
    "code": "budget_exceeded",
    "message": "<string>",
    "details": {}
  }
}