change_billing
Prepare a change to a subscription: plan, term, Instagram or Ultra Speed account limit, pause, cancel (its quote names any save offer), a save offer, resume, keep, or auto-renew off. Returns the price and date; nothing changes until confirm_action runs it with the code emailed to the person. Tier confirm: the call only holds the change and returns it. request_confirmation_code emails the person a code; confirm_action runs the change once they read it back. The MCP tool of the same name needs the tweetstream:billing scope.
POST
/api/agent/actions/change_billingAuthorization
AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key:Bearer <key>.
Body
changeobjectrequiredbillingCycleenum<string>requiredkindenum<string>requiredplanenum<string>required
familyenum<string>required
Response fields
nextobjectrequiredactionenum<string>requiredmessagestringrequirednamestringrequiredwhoenum<string>required
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
- 409Nothing to change, or the change is not offered (ACTION_REFUSED with reason)
- 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
- 503Temporarily unavailable; retry later