WHwherobots
management
superuser

Extend a running trial's end date and/or value cap

Changed on

Extend the org's running trial (see :mod:src.internal.trial_admin).

A lapsed trial is reinstated instead: see /trial/reinstate.

post/management/organization/{organization_id}/trial/extend

Request

  • Base URL
    https://api.cloud.wherobots.com
  • URL
    https://api.cloud.wherobots.com/management/organization/{organization_id}/trial/extend
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Path parameters

organization_idstring required

Request body

trial_end_datestring date-time nullable

New trial end (timezone-aware); must be later than the current one.

reasonstring required
idempotency_keystring nullable

Optional. Reuse it when retrying a request whose outcome is unknown, so Orb grants additional_trial_value_usd only once.

allow_expiring_value_grantsboolean

Move the end date even though live trial value grants expire before it (the value cap then drops when they do). Without it such a request is refused with 409.

Response

Successful Response

organization_idstring required
orb_subscription_idstring required
previous_trial_end_datestring date-time required
trial_end_datestring date-time required
additional_trial_value_usdstring nullable required
warningstring nullable

Set when part of the change committed and the rest failed; the rest of the response describes what did commit.

Changes