Credits

5 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.

Buy credits

credits.buywriteconfirmadmin only

Immediately charges this workspace's SAVED card for prepaid usage credits — real money, billed off-session by your provider on THEIR OWN Stripe account (Chirply never holds the funds) — and adds the amount to your credit balance once Stripe confirms the charge settled, which also resumes sends paused for running out. Between $5 and $2,000 per purchase. There is no undo — reversing it means your provider issuing a refund. Fails without charging when no card is saved yet (see credits.start_card_setup).

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Field	Type	Required	Description
amount_dollars	number	required	Dollars to charge your saved card and credit to the balance, e.g. 50. Whole cents only.

Example

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

Test with your API key

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

Finish saving the card

credits.complete_card_setupwriteadmin only

Verify a confirmed SetupIntent with your provider's Stripe and record the resulting payment method as this workspace's saved card for credit top-ups and auto-recharge. Refuses unless Stripe itself reports the setup succeeded for this workspace's customer. Moves no money.

Parameters

Field	Type	Required	Description
setup_intent_id	string	required	The SetupIntent id (seti_…) from credits.start_card_setup, after the card holder confirmed the Payment Element.

Example

curl -X POST https://app.chirply.io/api/v1/actions/credits.complete_card_setup \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "setup_intent_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

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

My credits

credits.get_balanceread

Your account's prepaid credit balance for usage that runs on your provider's pooled account (calls, texts, email, AI, leads). Shows your remaining balance, any monthly allowance, whether you're paused for running out, your per-item prices, and recent activity. Read-only.

Parameters

No parameters — POST an empty body.

Example

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

Test with your API key

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

Auto-recharge my credits

credits.set_auto_rechargewriteconfirmadmin only

Turn this workspace's own credit auto-recharge on or off and set its rules — the same settings as the Credits page. While on, whenever pooled usage drops your credit balance under the threshold, your SAVED card is automatically charged the recharge amount on your provider's own Stripe — unattended, real-money charges nobody clicks on, at most one attempt per 15 minutes. Turning it off clears the rules. Confirm-gated because saving these settings arms future charges.

Parameters

Field	Type	Required	Description
enabled	boolean	required	true arms auto-recharge; false disarms it (rules are cleared).
threshold_dollars	number	optional	Recharge when the spendable balance dips under this many dollars. Required when enabling.
amount_dollars	number	optional	Dollars to charge each time, $5–$2,000. Required when enabling.

Example

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

Test with your API key

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

Save or update card

credits.start_card_setupwriteadmin only

Begin saving a payment card for this workspace's own credit top-ups and auto-recharge. Creates (or reuses) a customer on YOUR PROVIDER's Stripe account and returns a SetupIntent client_secret plus their publishable key. No money moves and no card number ever passes through this call: the card itself is typed into a Stripe Payment Element rendered in a browser with those two values — Stripe's own secure form, the same one the Credits page embeds. After the card holder confirms the element, finish with credits.complete_card_setup.

Parameters

Field	Type	Required	Description
email	string (email)	optional	Billing email recorded on the Stripe customer created on the provider's account.
name	string	optional	Billing name for the Stripe customer (defaults to the account name).

Example

curl -X POST https://app.chirply.io/api/v1/actions/credits.start_card_setup \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ada@example.com",
    "name": "Example"
  }'

Test with your API key

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