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

# Plans of your organisation

> Every plan offered to your organisation, each with your conditions: price, what it includes, prices above it, fee per event and add-ons.

```text theme={null}
GET /v1/tenant/plans
```

Returns every plan offered to your organisation, each with the conditions that apply to you in it: the price per year, what it includes, the prices above it, the fee per production event and the add-ons. These are the plans and conditions shown in Billing in the dashboard, where your administrator chooses and pays a plan. See [Plans](https://docs.wede.pt/concepts/plans.md).

## Authentication

API key or session token with the `billing:view` permission. API keys have it.

## Example

```bash theme={null}
curl https://api.wede.pt/v1/tenant/plans \
  -H "x-wede-api-key: wede_live_YOUR_KEY"
```

## Response

`200 OK`. Values below are illustrative and amounts are placeholders.

```json theme={null}
{
  "current_plan_id": "2a4c6e8f-0b1d-4f3a-9c5e-7b9d1f3a5c7e",
  "currency": "EUR",
  "data": [
    {
      "plan": { "id": "2a4c6e8f-0b1d-4f3a-9c5e-7b9d1f3a5c7e", "name": "growth", "display_name": "Growth", "is_pilot": false, "is_active": true, "sla_uptime_pct": "<percent>" },
      "purchasable": true,
      "current": true,
      "in_contract": true,
      "pending_payment": false,
      "price": { "country_price_yearly": "<amount>", "tenant_price_yearly": null, "effective_price_yearly": "<amount>", "source": "country", "currency": "EUR" },
      "event_fee": { "country": null, "tenant": null, "effective": null, "source": null, "currency": "EUR" },
      "limits": {
        "users": { "value": 50, "source": "plan" },
        "devices": { "value": 300, "source": "plan" },
        "zones": { "value": 10, "source": "plan" },
        "webhooks": { "value": 20, "source": "plan" },
        "data_sources": { "value": null, "source": "plan" },
        "events_per_year": { "value": 1000000, "source": "plan" }
      },
      "unit_prices": {
        "user": { "price_per_day": "<amount>", "currency": "EUR", "source": "country" },
        "device": { "price_per_day": "<amount>", "currency": "EUR", "source": "country" },
        "zone": { "price_per_day": null, "currency": null, "source": null },
        "webhook": { "price_per_day": null, "currency": null, "source": null },
        "data_source": { "price_per_day": null, "currency": null, "source": null },
        "event": { "price_per_day": "<amount>", "currency": "EUR", "source": "country" }
      },
      "included": { "sms": 5000, "voice": 500, "data": 0, "lora": 0, "satellite": 0, "edge": 0 },
      "channel_stock": { "sms": { "value": 5000, "source": "country" } },
      "addons": [
        { "code": "<code>", "name": "<name>", "is_active": true, "mode": "available", "plan_mode": "available", "own": null, "price_yearly": "<amount>", "setup_fee": "<amount>", "currency": "EUR" }
      ]
    }
  ],
  "channels": [
    { "channel": "sms", "unit_description": "per message", "currency": "EUR", "carrier": "wede", "charged_by_wede": true, "country_price": "<amount>", "discount_pct": null, "price": "<amount>", "stock": 5000, "used": 1870 }
  ]
}
```

`channel_stock` is shortened in this example: it has every channel.

**current\_plan\_id** `string | null`

Your current plan, or `null` when none is assigned.

**currency** `string`

The currency of your country, ISO 4217.

**data** `object[]`

Every plan offered to your organisation: the active paid plans, plus your current plan.

**properties**

**plan** `object`

`id`, `name`, `display_name`, `is_pilot`, `is_active` and `sla_uptime_pct` (the availability target).

**purchasable** `boolean`

`true` when your administrator can choose and pay this plan in Billing: an active plan, not a pilot, with a price above 0.

**current** `boolean`

Your current plan.

**in\_contract** `boolean`

The plan of your active contract.

**pending\_payment** `boolean`

A contract for this plan is waiting for its payment.

**price** `object`

Yearly price: `country_price_yearly` (the price in your country), `tenant_price_yearly` (the price agreed with your organisation, or `null`), `effective_price_yearly` (the one you pay), `source` (`tenant`, `country` or `null` when there is no price) and `currency`.

**event\_fee** `object`

Fee per production event in this plan: `effective` is the fee you pay, or `null` when there is none; `country` and `tenant` are the country value and the value agreed with your organisation; `source` says which applies.

**limits** `object`

What the plan includes for you: `users`, `devices`, `zones`, `webhooks`, `data_sources` and `events_per_year`, each with `value` (`null` is unlimited) and `source` (`tenant` when agreed with your organisation, else `plan`). See [what counts](https://docs.wede.pt/concepts/plans.md#annual-plans).

**unit\_prices** `object`

Prices above what the plan includes: for `user`, `device`, `zone`, `webhook` and `data_source`, `price_per_day` is the price of each unit above, for each day it is above; for `event`, `price_per_day` is the price of each production event above the yearly limit. `price_per_day` is `null` when nothing is charged for that item. `source`: `tenant`, `country` or `general`.

**included** `object`

Communications included per year, by channel (`sms`, `voice`, `data`, `lora`, `satellite`, `edge`), or `null` for a channel with nothing set.

**channel\_stock** `object`

The same quantities by channel, each with `value` and `source` (`tenant`, `country` or `null`).

**addons** `object[]`

The add-ons of this plan: `code`, `name`, `mode` (how this plan offers it for you: `included`, `at_activation`, `available`, `unavailable`, or `null` when the plan does not offer it), `plan_mode` (how the plan offers it to everyone), `own` (terms agreed with your organisation, or `null`), `price_yearly`, `setup_fee` and `currency`.

**channels** `object[]`

Your communication prices, the same in every plan: `channel`, `unit_description`, `currency`, `carrier` (`wede`, `own`, `mixed` or `none`), `charged_by_wede`, `country_price`, `discount_pct` (a fraction, or `null`), `price` (yours), and `stock` and `used` for the year.

The invoices of what is charged above the plan are in [Monthly invoices](https://docs.wede.pt/api-reference/tenant/monthly-invoices.md).

## Errors

| Status | Code | When |
| - | - | - |
| 401 | `unauthorized` | Credential missing, malformed, revoked or expired |
| 403 | `forbidden` | The credential lacks `billing:view` |
| 404 | `not_found` | The credential is not linked to a tenant |
| 503 | `service_unavailable` | Not available right now. Retry |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.