Start a Scale trial
Start a Scale trial with a code from the TweetStream team.
POST
/api/agent/scale-trialAuthorization
AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key:Bearer <key>.
Headers
Idempotency-KeystringheaderrequiredRequired. Generate one key per intended purchase or change and reuse it on retries; the same key returns the same result.
Body
codestringrequireda string at most 128 character(s) long
Response fields
checkoutIdstringoptionala string matching the pattern ^pl_[a-z0-9]{1,64}$familyenum<string>requirednextobjectrequiredmessagestringoptionala string at most 500 character(s) longactionenum<string>requiredmethodenum<string>requiredurlstringrequireda string matching the pattern ^(https|wss):\/\/[^\s]+$whoenum<string>required
offerobjectoptionalamountDueNowobjectrequiredcurrencyenum<string>requiredminorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
modeenum<string>requiredplanNamestringrequiredrenewalobjectrequiredamountobjectrequiredcurrencyenum<string>requiredminorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
atstringrequireda string to be decoded into a DatebillingCycleenum<string>requiredthenAmountobjectrequiredcurrencyenum<string>requiredminorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
paymentUrlstringoptionala string matching the pattern ^(https|wss):\/\/[^\s]+$reasonenum<string>requiredstatusenum<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
- 409Idempotency, checkout, offer or trial conflict
- 429Rate limit or activation budget reached; retry after retryAfterSeconds
- 503Temporarily unavailable; retry later