get_pending_action
Read a held change: what it does, whether a code was sent, and, once confirmed, its outcome. pendingActionId is the id a held change returned. A confirmed change with no outcome yet finishes when confirm_action is called again. Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:billing scope.
POST
/api/agent/actions/get_pending_actionAuthorization
AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key:Bearer <key>.
Body
pendingActionIdstringrequireda string at most 64 character(s) long
Response fields
outcomeobjectrequiredchargedCentsnumberoptionaleffectiveAtstringrequireda string to be decoded into a Datekindenum<string>requiredrefundenum<string>optional
pendingActionobjectrequiredactionstringrequiredexpiresAtstringrequireda string to be decoded into a DateidstringrequiredquoteobjectrequiredamountDueCentsintegerrequiredan integereffectiveAtstringrequireda string to be decoded into a DaterenewalobjectrequiredamountCentsintegerrequiredan integeratstringrequireda string to be decoded into a DatetermMonthsintegerrequiredan integer
saveOfferobjectrequireddescriptionstringrequiredofferobjectrequired
summarystringrequired
statusenum<string>required
Responses
- 200Success
- 400The input does not match the action's schema (INVALID_REQUEST)
- 401Missing or invalid API key
- 403The request carried a foreign Origin
- 404No held change with that pendingActionId for this API key (CONFIRMATION_NOT_FOUND)
- 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
- 503Temporarily unavailable; retry later