Skip to docs content
Browse and search
On this page

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_billing

Authorization

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

Body

  • changeobjectrequired
    • billingCycleenum<string>required
    • kindenum<string>required
    • planenum<string>required
  • familyenum<string>required

Response fields

  • nextobjectrequired
    • actionenum<string>required
    • messagestringrequired
    • namestringrequired
    • whoenum<string>required
  • pendingActionobjectrequired
    • actionstringrequired
    • expiresAtstringrequireda string to be decoded into a Date
    • idstringrequired
    • quoteobjectrequired
      • amountDueCentsintegerrequiredan integer
      • effectiveAtstringrequireda string to be decoded into a Date
      • renewalobjectrequired
        • amountCentsintegerrequiredan integer
        • atstringrequireda string to be decoded into a Date
        • termMonthsintegerrequiredan integer
      • saveOfferobjectrequired
        • descriptionstringrequired
        • offerobjectrequired
    • 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