Get billing status

GET/api/promptly/billing/status

Retrieve current subscription and usage information

Query ParametersExpand Collapse

organizationId: string

formatuuid

ReturnsExpand Collapse

billingPeriodStart: optional string

formatdate-time

plan: optional "free" or "paid"

Accepts one of the following:

"free"

"paid"

runsLimit: optional number

Maximum runs allowed (null for unlimited)

runsUsed: optional number

Task runs used this billing period

stripeCustomerId: optional string

stripeSubscriptionId: optional string

tasksCount: optional number

Current number of active tasks

tasksLimit: optional number

Maximum tasks allowed

usageCostCents: optional number

Usage-based charges this period

usageCreditsCents: optional number

Usage credits included in plan

usersCount: optional number

usersLimit: optional number

Get billing status

curl https://0ct.com/api/promptly/billing/status \
    -H "Authorization: Bearer $0CT_API_KEY"

{
  "billingPeriodStart": "2019-12-27T18:11:19.117Z",
  "plan": "free",
  "runsLimit": 0,
  "runsUsed": 0,
  "stripeCustomerId": "stripeCustomerId",
  "stripeSubscriptionId": "stripeSubscriptionId",
  "tasksCount": 0,
  "tasksLimit": 0,
  "usageCostCents": 0,
  "usageCreditsCents": 0,
  "usersCount": 0,
  "usersLimit": 0
}

Returns Examples

{
  "billingPeriodStart": "2019-12-27T18:11:19.117Z",
  "plan": "free",
  "runsLimit": 0,
  "runsUsed": 0,
  "stripeCustomerId": "stripeCustomerId",
  "stripeSubscriptionId": "stripeSubscriptionId",
  "tasksCount": 0,
  "tasksLimit": 0,
  "usageCostCents": 0,
  "usageCreditsCents": 0,
  "usersCount": 0,
  "usersLimit": 0
}