public
instances

Turn an instance's auto-renewal off or on

auto_renew=false ends the plan at the end of the period already paid for: no refund and no further charge, and then EVERY instance in instance_ids is terminated and its data destroyed. auto_renew=true undoes that while the plan is live. Asking for the current state changes nothing. Needs instances:delete, which instances:write does not imply.

put/v1/instances/{id}/auto-renew

Request

  • Base URL: https://api.vozora.io
  • URL: https://api.vozora.io/v1/instances/{id}/auto-renew
  • Auth: API key in header Authorization

Path parameters

idstring required

instance id (uuid)

Request body

auto_renewboolean

AutoRenew false: the plan ends at the end of the period already paid for, with no refund and no further charge, and every instance on the order is then terminated. true: it renews.

Response

OK

auto_renewboolean
ends_atstring

EndsAt is the end of the paid period, set when auto_renew is false.

instance_idsstring[]

InstanceIDs is every instance the order delivered: they all end together.

order_idstring

OrderID is the order whose plan this is: GET /v1/orders/{id} reads it.

renews_atstring

RenewsAt is the next renewal, set when auto_renew is true.

Changes

No recorded changes to this operation across all 1 revision of this API.