---
title: "Get the recovery allowances"
method: GET
path: "/v1/recovery/allowances"
tags: ["Disaster Recovery"]
---

# Get the recovery allowances

`GET /v1/recovery/allowances`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/recovery/allowances`
- Auth: HTTP bearer

```bash
curl https://api.subscriby.net/v1/recovery/allowances \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
```

One row per kind, plus the window they are counted in.

- `self_service_remaining` is what the rolling window still allows on its own; `grant_remaining` is what support has released on top and not yet spent. `remaining` is their sum and `allowed` whether a recovery of that kind would start right now.
- `uses_grant` is true when the next recovery would spend a support grant rather than the self-service allowance.
- `next_self_service_at` is when the self-service allowance returns, `null` while it is available. `last_used_at` is when the kind was last recovered inside the window.

See [Allowances and support review](https://docs.subscriby.net/disaster-recovery/allowances-and-support-review) for the rule and what support audits before releasing a grant.

## Response `200`

Array of `RecoveryAllowanceResource`

- object
  - `data` RecoveryAllowanceResource[], required: The items.
    - `kind` string, required: The kind of recovery: `account` (the creator's sign-in account), `bot` (a project's bot) or `resources` (the channels and groups a project sells).
    - `kind_label` string, required: The kind in the connector's own words, such as "Project Bot", in the creator's language.
    - `self_service_remaining` integer, required: What the rolling window still allows on its own.
    - `grant_remaining` integer, required: What support has released on top and not yet spent.
    - `remaining` integer, required: The sum of the two.
    - `allowed` boolean, required: Whether a recovery of that kind would start right now.
    - `uses_grant` boolean, required: True when the next recovery would spend a support grant rather than the self-service allowance.
    - `last_used_at` string, nullable, required: When the kind was last recovered inside the window, ISO 8601; null if never.
    - `next_self_service_at` string, nullable, required: When the self-service allowance returns, ISO 8601; null while it is available.
  - `meta` object, required: The rule the allowances are counted under.
    - `window_days` integer, required: The rolling window the allowances are counted in, in days.
    - `self_service_uses` integer, required: How many self-service recoveries of each kind the window allows.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)