Skip to docs content
Browse and search
On this page

get_payment_link

A link the person opens to pay what a subscription owes: its open invoice, its renewal in stablecoins, or, by card, an invoice waiting on a stablecoin payment. Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:billing scope.

POST/api/agent/actions/get_payment_link

Authorization

  • AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key: Bearer <key>.

Body

  • familyenum<string>required
  • targetenum<string>requiredinvoice: the open card invoice. renewal: the stablecoin payment of the open renewal. outstanding_invoice_card: pay by card an invoice waiting on a stablecoin payment.

Response fields

  • expiresAtstringrequired
  • outcomeenum<string>required
  • urlstringrequired

Responses

  • 200Success
  • 400The input does not match the action's schema (INVALID_REQUEST)
  • 401Missing or invalid API key
  • 403The request carried a foreign Origin
  • 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later