← Back to schema index

UserRetryPolicyResponse

Properties

FieldTypeDescription
dataobjectMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
typestring
attributesobjectThe account's saved retry policy: activation, limit, interval, and eligible outcomes. Disabled or not configured, it carries `enabled=false`, `max_retries=0`, `interval_seconds=0` and empty `outcomes`.
enabledboolean`true` when the retry cycle is active. With `false`, the other fields are ignored.
max_retriesintegerMaximum number of automatic retries. Once reached, the cycle enters the `exhausted` terminal state. The allowed limit depends on the plan.
interval_secondsintegerSeconds to wait between each retry (300–86400, i.e., 5 minutes to 24 hours).
outcomesarrayOutcomes that trigger a retry. By default, they are `not_found`, `cep_unavailable`, and `error`; the combination `["not_found", "cep_unavailable"]` excludes `error`.
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion descriptor present in the `meta` block of every response (and in the `meta` of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec.
timezone*stringAlways `UTC`: The canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601`: Explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

  • GET /v1/users/me/retry-policy