> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/mutations/settenantexpiry.md).

# setTenantExpiry

Sets or clears the tenant's expiry timestamp.

Audience: Programmer

Sets or clears the tenant's expiry timestamp. Pass input.expiresAt as null to clear. Soft-deleted (disabled) tenants are not visible to this mutation — call restoreTenant first (it accepts an optional new expiry). Returns an error when the tenant does not exist (including the disabled case). The value is written directly to tenant.expires\_at; the periodic tenant-expiry-check workflow soft-deletes the tenant once the timestamp is in the past. Idempotent on the already-at-target-state cases (clear against empty, set matching the current value).

The target tenant is named by input.tenantId. System caller required (PYCK\_SERVICE\_TOKEN): the expiry is the deadline an operator imposes on the tenant, and a tenant admin able to move it would outlive the operator's decision on its own.

**Served by:** [management](https://docs.pyck.cloud/graphql-api/services/management.md)

## Arguments

| Name    | Type                                                                                        | Default | Description |
| ------- | ------------------------------------------------------------------------------------------- | ------- | ----------- |
| `input` | [SetTenantExpiryInput](https://docs.pyck.cloud/graphql-api/inputs/settenantexpiryinput.md)! |         |             |

## Returns

[SetTenantExpiryResponse](https://docs.pyck.cloud/graphql-api/types/settenantexpiryresponse.md)!

## Example

Sets or clears the tenant's expiry timestamp. Pass null to clear. System role required. The value is written directly to tenant.expires\_at; the periodic tenant-expiry-check workflow soft-deletes the tenant once the timestamp is reached. Returns an error when the tenant does not exist; soft-deleted tenants are invisible to this mutation. Idempotent on the already-at-target-state cases.

```graphql
mutation SetTenantExpiry($input: SetTenantExpiryInput!) {
  setTenantExpiry(input: $input) {
    success
  }
}
```

**Variables**

```json
{
  "input": {
    "expiresAt": "<RFC3339 timestamp, or null to clear>",
    "tenantId": "<tenant ID>"
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/mutations/settenantexpiry.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
