Plans

2 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

My plan & limits

plans.getread

The plan this account is on and every limit it carries — caps like phone numbers and seats, and on/off features like ringless voicemail or the MCP server — with where the plan came from (bought by the owner, pinned by a platform admin, or inherited from a parent agency) and any limit bent for this account specifically. Read-only; nothing is charged.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/plans.get \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Test with your API key

Over MCP the same operation is the tool plans_get at https://app.chirply.io/api/mcp, same bearer token, same input.

Plan usage

plans.usageread

How much of each countable limit this account has used — phone numbers, seats, funnels, workflows, AI agents and so on — with the cap beside it and whether there's room for another. Use this before creating something to know whether it will be refused. Read-only.

Parameters

Field	Type	Required	Description
at_limit_only	boolean	optional	Return only the limits that are already full. Default: false

Example

curl -X POST https://app.chirply.io/api/v1/actions/plans.usage \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "at_limit_only": false
  }'

Test with your API key

Over MCP the same operation is the tool plans_usage at https://app.chirply.io/api/mcp, same bearer token, same input.