# Source: https://upstash.com/docs/redis/sdks/ts/commands/hash/hpexpire.md

# Source: https://upstash.com/docs/redis/sdks/py/commands/hash/hpexpire.md

> ## Documentation Index
> Fetch the complete documentation index at: https://upstash.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# HPEXPIRE

> Set a timeout on a hash field in milliseconds.

## Arguments

<ParamField body="key" type="str" required>
  The key of the hash.
</ParamField>

<ParamField body="fields" type="Union[str, List[str]]" required>
  The field or list of fields within the hash to set the expiry for.
</ParamField>

<ParamField body="milliseconds" type="Union[int, datetime.timedelta]" required>
  The timeout in milliseconds as an integer or a `datetime.timedelta` object.
</ParamField>

<ParamField body="nx" type="bool" optional>
  Set expiry only when the field has no expiry. Defaults to `False`.
</ParamField>

<ParamField body="xx" type="bool" optional>
  Set expiry only when the field has an existing expiry. Defaults to `False`.
</ParamField>

<ParamField body="gt" type="bool" optional>
  Set expiry only when the new expiry is greater than the current one. Defaults to `False`.
</ParamField>

<ParamField body="lt" type="bool" optional>
  Set expiry only when the new expiry is less than the current one. Defaults to `False`.
</ParamField>

## Response

<ResponseField type="List[int]" required>
  A list of integers indicating whether the expiry was successfully set.

  * `-2` if the field does not exist in the hash or if key doesn't exist.
  * `0` if the expiration was not set due to the condition.
  * `1` if the expiration was successfully set.
  * `2` if called with 0 seconds/milliseconds or a past Unix time.

  For more details, see [HPEXPIRE documentation](https://redis.io/commands/hpexpire).
</ResponseField>

<RequestExample>
  ```py Example theme={"system"}
  redis.hset(hash_name, field, value)

  assert redis.hpexpire(hash_name, field, 1000) == [1]
  ```
</RequestExample>