Skip to content
POST/api/v1/chargeback

Replace a project's chargeback allocation rules

Atomically replaces the project's allocation_rules with the supplied set (min 1 rule; use DELETE to clear all). projectId + rules required.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "rules": [
    {
      "costCenter": "string",
      "type": "direct",
      "percentage": 0,
      "weight": 0,
      "targets": [
        {
          "costCenter": "string",
          "weight": 0,
          "percentage": 0
        }
      ],
      "filterModel": "string",
      "filterTeam": "string"
    }
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "rules": {
          "minItems": 1,
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "costCenter": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "type": {
                "type": "string",
                "enum": [
                  "direct",
                  "proportional",
                  "weighted"
                ]
              },
              "percentage": {
                "type": "number",
                "minimum": 0,
                "maximum": 100
              },
              "weight": {
                "type": "number",
                "minimum": 0
              },
              "targets": {
                "maxItems": 50,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "costCenter": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "weight": {
                      "type": "number",
                      "minimum": 0
                    },
                    "percentage": {
                      "type": "number",
                      "minimum": 0,
                      "maximum": 100
                    }
                  },
                  "required": [
                    "costCenter"
                  ],
                  "additionalProperties": false
                }
              },
              "filterModel": {
                "nullable": true,
                "type": "string",
                "maxLength": 120
              },
              "filterTeam": {
                "nullable": true,
                "type": "string",
                "maxLength": 120
              }
            },
            "required": [
              "costCenter"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "projectId",
        "rules"
      ],
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Allocation rules updated.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/chargeback \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "rules": [ { "costCenter": "string", "type": "direct", "percentage": 0, "weight": 0, "targets": [ { "costCenter": "string", "weight": 0, "percentage": 0 } ], "filterModel": "string", "filterTeam": "string" } ] }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/chargeback",
  body: {
    "projectId": "00000000-0000-0000-0000-000000000000",
    "rules": [
      {
        "costCenter": "string",
        "type": "direct",
        "percentage": 0,
        "weight": 0,
        "targets": [
          {
            "costCenter": "string",
            "weight": 0,
            "percentage": 0
          }
        ],
        "filterModel": "string",
        "filterTeam": "string"
      }
    ]
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/chargeback",
    body={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "rules": [
        {
            "costCenter": "string",
            "type": "direct",
            "percentage": 0,
            "weight": 0,
            "targets": [
                {
                    "costCenter": "string",
                    "weight": 0,
                    "percentage": 0
                }
            ],
            "filterModel": "string",
            "filterTeam": "string"
        }
    ]
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"projectId":"00000000-0000-0000-0000-000000000000","rules":[{"costCenter":"string","type":"direct","percentage":0,"weight":0,"targets":[{"costCenter":"string","weight":0,"percentage":0}],"filterModel":"string","filterTeam":"string"}]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/chargeback", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401429

Other Cost & FinOps endpoints