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_billingAuthorization
AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key:Bearer <key>.
Body
json
{}Response fields
openCheckoutsobject[]requiredcanCancelbooleanrequiredexpiresAtstringrequireda string to be decoded into a Datefamilyenum<string>requiredrailenum<string>requiredstateenum<string>required
openPaymentsobject[]requiredamountstringrequiredcanCancelbooleanrequiredcancelEndsSubscriptionbooleanrequiredcanPayByCardbooleanrequiredexpiresAtstringrequireda string to be decoded into a Datefamilyenum<string>requiredkindenum<string>requiredstateenum<string>requiredunderReviewbooleanrequired
recentPaymentsobject[]requiredamountstringrequiredcreatedAtstringrequireda string to be decoded into a Datefamilyenum<string>requiredkindenum<string>requiredmethodstringrequiredstatusenum<string>requiredstatusLabelstringrequired
subscriptionsobject[]requiredautoRenewenum<string>requiredavailableChangesenum<string>[]requiredcancelAtPeriodEndbooleanrequiredfamilyenum<string>requiredopenPaymentobjectrequiredamountCentsnumberrequireddueAtstringrequiredkindenum<string>required
paidThroughstringrequiredpauseobjectrequiredresumesAtstringrequireda string to be decoded into a DatestartsAtstringrequiredstateenum<string>required
periodEndstringrequiredplanstringrequiredpriceCentsnumberrequiredrailenum<string>requiredrenewalPaymentPreparablebooleanrequiredscheduledTermChangeobjectrequiredeffectiveAtstringrequireda string to be decoded into a DatetermMonthsnumberrequired
stateenum<string>requiredstatusenum<string>requiredstatusDetailobjectrequiredamountCentsnumberrequiredatstringrequiredkindenum<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