Get the active tariff plan for the given organization

GET

https://cdn.emnify.net/api/v1/organisation/:org_id_or_my/tariff_plan/active

GET

/api/v1/organisation/:org_id_or_my/tariff_plan/active

curl https://cdn.emnify.net/api/v1/organisation/my/tariff_plan/active \
     -H "Authorization: Bearer <token>"

{
  "organisation_id": 6797,
  "start_date": "2020-05-28T00:00:00.000Z",
  "sim_activated_rate": 0,
  "sim_activated_idle_rate": 0,
  "sim_suspended_rate": 0,
  "sim_suspended_active_rate": 0,
  "sim_activated_amount": 12,
  "applied_price": {
    "sim_activated_rate": [
      {
        "scale_start": 10,
        "rate": 0.8,
        "volume": 12
      }
    ]
  },
  "tariff_plan": {
    "name": "Professional",
    "description": "Full usability for small and medium applications",
    "sim_activation_fee": 3,
    "max_active_sims": 500,
    "add_active_sims_rate": 49,
    "add_active_sim_batch": 100,
    "max_service_profiles": 20,
    "max_tariff_profiles": 20,
    "max_users": 10,
    "api_access_allowed": true,
    "vpn_access": true,
    "evaluation": false,
    "expiry_time": 0,
    "id": 39,
    "price": {
      "sim_activated_rate": [
        {
          "scale_start": 1,
          "rate": 0.85
        },
        {
          "scale_start": 10,
          "rate": 0.8
        },
        {
          "scale_start": 100,
          "rate": 0.6
        },
        {
          "scale_start": 1000,
          "rate": 0.5
        }
      ]
    },
    "currency": {
      "code": "EUR",
      "symbol": "€",
      "id": 1
    },
    "workspaces_enabled": false
  },
  "tariff_plan_runtime": {
    "number_of_units": 1,
    "time_unit_id": 0,
    "id": 1
  },
  "active": true,
  "applied_rate": 299,
  "id": 9035,
  "service_level": {
    "id": 1,
    "name": "Basic"
  },
  "workspaces_enabled": true
}

Organisation.TariffPlan + List +1 endpoint

Roles: Administrator User Observer

Retrieve detailed information about the currently assigned tariff_plan of the given organisation. It can either be accessed for the own organisation or a direct child organisation. The applied_price field is calculated using the currently active SIM cards for the month.

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `Organisation.TariffPlan` + `List` <span className="permission-callout__also">[+1 endpoint](/developers/api-guidelines/permission-endpoints#permission-organisation-tariffplan-list "This permission also grants 1 other endpoint")</span> <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info> Retrieve detailed information about the currently assigned `tariff_plan` of the given organisation. It can either be accessed for the own organisation or a direct child organisation. The `applied_price` field is calculated using the currently active SIM cards for the month.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

org_id_or_mystringRequiredformat: "^(my)|(\d+)$"Defaults to my

Numerical ID of an Organization or the string my to use the currently authorized organisation

Response

Success

organisation_iddoubleOptional

start_datestringOptional

expiry_datestringOptional

the end date of the tariff_plan, or null if it is open end

sim_activated_ratedoubleOptional

sim_activated_idle_ratedoubleOptional

sim_suspended_ratedoubleOptional

sim_suspended_active_ratedoubleOptional

sim_activated_amountdoubleOptional

the number of activated SIMs this month

applied_priceobjectOptional

the fees that apply for the current month according to the number of activated SIMs. calculation follows volume pricing at the moment, but may be changed at any time. the resulting price is the sum of each price line times the given volume. if it is a scaled price, the rate object contains a scale_start field, otherwise it is fixed.

tariff_planobjectOptional

tariff_plan_runtimeobjectOptional

activebooleanOptional

applied_ratedoubleOptional

iddoubleOptional

service_levelobjectOptional

The default service level of a tariff plan. Possible values can be fetched with GET /api/v1/service_level.

workspaces_enabledbooleanOptional

Determines if the organization is allowed to use the Workspace feature. Returns the global value from the tariff plan, unless this value is overridden on the organization level. If it's set, the value configured on the organization level always takes priority.

Errors

403

Forbidden Error

404

Not Found Error