Organization billing

The organization’s plan, subscription state, and usage against the plan’s limits.

GET/org/billing

Responses

200OK

planstringrequired

Allowed:freepaid

statusstring | anyrequired

Show properties

Any of:

string

string

any

any

seatsinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

periodEndstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

cancelAtPeriodEndbooleanrequired

usageobject[]required

Show properties

Array of object

featurestringrequired

Allowed:membersapiRequestsstorage

usedintegerrequired

min -9007199254740991 · max 9007199254740991

capinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

windowstring | anyrequired

Show properties

Any of:

string

string

any

any

401401

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Authentication required. Pass an organization API key in the `x-api-key` header."

dataany

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

429429

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "The organization's API request limit for this period has been reached."

dataany

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Too many requests. Try again shortly."

dataany

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

Request

curl -X GET "https://stetcms.com/api/v1/org/billing"

const response = await fetch("https://stetcms.com/api/v1/org/billing", {
  method: "GET"
});

Response

{
  "plan": "free",
  "status": "string",
  "seats": 0,
  "periodEnd": "2024-01-01T00:00:00Z",
  "cancelAtPeriodEnd": true,
  "usage": [
    {
      "feature": "members",
      "used": 0,
      "cap": 0,
      "window": "month"
    }
  ]
}