Billing

GET /v1/tenant/billing

Returns everything about your commercial plan in one call: the current plan and its pricing in your country, what you have consumed this calendar year, the other plans available in your country and the cost of each delivery channel. Plans are annual and priced per country in the local currency.

Exceeding the annual event allowance never suspends your tenant: operations continue, and the events above the allowance are reported in usage.overage_events. From November 2026 they are charged at your price per event on the monthly invoice. wede emails your tenant contact when 50, 40, 30, 20, 10 and 0 percent of the allowance remains, once per year for each. See Metering.

Authentication

API key or session token with the billing:view permission. API keys have it. Sandbox activity never counts toward billing, so both production and sandbox keys return the same production figures.

Example

curl https://api.wede.pt/v1/tenant/billing \
  -H "x-wede-api-key: wede_live_YOUR_KEY"

Response

200 OK. Values below are illustrative and amounts are placeholders: your response contains your plan and the prices that apply to your country.

{
  "tenant_id": "9eb65ffa-3c1d-4d7e-8f02-1a2b3c4d5e6f",
  "country": "PT",
  "current_plan": {
    "id": "2a4c6e8f-0b1d-4f3a-9c5e-7b9d1f3a5c7e",
    "name": "growth",
    "display_name": "Growth",
    "max_events_per_year": 1000000,
    "max_zones": 10,
    "max_users": 50,
    "max_webhooks": 20,
    "sla_uptime_pct": "<percent>",
    "feature_flags": { "sms_fallback": true, "voice_fallback": true },
    "pricing": {
      "price_yearly": "<amount>",
      "included_sms": 5000,
      "included_voice_min": 500,
      "included_data_kb": 0,
      "included_lora": 0,
      "included_satellite": 0,
      "included_edge": 0,
      "currency": "EUR",
      "country_name": "Portugal",
      "flag": "🇵🇹"
    }
  },
  "available_plans": [
    {
      "id": "2a4c6e8f-0b1d-4f3a-9c5e-7b9d1f3a5c7e",
      "name": "growth",
      "display_name": "Growth",
      "max_events_per_year": 1000000,
      "max_zones": 10,
      "max_users": 50,
      "max_webhooks": 20,
      "sla_uptime_pct": "<percent>",
      "feature_flags": { "sms_fallback": true, "voice_fallback": true },
      "price_yearly": "<amount>",
      "included_sms": 5000,
      "included_voice_min": 500,
      "included_data_kb": 0,
      "included_lora": 0,
      "included_satellite": 0,
      "included_edge": 0,
      "currency": "EUR",
      "flag": "🇵🇹"
    }
  ],
  "channel_costs": [
    { "channel": "sms", "unit_description": "per message", "is_active": true, "country_price": "<amount>", "discount_pct": null, "price_per_unit": "<amount>", "cost_per_unit": "<amount>" },
    { "channel": "voice", "unit_description": "per minute", "is_active": true, "country_price": "<amount>", "discount_pct": 0.1, "price_per_unit": "<amount>", "cost_per_unit": "<amount>" }
  ],
  "usage": {
    "events_this_year": 12400,
    "events_internet": 12100,
    "sms_used": 280,
    "voice_used": 20,
    "lora_used": 0,
    "satellite_used": 0,
    "edge_used": 0,
    "location_updates_offline": 840,
    "dispatches_total": 156,
    "dispatches_offline": 12,
    "missions_total": 156,
    "overage_events": 0,
    "overage_amount_eur": 0
  }
}

string

Your tenant ID.

string

Country code used for pricing.

object | null

Your plan, or null if no plan is assigned yet.

Show properties

string

Plan ID (UUID).

string

Plan code.

string

Plan name for display.

integer | null

Events included per year. null means no limit.

integer | null

Zones included. null means no limit.

integer | null

Users included. null means no limit.

integer

Webhooks included.

string

Uptime target of the plan, in percent, as a decimal string.

object

Features of the plan, as name: boolean.

object | null

Pricing of this plan in your country, or null if none is defined.

Show properties

string | null

Your yearly price, as a decimal string, in currency: the price agreed with your organisation for this plan, else the country price.

string | null

The yearly price of the plan in your country.

integer

SMS messages included.

integer

Voice minutes included.

integer

Data included, in KB.

integer

LoRa messages included.

integer

Satellite messages included.

integer

Edge messages included.

string

ISO 4217 currency code.

string

Country name.

string | null

Country flag emoji.

object[]

Every active plan, with its pricing in your country when defined, cheapest first. Each item has the plan fields of current_plan (id, name, display_name, max_events_per_year, max_zones, max_users, max_webhooks, sla_uptime_pct, feature_flags) and, flattened on the same object, price_yearly (the price agreed with your organisation, else the country price), country_price_yearly, included_sms, included_voice_min, included_data_kb, included_lora, included_satellite, included_edge, currency and flag. Pricing fields are null when the plan has no pricing in your country.

object[]

The price you pay for each delivery channel bought from wede, in your country’s currency: the country price less your discount.

Show properties

string

sms, voice, data, lora, satellite or edge.

number

Your price for one unit.

number

The price of one unit in your country, before your discount.

number | null

Your discount on this channel, as a fraction (0.1 is 10%), or null when there is none.

number

deprecated

Same value as price_per_unit, kept for earlier integrations.

string

What one unit is, for example per message.

boolean

Always true: only active costs are returned.

object

Your consumption in the current calendar year. All values are 0 until you have activity.

Show properties

integer

Events counted this year.

integer

Events received over the internet path or queued for later delivery.

integer

SMS segments sent through wede this year, each segment to each recipient. See What wede counts.

integer

Voice minutes through wede this year, each started minute of each call.

integer

LoRa messages sent through wede this year.

integer

Satellite messages sent through wede this year.

integer

Edge messages sent through wede this year.

integer

Team location updates received without internet.

integer

Team dispatches.

integer

Team dispatches sent by SMS or voice.

integer

Missions created.

integer

Production events of the current year above the annual allowance of your conditions (the yearly limit agreed with your organisation, else the plan’s): 0 while you are within it, and always 0 when there is no annual limit. Exceeding the allowance never suspends your tenant: operations continue.

number

deprecated

Deprecated, always 0. Events above the allowance are charged on the monthly invoice, at your price per event and in your currency.

For event counts over any period, broken down by channel, use Usage.

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
500	`internal_error`	Unexpected error. Retry
503	`service_unavailable`	The API key could not be validated right now. Retry

Overview

Authentication

Events

Teams & Dispatch

Missions

Zones

Tenant

Webhooks

Sync

Policies

Connectivity

Sandbox

Parsers

Onboarding

Billing

Authentication

Example

Response

Errors

​Authentication

​Example

​Response

​Errors

Authentication

Example

Response

Errors