Skip to docs content
Browse and search
On this page

get_billing

Read each subscription's plan, price, status, renewal and the changes it offers, the open and recent stablecoin payments, and any open checkout. Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:account scope.

POST/api/agent/actions/get_billing

Authorization

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

Body

json
{}

Response fields

  • openCheckoutsobject[]required
    • canCancelbooleanrequired
    • expiresAtstringrequireda string to be decoded into a Date
    • familyenum<string>required
    • railenum<string>required
    • stateenum<string>required
  • openPaymentsobject[]required
    • amountstringrequired
    • canCancelbooleanrequired
    • cancelEndsSubscriptionbooleanrequired
    • canPayByCardbooleanrequired
    • expiresAtstringrequireda string to be decoded into a Date
    • familyenum<string>required
    • kindenum<string>required
    • stateenum<string>required
    • underReviewbooleanrequired
  • recentPaymentsobject[]required
    • amountstringrequired
    • createdAtstringrequireda string to be decoded into a Date
    • familyenum<string>required
    • kindenum<string>required
    • methodstringrequired
    • statusenum<string>required
    • statusLabelstringrequired
  • subscriptionsobject[]required
    • autoRenewenum<string>required
    • availableChangesenum<string>[]required
    • cancelAtPeriodEndbooleanrequired
    • familyenum<string>required
    • openPaymentobjectrequired
      • amountCentsnumberrequired
      • dueAtstringrequired
      • kindenum<string>required
    • paidThroughstringrequired
    • pauseobjectrequired
      • resumesAtstringrequireda string to be decoded into a Date
      • startsAtstringrequired
      • stateenum<string>required
    • periodEndstringrequired
    • planstringrequired
    • priceCentsnumberrequired
    • railenum<string>required
    • renewalPaymentPreparablebooleanrequired
    • scheduledTermChangeobjectrequired
      • effectiveAtstringrequireda string to be decoded into a Date
      • termMonthsnumberrequired
    • stateenum<string>required
    • statusenum<string>required
    • statusDetailobjectrequired
      • amountCentsnumberrequired
      • atstringrequired
      • kindenum<string>required
    • termMonthsnumberrequired

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