---
title: "Turn an instance's auto-renewal off or on"
method: PUT
path: "/v1/instances/{id}/auto-renew"
tags: ["public", "instances"]
---

# Turn an instance's auto-renewal off or on

`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`

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.

## Path parameters

- `id` string, required

## Request body

- OrderingPublicAutoRenewRequest
  - `auto_renew` boolean: 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 `200`

OK

- OrderingPublicAutoRenew
  - `auto_renew` boolean
  - `ends_at` string: EndsAt is the end of the paid period, set when auto_renew is false.
  - `instance_ids` string[]: InstanceIDs is every instance the order delivered: they all end together.
  - `order_id` string: OrderID is the order whose plan this is: GET /v1/orders/{id} reads it.
  - `renews_at` string: RenewsAt is the next renewal, set when auto_renew is true.

## Other responses

- `400`: bad_request — auto_renew (true or false) is required
- `401`: invalid or missing API key
- `403`: the key lacks instances:delete
- `404`: no such instance, or one no order delivered
- `409`: renewal_not_applicable — the instance is not on a fixed-price plan that renews (billed by usage, or paid once); renewal_ended — the plan has already ended; renewal_unavailable — the renewal cannot be changed right now

---

[API](https://skmtc.dev/vozora/apis/vozora-api.md) · [All operations](https://skmtc.dev/vozora/apis/vozora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vozora/apis/vozora-api/revisions/56f15734fc5a?raw)