Billing

Reorder billing priorities

resourceIds is the complete list in highest-first order. Project order includes every active project; customer and number orders include every active customer or real number in projectId. Use scope=resource with projectId and a complete resources array of {scope: customer or number, resourceId} for one mixed leaderboard. Saves the whole order atomically. Concurrent changes or an incomplete list return 409. Retrying the same successful order is harmless. 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

priorities

Reorder billing priorities

curl --request PUT \
  --url https://api.polymorfa.com/platform/billing/priorities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "resource",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resources": [
    {
      "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "expectedRevision": 1073741823
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scope: 'resource',
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    resources: [{resourceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
    expectedRevision: 1073741823
  })
};

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

import requests

url = "https://api.polymorfa.com/platform/billing/priorities"

payload = {
    "scope": "resource",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "resources": [{ "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
    "expectedRevision": 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/priorities"

	payload := strings.NewReader("{\n  \"scope\": \"resource\",\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"resources\": [\n    {\n      \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"expectedRevision\": 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": {
    "revision": 1073741823,
    "projects": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "priority": 500000
      }
    ],
    "customers": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "priority": 500000
      }
    ],
    "numbers": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "priority": 500000
      }
    ]
  }
}

{
  "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.

Body

application/json

Option 1
Option 2
Option 3

scope

enum<string>

required

Specifies scope for this one of.

Allowed values

Value	Meaning
`resource`	Resource.

Available options:

resource

projectId

string<uuid>

required

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

resources

object[]

required

Resources associated with this one of.

Value constraints

Constraint	Accepted input
Array size	At most `1000000` items
Duplicates	Not accepted; every array item must be unique

Maximum array length: 1000000

Show child attributes

expectedRevision

integer

required

Specifies expected revision for this one of.

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

Reorder billing priorities

curl --request PUT \
  --url https://api.polymorfa.com/platform/billing/priorities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "resource",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resources": [
    {
      "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "expectedRevision": 1073741823
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scope: 'resource',
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    resources: [{resourceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
    expectedRevision: 1073741823
  })
};

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

import requests

url = "https://api.polymorfa.com/platform/billing/priorities"

payload = {
    "scope": "resource",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "resources": [{ "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }],
    "expectedRevision": 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/priorities"

	payload := strings.NewReader("{\n  \"scope\": \"resource\",\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"resources\": [\n    {\n      \"resourceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"expectedRevision\": 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": {
    "revision": 1073741823,
    "projects": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "priority": 500000
      }
    ],
    "customers": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "priority": 500000
      }
    ],
    "numbers": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "priority": 500000
      }
    ]
  }
}

{
  "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

Reorder billing priorities

Authorizations

Body

Response