Upgrade Link

Get a URL an AI agent can hand to a human to upgrade the plan or add a payment method via GET /v1/billing/upgrade-link. Never charges; human-in-the-loop.

The upgrade-link endpoint (GET /v1/billing/upgrade-link) returns a URL an AI agent can hand to a human to upgrade the organization's plan or add a payment method. Plan changes and payment are deliberately a human-in-the-loop step, so this endpoint never charges anything: it returns a deep link into the dashboard billing settings plus a flag indicating a human is required.

Use it when an agent hits a wall it cannot resolve on its own: the credit balance is exhausted and auto top-up is not enabled, or the current API tier is too limiting for the workload. Instead of failing silently, the agent fetches this link and presents it to its operator with the returned message. It requires an API key with the read scope.

Response

{
  "url": "https://app.talonic.com/settings/billing?upgrade=1",
  "provider": "dashboard",
  "requires_human": true,
  "message": "Open this link to upgrade your plan or add payment. A human must complete the upgrade.",
  "links": {
    "self": "/v1/billing/upgrade-link",
    "billing_settings": "/v1/billing/settings",
    "credits": "/v1/credits/balance"
  }
}

Errors