List organization tariff plans

GET

https://cdn.emnify.net/api/v1/organisation/:org_id/tariff_plan

GET

/api/v1/organisation/:org_id/tariff_plan

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

1 [
2   {
3     "id": 34,
4     "organisation_id": "44",
5     "start_date": "2015-10-01T00:00:00.000Z",
6     "sim_activated_rate": 0,
7     "sim_activated_idle_rate": 0,
8     "sim_suspended_rate": 0,
9     "sim_suspended_active_rate": 0,
10     "federation_allowed": false,
11     "factory_test_mode_allowed": true,
12     "active": true,
13     "applied_rate": 0,
14     "price_model": "fixed",
15     "tariff_plan": {
16       "organisation_id": "2",
17       "name": "Evaluation",
18       "description": "Evaluate all functions, no monthly commitment",
19       "tariff_plan_type_id": "0",
20       "min_tariff_plan_runtime_id": "0",
21       "level": "0",
22       "owner_organisation_id": "0",
23       "public_for_child_organisations": true,
24       "creation_date": "2016-01-01T00:00:00.000Z",
25       "activation_date": "2016-01-01T00:00:00.000Z",
26       "deprecation_date": "2016-01-01T00:00:00.000Z",
27       "rate": 0,
28       "yearly_rate": 0,
29       "sim_activation_fee": 0,
30       "max_active_sims": 0,
31       "add_active_sims_rate": 0,
32       "add_active_sim_batch": 0,
33       "max_service_profiles": 0,
34       "max_tariff_profiles": 0,
35       "max_users": 0,
36       "minimum_runtime": 1,
37       "api_access_allowed": 1,
38       "vpn_access": 1,
39       "private": 0,
40       "dtype": "0",
41       "evaluation": true,
42       "expiry_time": 60,
43       "billing_disabled": true,
44       "used_count": 8913,
45       "id": 18,
46       "currency": {
47         "code": "EUR",
48         "symbol": "€",
49         "currency_id": "1"
50       },
51       "federation_allowed": true,
52       "factory_test_mode_allowed": true,
53       "currency_id": "1",
54       "service_level_id": null,
55       "tariff_plan_status_id": "1",
56       "visibility_id": "0"
57     },
58     "tariff_plan_runtime": {
59       "id": 1,
60       "number_of_units": "1",
61       "time_unit_id": "0"
62     }
63   }
64 ]

Organisation.TariffPlan + List

Roles: Administrator User Observer

Retrieve a list of all Tariff Plans that are available for the given organisation. The available tariff plans for one’s own organisation can also be retrieved with a call to /api/v1/organisation/my/tariff_plan

<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` <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 a list of all Tariff Plans that are available for the given organisation. The available tariff plans for one's own organisation can also be retrieved with a call to `/api/v1/organisation/my/tariff_plan`

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_iddoubleRequired

Numerical ID of an organization

Response

Success

iddoubleOptional

ID of the tariff plan assignment

organisation_idstringOptional

start_datestringOptional

expiry_datestringOptional

sim_activated_ratedoubleOptional

sim_activated_idle_ratedoubleOptional

sim_suspended_ratedoubleOptional

sim_suspended_active_ratedoubleOptional

currency_idstringOptional

federation_allowedbooleanOptional

Custom federation_allowed configuration for the organisation. If set to null, the default configuration from the tariff plan will be applied.

factory_test_mode_allowedbooleanOptional

Custom factory_test_mode_allowed configuration for the organisation. If set to null, the default configuration from the tariff plan will be applied.

service_levelobjectOptional

Custom service level for the organisation. If set to null, the default service level from the tariff plan will be applied.

activebooleanOptional

applied_ratedoubleOptional

price_modelstringOptional

tariff_planobjectOptional

Errors

403

Forbidden Error