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/org_id_or_my/tariff_plan/active \
>      -H "Authorization: Bearer <token>"

1 {
2   "organisation_id": 6797,
3   "start_date": "2020-05-28T00:00:00.000Z",
4   "sim_activated_rate": 0,
5   "sim_activated_idle_rate": 0,
6   "sim_suspended_rate": 0,
7   "sim_suspended_active_rate": 0,
8   "sim_activated_amount": 12,
9   "applied_price": {
10     "sim_activated_rate": [
11       {
12         "scale_start": 10,
13         "rate": 0.8,
14         "volume": 12
15       }
16     ]
17   },
18   "tariff_plan": {
19     "name": "Professional",
20     "description": "Full usability for small and medium applications",
21     "sim_activation_fee": 3,
22     "max_active_sims": 500,
23     "add_active_sims_rate": 49,
24     "add_active_sim_batch": 100,
25     "max_service_profiles": 20,
26     "max_tariff_profiles": 20,
27     "max_users": 10,
28     "api_access_allowed": true,
29     "vpn_access": true,
30     "evaluation": false,
31     "expiry_time": 0,
32     "id": 39,
33     "price": {
34       "sim_activated_rate": [
35         {
36           "scale_start": 1,
37           "rate": 0.85
38         },
39         {
40           "scale_start": 10,
41           "rate": 0.8
42         },
43         {
44           "scale_start": 100,
45           "rate": 0.6
46         },
47         {
48           "scale_start": 1000,
49           "rate": 0.5
50         }
51       ]
52     },
53     "currency": {
54       "code": "EUR",
55       "symbol": "€",
56       "id": 1
57     },
58     "workspaces_enabled": false
59   },
60   "tariff_plan_runtime": {
61     "number_of_units": 1,
62     "time_unit_id": 0,
63     "id": 1
64   },
65   "active": true,
66   "applied_rate": 299,
67   "id": 9035,
68   "service_level": {
69     "id": 1,
70     "name": "Basic"
71   },
72   "workspaces_enabled": true
73 }

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_mystringRequired

Response

Success

organisation_iddouble

start_datestring

expiry_datestring

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

sim_activated_ratedouble

sim_activated_idle_ratedouble

sim_suspended_ratedouble

sim_suspended_active_ratedouble

sim_activated_amountdouble

the number of activated SIMs this month

applied_priceobject

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_planobject

tariff_plan_runtimeobject

activeboolean

applied_ratedouble

iddouble

service_levelobject

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

workspaces_enabledboolean

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

404

Not Found Error

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

1	{
2	"organisation_id": 6797,
3	"start_date": "2020-05-28T00:00:00.000Z",
4	"sim_activated_rate": 0,
5	"sim_activated_idle_rate": 0,
6	"sim_suspended_rate": 0,
7	"sim_suspended_active_rate": 0,
8	"sim_activated_amount": 12,
9	"applied_price": {
10	"sim_activated_rate": [
11	{
12	"scale_start": 10,
13	"rate": 0.8,
14	"volume": 12
15	}
16	]
17	},
18	"tariff_plan": {
19	"name": "Professional",
20	"description": "Full usability for small and medium applications",
21	"sim_activation_fee": 3,
22	"max_active_sims": 500,
23	"add_active_sims_rate": 49,
24	"add_active_sim_batch": 100,
25	"max_service_profiles": 20,
26	"max_tariff_profiles": 20,
27	"max_users": 10,
28	"api_access_allowed": true,
29	"vpn_access": true,
30	"evaluation": false,
31	"expiry_time": 0,
32	"id": 39,
33	"price": {
34	"sim_activated_rate": [
35	{
36	"scale_start": 1,
37	"rate": 0.85
38	},
39	{
40	"scale_start": 10,
41	"rate": 0.8
42	},
43	{
44	"scale_start": 100,
45	"rate": 0.6
46	},
47	{
48	"scale_start": 1000,
49	"rate": 0.5
50	}
51	]
52	},
53	"currency": {
54	"code": "EUR",
55	"symbol": "€",
56	"id": 1
57	},
58	"workspaces_enabled": false
59	},
60	"tariff_plan_runtime": {
61	"number_of_units": 1,
62	"time_unit_id": 0,
63	"id": 1
64	},
65	"active": true,
66	"applied_rate": 299,
67	"id": 9035,
68	"service_level": {
69	"id": 1,
70	"name": "Basic"
71	},
72	"workspaces_enabled": true
73	}