# HppSessionDerivedState

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The state an HPP session presents to a reader, derived from its stored
`HppSessionStatus` and its expiry instant.

## Values

| Value | Description |
| --- | --- |
| `Usable` | Pending and not yet past its expiry instant: the link can still be presented and consumed. |
| `Expired` | Pending, but the expiry instant has passed. The document may still be readable for the retention window configured by HostedPaymentPageSettings.SessionExpiredRetentionDays, which is what lets a payer see a distinct expired page and an administrator see the row on a grid. |
| `Consumed` | Consumed by a transaction submission (Consumed). |
| `Revoked` | Revoked by an administrator (Revoked). |
| `Cancelled` | Cancelled by the parent page over the iframe command channel (Cancelled). |
| `Completed` | A reusable link that has taken its last capped completion (Completed). The reusable analogue of Consumed: the link is spent, but by many payers rather than one. |
| `Paused` | The merchant has paused the link. Unlike every other non-usable state this one is reversible: a resume puts the link straight back to Usable with its expiry, cap and prefill untouched. A payer who opens a paused link sees the merchant's own inactive message rather than the generic out-of-service copy. |

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.