Skip to docs content
Browse and search
On this page

Read onboarding status

Progress for one product (family) or one checkout (checkoutId), with the next step. Send exactly one of the two. Poll after a human step at the interval in next.afterSeconds. Never carries a key or a Discord link.

GET/api/agent/status

Authorization

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

Query parameters

  • familyenum<string>optional
  • checkoutIdstringoptional

Response fields

  • checkoutIdstringoptionala string matching the pattern ^pl_[a-z0-9]{1,64}$
  • familyenum<string>required
  • nextobjectrequired
    • messagestringoptionala string at most 500 character(s) long
    • actionenum<string>required
    • methodenum<string>required
    • urlstringrequireda string matching the pattern ^(https|wss):\/\/[^\s]+$
    • whoenum<string>required
  • offerobjectoptional
    • amountDueNowobjectrequired
      • currencyenum<string>required
      • minorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
    • modeenum<string>required
    • planNamestringrequired
    • renewalobjectrequired
      • amountobjectrequired
        • currencyenum<string>required
        • minorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
      • atstringrequireda string to be decoded into a Date
      • billingCycleenum<string>required
      • thenAmountobjectrequired
        • currencyenum<string>required
        • minorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
  • paymentUrlstringoptionala string matching the pattern ^(https|wss):\/\/[^\s]+$
  • reasonenum<string>required
  • statusenum<string>required

Responses

  • 200Success
  • 400Invalid request, wrong code, or the Terms were not accepted
  • 401Missing or invalid API key, or the setup proof is missing or expired
  • 403The account is restricted, or the request carried a foreign Origin
  • 404No such checkout or link, or the account has no entitlement for this product
  • 429Rate limit or activation budget reached; retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later