The plans this tidekeeper offers

The plans this tidekeeper offers. Nobody signs in to read a price.

# The plans this tidekeeper offers

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-plans

`GET /api/v1/plans`

The plans this tidekeeper offers. Nobody signs in to read a price.

## The answer

200, `PlansView`: What a deployment offers, for the pricing page.

- `consumers` (boolean): The plans are offered to consumers too: the terms are published and every priced plan has its price with VAT (doc/consumers.md §2).
- `grace_days` (integer, needed)
- `plans` (list of PlanView, needed)
- `read_only_days` (integer, needed)
- `region` (string, needed)
- `sold_through_link` (boolean): Some plans are sold through Link, Stripe's merchant of record (`billing.stripe.managed` is not `never`): the pricing page says where those are cancelled and in what currency they may be paid.
- `trial_days` (integer, needed)
- `unset` (boolean, needed): Nobody has written the plans yet: every name, price and limit is a placeholder, and no account is held to anything.

## Asking

```sh
curl https://tidekeeper.eu/api/v1/plans \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```

The answer

Status 200

PlansView What a deployment offers, for the pricing page.

consumers

booleanThe plans are offered to consumers too: the terms are published and every priced plan has its price with VAT (doc/consumers.md §2).

grace_days

integerneeded

plans

list of PlanViewneeded

read_only_days

integerneeded

region

stringneeded

sold_through_link

booleanSome plans are sold through Link, Stripe's merchant of record (`billing.stripe.managed` is not `never`): the pricing page says where those are cancelled and in what currency they may be paid.

trial_days

integerneeded

unset

booleanneededNobody has written the plans yet: every name, price and limit is a placeholder, and no account is held to anything.

Asking

curl https://tidekeeper.eu/api/v1/plans \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN"

const answer = await fetch("https://tidekeeper.eu/api/v1/plans", {
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
  },
}).then((r) => r.json());