Billing

Set resource billing controls

Saves the monthly limit and priority together, atomically. Both observed revisions are required. Conflicts leave both settings unchanged. Null removes a limit; zero blocks new charges. Existing paid service continues. Requires an organization API key with the stated billing scope, or a signed-in team owner or admin. Project and client credentials cannot access these controls. Billing must be configured. Writes require Pay-As-You-Go. These controls never enable charging of unpriced usage.

Requires a team API key with billing:manage. Project tokens are not accepted.

PUT

platform

billing

controls

{scope}

{resourceId}

Set resource billing controls

curl --request PUT \
  --url https://api.polymorfa.com/platform/billing/controls/{scope}/{resourceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limitCredits": 500000,
  "priority": 500000,
  "expectedBudgetRevision": 1073741823,
  "expectedPriorityRevision": 1073741823
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    limitCredits: 500000,
    priority: 500000,
    expectedBudgetRevision: 1073741823,
    expectedPriorityRevision: 1073741823
  })
};

fetch('https://api.polymorfa.com/platform/billing/controls/{scope}/{resourceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/billing/controls/{scope}/{resourceId}"

payload = {
    "limitCredits": 500000,
    "priority": 500000,
    "expectedBudgetRevision": 1073741823,
    "expectedPriorityRevision": 1073741823
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/billing/controls/{scope}/{resourceId}"

	payload := strings.NewReader("{\n  \"limitCredits\": 500000,\n  \"priority\": 500000,\n  \"expectedBudgetRevision\": 1073741823,\n  \"expectedPriorityRevision\": 1073741823\n}")

	req, _ := http.NewRequest("PUT", 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))

}

{
  "data": {
    "budget": {
      "scope": "project",
      "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "limitCredits": 500000,
      "spentCredits": 1,
      "reservedCredits": 1,
      "revision": 1073741823
    },
    "priority": 500000,
    "priorityRevision": 1073741823
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Path Parameters

scope

enum<string>

required

Specifies scope for this path parameter.

Allowed values

Value	Meaning
`project`	Project.
`customer`	Customer.
`number`	Number.

Available options:

project,

customer,

number

resourceId

string<uuid>

required

Identifier of the resource affected by this event.

Value constraints

Constraint	Accepted input
Format	`uuid`

Body

application/json

limitCredits

number | null

required

Specifies limit credits for this schema.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `number`; Numeric value: `0` through `1000000` (inclusive); Increment: Multiple of `0.000001`
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Numeric value	`0` through `1000000` (inclusive)
Increment	Multiple of `0.000001`

Required range: 0 <= x <= 1000000Must be a multiple of 0.000001

priority

integer

required

Specifies priority for this schema.

Value constraints

Constraint	Accepted input
Numeric value	`0` through `1000000` (inclusive)

Required range: 0 <= x <= 1000000

expectedBudgetRevision

integer

required

Specifies expected budget revision for this schema.

Value constraints

Constraint	Accepted input
Numeric value	`0` through `2147483646` (inclusive)

Required range: 0 <= x <= 2147483646

expectedPriorityRevision

integer

required

Specifies expected priority revision for this schema.

Value constraints

Constraint	Accepted input
Numeric value	`0` through `2147483646` (inclusive)

Required range: 0 <= x <= 2147483646

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Set resource billing controls

curl --request PUT \
  --url https://api.polymorfa.com/platform/billing/controls/{scope}/{resourceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limitCredits": 500000,
  "priority": 500000,
  "expectedBudgetRevision": 1073741823,
  "expectedPriorityRevision": 1073741823
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    limitCredits: 500000,
    priority: 500000,
    expectedBudgetRevision: 1073741823,
    expectedPriorityRevision: 1073741823
  })
};

fetch('https://api.polymorfa.com/platform/billing/controls/{scope}/{resourceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/billing/controls/{scope}/{resourceId}"

payload = {
    "limitCredits": 500000,
    "priority": 500000,
    "expectedBudgetRevision": 1073741823,
    "expectedPriorityRevision": 1073741823
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/billing/controls/{scope}/{resourceId}"

	payload := strings.NewReader("{\n  \"limitCredits\": 500000,\n  \"priority\": 500000,\n  \"expectedBudgetRevision\": 1073741823,\n  \"expectedPriorityRevision\": 1073741823\n}")

	req, _ := http.NewRequest("PUT", 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))

}

{
  "data": {
    "budget": {
      "scope": "project",
      "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "limitCredits": 500000,
      "spentCredits": 1,
      "reservedCredits": 1,
      "revision": 1073741823
    },
    "priority": 500000,
    "priorityRevision": 1073741823
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Set resource billing controls

Authorizations

Path Parameters

Body

Response