openapi: 3.0.1 info: title: Connectivity APIs description: Connectivity APIs help users manage their connectivity through APIs. version: 1.0.0 servers: - url: https://api.korewireless.com/connectivity description: Production security: - {} - Auth: [] - api_key: [] tags: - name: eligibility description: Retrieve details about the eligibility of a given account - name: eSIM Profile Management description: API to manage eSIM Switch related activities for a given account
Refer to the eSIM switch article on the KORE Help Center for additional information - name: usage description: A user can retrieve usage records for a given subscription or plan - name: provisioning description: Status of requests made by the customer - name: Diagnostics description: '' - name: Activation Profiles description: API to manage activation profile related activities for a given account .
For more details please go to our help desk article [here](https://helpdesk.korewireless.com/hc/en-us/articles/360050144452-Activation-profiles) - name: Session description: Customers of KORE having Radius Accounting integrated at carrier level will have session events collected at KORE. Session START and STOP events are correlated, and data is exposed as Session API for consumption. This API also provides the session count for any duration within the last 7 days.Typical use cases would be 1) UI showing recent sessions against a subscription-id or iccid or msisdn in a paginated fashion. 2) Fetch session count so to generate alarms when a defined threshold is crossed. - name: subscription description: API provides subscription enquiries made by the customer. - name: account description: Account details of customer - name: testing description: APIs that are currently under testing - name: alerting description: APIs that provides alerts on subscribed events - name: Reports description: Customers of KORE who pre-configure report schedules have reports automatically generated and securely stored at the scheduled times — when accessed via API, they receive data in the agreed format, with internal integrity checks to guarantee authenticity. paths: /v1/accounts/{account-id}/plans: get: tags: - eligibility summary: Lists All Eligible Plans description: Get all eligible plans for an account operationId: getPlanByAccountId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: plans: type: array items: type: object properties: plan: type: object properties: plan-name: type: string description: The name of the plan $$ref: '#/components/schemas/plan-name' plan-id: type: string description: The unique identifier of your plan $$ref: '#/components/schemas/plan-id' plan-type-id: type: string usage-type: type: string description: Defines the usage type enum: - DATA - SMS - VOICE $$ref: '#/components/schemas/usage-type' service-type-id: type: string description: The unique identifier of the service type $$ref: '#/components/schemas/service-type-id' example: null $$ref: '#/components/schemas/PlanDetails_plan' $$ref: '#/components/schemas/PlanDetails' $$ref: '#/components/schemas/Plans' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/plans'' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/plans',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/plans\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/plans\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/plans',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/plans\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getPlanByAccountId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/plan-types: get: tags: - eligibility summary: Lists All Plan Types description: Get all plan types for an account operationId: getPlanTypeByAccountId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: plan-types: type: array items: type: object properties: plan-type-id: type: string plan-type-name: type: string example: null $$ref: '#/components/schemas/PlanTypes_plantypes' $$ref: '#/components/schemas/PlanTypes' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/plan-types'' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/plan-types',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/plan-types\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/plan-types\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/plan-types',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/plan-types\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getPlanTypeByAccountId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/plans/{plan-id}: get: tags: - eligibility summary: Finds Plan by PlanId description: Get details of a specific plan for an account operationId: getPlanByPlanId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string - name: plan-id in: path description: The unique identifier of your plan required: true style: simple explode: false schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: plan: type: object properties: plan-name: type: string description: The name of the plan $$ref: '#/components/schemas/plan-name' plan-id: type: string description: The unique identifier of your plan $$ref: '#/components/schemas/plan-id' plan-type-id: type: string usage-type: type: string description: Defines the usage type enum: - DATA - SMS - VOICE $$ref: '#/components/schemas/usage-type' service-type-id: type: string description: The unique identifier of the service type $$ref: '#/components/schemas/service-type-id' example: null $$ref: '#/components/schemas/PlanDetails_plan' $$ref: '#/components/schemas/PlanDetails' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}'' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getPlanByPlanId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/service-types: get: tags: - eligibility summary: Lists All Eligible Service Types description: Get all eligible service types for an account operationId: getServiceTypeByAccountId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: service-types: type: array items: type: object properties: service-type-id: type: string description: The unique identifier of the service type $$ref: '#/components/schemas/service-type-id' service-type-name: type: string $$ref: '#/components/schemas/ServiceType' $$ref: '#/components/schemas/ServiceTypes' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/service-types'' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/service-types',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/service-types\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/service-types\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/service-types',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/service-types\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getServiceTypeByAccountId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/service-types/{service-type-id}: get: tags: - eligibility summary: Finds ServiceType by ServiceTypeId description: Get details of a specific service type for an account operationId: getServiceTypeByServiceTypeId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string - name: service-type-id in: path description: The unique identifier of the service type required: true style: simple explode: false schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: service-type-id: type: string description: The unique identifier of the service type $$ref: '#/components/schemas/service-type-id' service-type-name: type: string $$ref: '#/components/schemas/ServiceType' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/service-types/{service-type-id}'' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/service-types/{service-type-id}',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/service-types/{service-type-id}\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/service-types/{service-type-id}\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/service-types/{service-type-id}',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/service-types/{service-type-id}\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getServiceTypeByServiceTypeId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/features: get: tags: - eligibility summary: Lists All Eligible Features description: Get all eligible features for an account operationId: getFeatureByAccountId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: features: type: array items: type: object properties: feature: type: object properties: usage-type: type: string description: Defines the usage type enum: - DATA - SMS - VOICE $$ref: '#/components/schemas/usage-type' feature-name: type: string description: The name of the feature $$ref: '#/components/schemas/feature-name' feature-id: type: string description: The unique identifier of your feature $$ref: '#/components/schemas/feature-id' description: type: string description: The description of the feature service-type-id: type: string description: The unique identifier of the service type $$ref: '#/components/schemas/service-type-id' $$ref: '#/components/schemas/Feature' example: null $$ref: '#/components/schemas/Features_features' $$ref: '#/components/schemas/Features' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/features'' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/features',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/features\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/features\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/features',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/features\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getFeatureByAccountId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/features/{feature-id}: get: tags: - eligibility summary: Finds Feature by FeatureId description: Get details of a specific feature for an account operationId: getFeatureByFeatureId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string - name: feature-id in: path description: The unique identifier of your feature required: true style: simple explode: false schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: usage-type: type: string description: Defines the usage type enum: - DATA - SMS - VOICE $$ref: '#/components/schemas/usage-type' feature-name: type: string description: The name of the feature $$ref: '#/components/schemas/feature-name' feature-id: type: string description: The unique identifier of your feature $$ref: '#/components/schemas/feature-id' description: type: string description: The description of the feature service-type-id: type: string description: The unique identifier of the service type $$ref: '#/components/schemas/service-type-id' $$ref: '#/components/schemas/Feature' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/features/{feature-id}'' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/features/{feature-id}',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/features/{feature-id}\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/features/{feature-id}\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/features/{feature-id}',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/features/{feature-id}\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getFeatureByFeatureId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/subscriptions/{subscription-id}/usage-records: get: tags: - usage summary: Finds Usage Records By Sim Number And Date Range description: Get usage records for a subscription operationId: getUsageRecordBySimNumberandDateRange parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string - name: subscription-id in: path description: The unique identifier for the SIM required: true style: simple explode: false schema: type: string - name: start-date in: query required: true style: form explode: true schema: type: string format: YYYY-MM-DD - name: end-date in: query description: Date range must fall in between 60 days required: true style: form explode: true schema: type: string format: YYYY-MM-DD - name: source in: query required: false style: form explode: true schema: type: string enum: - cdr - name: include-plan-name description: Indicates whether the Plan Name of which the device is in when the usages is incurred should be included in the Response. in: query required: false schema: type: boolean responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: source: type: string subscription-id: type: string example: cmp-k1-subscription-000000 data: type: object properties: total-usage: type: integer example: 172769726373 unit: type: string example: byte daily-usages: type: array items: type: object properties: date: type: string description: YYYY-MM-DD:HH:MM:SS format: dateTime example: '2022-10-24T00:00:00' total-usage: type: integer example: 3545683147 unit: type: string example: byte $$ref: '#/components/schemas/SingleFeatureUsageRecord_dailyusages' $$ref: '#/components/schemas/SingleFeatureUsageRecord' sms: type: object properties: total-usage: type: integer example: 172769726373 unit: type: string example: event daily-usages: type: array items: type: object properties: date: type: string description: YYYY-MM-DD:HH:MM:SS format: dateTime example: '2022-10-24T00:00:00' total-usage: type: integer example: 3545683147 unit: type: string example: event $$ref: '#/components/schemas/SingleFeatureUsageRecordSMS_dailyusages' $$ref: '#/components/schemas/SingleFeatureUsageRecordSMS' voice: type: object properties: total-usage: type: integer example: 172769726373 unit: type: string example: sec daily-usages: type: array items: type: object properties: date: type: string description: YYYY-MM-DD:HH:MM:SS format: dateTime example: '2022-10-24T00:00:00' total-usage: type: integer example: 3545683147 unit: type: string example: sec $$ref: '#/components/schemas/SingleFeatureUsageRecordVoice_dailyusages' $$ref: '#/components/schemas/SingleFeatureUsageRecordVoice' $$ref: '#/components/schemas/SimUsageRecord' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: StatusCode: type: integer Messages: type: array items: type: string ErrorMessages: type: array items: type: string $$ref: '#/components/schemas/5xx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/subscriptions/{subscription-id}/usage-records?start-date=&end-date=&source='' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/subscriptions/{subscription-id}/usage-records?start-date=&end-date=&source=',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/subscriptions/{subscription-id}/usage-records?start-date=&end-date=&source=\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/subscriptions/{subscription-id}/usage-records?start-date=&end-date=&source=\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/subscriptions/{subscription-id}/usage-records?start-date=&end-date=&source=',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/subscriptions/{subscription-id}/usage-records?start-date=&end-date=&source=\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getUsageRecordBySimNumberandDateRange security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/plans/{plan-id}/usage-records: get: tags: - usage summary: Finds Usage Records By PlanId description: Get usage records for a plan operationId: getUsageRecordByPlanId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string - name: plan-id in: path description: The unique identifier of your plan required: true style: simple explode: false schema: type: string - name: start-date in: query required: true style: form explode: true schema: type: string format: YYYY-MM-DD - name: end-date in: query description: Date range must fall in between 60 days required: true style: form explode: true schema: type: string format: YYYY-MM-DD - name: source in: query required: false style: form explode: true schema: type: string enum: - cdr responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: source: type: string plan-id: type: string total-usage: type: integer unit: type: string daily-usages: type: array items: type: object properties: date: type: string description: YYYY-MM-DD:HH:MM:SS format: dateTime example: '2022-10-24T00:00:00' total-usage: type: integer example: 3545683147 unit: type: string example: byte $$ref: '#/components/schemas/SingleFeatureUsageRecord_dailyusages' $$ref: '#/components/schemas/PlanUsageRecord' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}/usage-records?start-date=&end-date=&source='' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}/usage-records?start-date=&end-date=&source=',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}/usage-records?start-date=&end-date=&source=\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}/usage-records?start-date=&end-date=&source=\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}/usage-records?start-date=&end-date=&source=',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/plans/{plan-id}/usage-records?start-date=&end-date=&source=\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getUsageRecordByPlanId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/provisioning-requests: get: tags: - provisioning summary: Lists All Requests description: Get all requests made for an account operationId: getRequestStatusByAccountId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string - name: page in: query description: page number required: false style: form explode: true schema: type: integer - name: take in: query description: number of records required: false style: form explode: true schema: type: integer - name: subscription-id in: query required: false style: form explode: true schema: type: string - name: iccid in: query description: The ICCID of the subscription required: false style: form explode: true schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: total-records: type: integer total-pages: type: integer page: type: integer records: type: array items: type: object properties: provisioning-request-id: type: string date-completed: type: string format: dateTime request-status: type: string number-of-subscriptions: type: integer service-type: type: string date-created: type: string format: dateTime request-type: type: string source: type: string provisioned-by: type: string activation-profile-id: type: string example: null $$ref: '#/components/schemas/Requests_records' $$ref: '#/components/schemas/Requests' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests?page=&take=&subscription-id=&iccid='' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests?page=&take=&subscription-id=&iccid=',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests?page=&take=&subscription-id=&iccid=\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests?page=&take=&subscription-id=&iccid=\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests?page=&take=&subscription-id=&iccid=',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests?page=&take=&subscription-id=&iccid=\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getRequestStatusByAccountId security: - {} - Auth: [] - api_key: [] post: tags: - provisioning summary: Create A Provisioning Request description: "Create a provisioning request for an account
\nNote: New provisioning endpoints have been created, one endpoint per action, to simplify provisioning SIMs. The current endpoint will continue to work. \n- [Activate a SIM](https://developer.korewireless.com/api?product=Connectivity#post-/v1/accounts/-account-id-/provisioning-requests/activate)\n- [Change Plan for a SIM](https://developer.korewireless.com/api?product=Connectivity#post-/v1/accounts/-account-id-/provisioning-requests/plan-feature-change)\n- [Deactivate a SIM](https://developer.korewireless.com/api?product=Connectivity#post-/v1/accounts/-account-id-/provisioning-requests/deactivate)\n- [Reactivate a SIM](https://developer.korewireless.com/api?product=Connectivity#post-/v1/accounts/-account-id-/provisioning-requests/reactivate)\n- [Suspend a SIM](https://developer.korewireless.com/api?product=Connectivity#post-/v1/accounts/-account-id-/provisioning-requests/suspend)\n- [Terminate a SIM](https://developer.korewireless.com/api?product=Connectivity#post-/v1/accounts/-account-id-/provisioning-requests/terminate)\n" operationId: CreateProvisioningRequest parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string requestBody: description: create request body content: application/json: schema: oneOf: - type: object properties: suspend: type: object required: - subscriptions properties: subscriptions: type: array items: type: object properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/CommonInputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. description: Suspend a SIM. $$ref: '#/components/schemas/CommonInputSuspendProvisioningRequest_suspend' $$ref: '#/components/schemas/CommonInputSuspendProvisioningRequest' - type: object properties: activate: required: - activation-state - subscriptions type: object properties: subscriptions: type: array items: type: object properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription imei: type: string description: IMEI is mandatory for VZW non SKU and APEX activation $$ref: '#/components/schemas/CommonInputActivateProvisioningRequest_activate_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. activation-state: type: string enum: - active - test - ready activation-profile-id: type: string sku: type: string description: SKU is mandatory for VZW SKU activation service-type-info: properties: aus-ipnd-info: type: object description: IPND information is mandatory for KORE TELS2 Activation properties: title: type: string first-name: type: string last-name: type: string address: type: string description: activate a sim example: null $$ref: '#/components/schemas/CommonInputActivateProvisioningRequest_activate' $$ref: '#/components/schemas/CommonInputActivateProvisioningRequest' - type: object properties: deactivate: required: - subscriptions type: object properties: subscriptions: type: array items: type: object properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/CommonInputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. description: deactivate a sim example: null $$ref: '#/components/schemas/CommonInputDeactivateProvisioningRequest_deactivate' $$ref: '#/components/schemas/CommonInputDeactivateProvisioningRequest' - type: object properties: plan-feature-change: required: - activation-profile-id - subscriptions type: object properties: subscriptions: type: array items: type: object properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/CommonInputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request activation-profile-id: type: string mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. example: null $$ref: '#/components/schemas/CommonPlanChangeProvisioningRequest_planfeaturechange' $$ref: '#/components/schemas/CommonPlanChangeProvisioningRequest' - type: object properties: reactivate: required: - subscriptions type: object properties: subscriptions: type: array items: type: object properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/CommonInputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. example: null $$ref: '#/components/schemas/CommonReactivateProvisioningRequest_reactivate' $$ref: '#/components/schemas/CommonReactivateProvisioningRequest' - type: object properties: terminate: required: - subscriptions type: object properties: subscriptions: type: array items: type: object properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/CommonInputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. force-enabled-esim-profile-termination: type: boolean description: Force termination when eSIM subscription is enabled (on an EID with many ICCIDs) example: false example: null $$ref: '#/components/schemas/CommonTerminateProvisioningRequest_terminate' $$ref: '#/components/schemas/CommonTerminateProvisioningRequest' $$ref: '#/components/schemas/accountid_provisioningrequests_body' required: true responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string data: type: object properties: provisioning-request-id: type: string message: type: string example: null $$ref: '#/components/schemas/CreateRequest_data' $$ref: '#/components/schemas/CreateRequest' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"suspend\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n}'" - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"suspend\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n })\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"suspend\\\": {\\n \\\"subscriptions\\\": [\\n {\\n \\\"subscription-id\\\": \\\"\\\",\\n \\\"iccid\\\": \\\"\\\"\\n }\\n ],\\n \\\"mail-to\\\": \\\"\\\"\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"suspend\"\": {\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"subscription-id\"\": \"\"\"\"\" + \"\\n\",\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"mail-to\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"suspend\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend\"\n\npayload = json.dumps({\n \"suspend\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: CreateProvisioningRequest security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/provisioning-requests/suspend: post: tags: - provisioning summary: Suspend a SIM description: Suspend a SIM for an account operationId: SuspendASim parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: type: object properties: suspend: type: object required: - subscriptions properties: subscriptions: type: array items: properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/InputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. description: Suspend a SIM. $$ref: '#/components/schemas/InputSuspendProvisioningRequest_suspend' $$ref: '#/components/schemas/InputSuspendProvisioningRequest' required: true responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string data: type: object properties: provisioning-request-id: type: string message: type: string example: null $$ref: '#/components/schemas/CreateRequest_data' $$ref: '#/components/schemas/CreateRequest' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"suspend\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n}'" - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"suspend\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"suspend\\\": {\\n \\\"subscriptions\\\": [\\n {\\n \\\"subscription-id\\\": \\\"\\\",\\n \\\"iccid\\\": \\\"\\\"\\n }\\n ],\\n \\\"mail-to\\\": \\\"\\\"\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"suspend\"\": {\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"subscription-id\"\": \"\"\"\"\" + \"\\n\",\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"mail-to\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"suspend\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/suspend\"\n\npayload = json.dumps({\n \"suspend\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: SuspendASim security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/provisioning-requests/activate: post: tags: - provisioning summary: Activate a SIM description: Activate a SIM for an account operationId: ActivateASim parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: type: object properties: activate: required: - activation-state - subscriptions type: object properties: subscriptions: type: array items: properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription imei: type: string description: IMEI is mandatory for VZW non SKU and APEX activation $$ref: '#/components/schemas/InputActivateProvisioningRequest_activate_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. activation-state: type: string enum: - active - test - ready activation-profile-id: type: string sku: type: string description: SKU is mandatory for VZW SKU activation service-type-info: properties: aus-ipnd-info: type: object description: IPND information is mandatory for KORE TELS2 Activation properties: title: type: string first-name: type: string last-name: type: string address: type: string description: activate a sim example: null $$ref: '#/components/schemas/InputActivateProvisioningRequest_activate' $$ref: '#/components/schemas/InputActivateProvisioningRequest' required: true responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string data: type: object properties: provisioning-request-id: type: string message: type: string example: null $$ref: '#/components/schemas/CreateRequest_data' $$ref: '#/components/schemas/CreateRequest' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/activate' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"activate\": {\n \"activation-state\": \"\",\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\",\n \"imei\": \"\"\n }\n ],\n \"mail-to\": \"\",\n \"activation-profile-id\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\",\n \"address\": \"\"\n }\n }\n }\n}'" - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/activate',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"activate\": {\n \"activation-state\": \"\",\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\":\"\",\n \"imei\": \"\"\n }\n ],\n \"mail-to\": \"\",\n \"activation-profile-id\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\",\n \"address\": \"\"\n }\n }\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"activate\\\": {\\n \\\"activation-state\\\": \\\"\\\",\\n \\\"subscriptions\\\": [\\n {\\n \\\"subscription-id\\\": \\\"\\\",\\n \\\"iccid\\\": \\\"\\\"\\n ,\\n \\\"imei\\\": \\\"\\\"\\n \\n }\\n ],\\n \\\"mail-to\\\": \\\"\\\",\\n \\\"activation-profile-id\\\": \\\"\\\",\\n \\\"sku\\\": \\\"\\\",\\n \\\"service-type-info\\\": {\\n \\\"aus-ipnd-info\\\": {\\n \\\"title\\\": \\\"\\\",\\n \\\"first-name\\\": \\\"\\\",\\n \\\"last-name\\\": \\\"\\\",\\n \\\"address\\\": \\\"\\\"\\n }\\n }\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/activate\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/activate\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"activate\"\": {\" + \"\\n\" +\n@\" \"\"activation-state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"subscription-id\"\": \"\"\"\"\" + \"\\n\",\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" ,\" + \"\\n\" +\n@\" \"\"imei\"\": \"\"\"\"\" + \"\\n\" +\n@\" \" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"mail-to\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"activation-profile-id\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"sku\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"service-type-info\"\": {\" + \"\\n\" +\n@\" \"\"aus-ipnd-info\"\": {\" + \"\\n\" +\n@\" \"\"title\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"first-name\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"last-name\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"address\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/activate',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"activate\": {\n \"activation-state\": \"\",\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\",\n \"imei\": \"\" \n }\n ],\n \"mail-to\": \"\",\n \"activation-profile-id\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\",\n \"address\": \"\"\n }\n }\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/activate\"\n\npayload = json.dumps({\n \"activate\": {\n \"activation-state\": \"\",\n \"subscriptions\": [\n {\n \"subscription-id\":\"\",\n \"iccid\": \"\",\n \"imei\": \"\" \n } \n ],\n \"mail-to\": \"\",\n \"activation-profile-id\": \"\",\n \"sku\": \"\",\n \"service-type-info\": {\n \"aus-ipnd-info\": {\n \"title\": \"\",\n \"first-name\": \"\",\n \"last-name\": \"\",\n \"address\": \"\"\n }\n }\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: ActivateASim security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/provisioning-requests/deactivate: post: tags: - provisioning summary: Deactivate a SIM description: Deactivate a SIM for an account operationId: DeactivateASim parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: type: object properties: deactivate: required: - subscriptions type: object properties: subscriptions: type: array items: properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/InputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. description: deactivate a sim example: null $$ref: '#/components/schemas/InputDeactivateProvisioningRequest_deactivate' $$ref: '#/components/schemas/InputDeactivateProvisioningRequest' required: true responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string data: type: object properties: provisioning-request-id: type: string message: type: string example: null $$ref: '#/components/schemas/CreateRequest_data' $$ref: '#/components/schemas/CreateRequest' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/deactivate' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"deactivate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n}'" - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/deactivate',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"deactivate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"deactivate\\\": {\\n \\\"subscriptions\\\": [\\n {\\n \\\"subscription-id\\\":\\\"\\\"\\n ,\\n \\\"iccid\\\": \\\"\\\"\\n \\n }\\n ],\\n \\\"mail-to\\\": \\\"\\\"\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/deactivate\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/deactivate\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"deactivate\"\": {\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"subscription-id\"\": \"\"\"\"\" + \"\\n\" +\n@\" ,\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" \" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"mail-to\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/deactivate',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"deactivate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/deactivate\"\n\npayload = json.dumps({\n \"deactivate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: DeactivateASim security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/provisioning-requests/plan-feature-change: post: tags: - provisioning summary: Change Plan for a SIM description: Change plan for a SIM of an account operationId: PlanChangeForASim parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: type: object properties: plan-feature-change: required: - activation-profile-id - subscriptions type: object properties: subscriptions: type: array items: properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/InputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request activation-profile-id: type: string mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. example: null $$ref: '#/components/schemas/PlanChangeProvisioningRequest_planfeaturechange' $$ref: '#/components/schemas/PlanChangeProvisioningRequest' required: true responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string data: type: object properties: provisioning-request-id: type: string message: type: string example: null $$ref: '#/components/schemas/CreateRequest_data' $$ref: '#/components/schemas/CreateRequest' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/plan-feature-change' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"plan-feature-change\": {\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n}'" - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/plan-feature-change',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"plan-feature-change\": {\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"subscription-id\":\"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"plan-feature-change\\\": {\\n \\\"activation-profile-id\\\": \\\"\\\",\\n \\\"subscriptions\\\": [\\n {\\n \\\"subscription-id\\\": \\\"\\\",\\n \\\"iccid\\\": \\\"\\\"\\n }\\n ],\\n \\\"mail-to\\\": \\\"\\\"\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/plan-feature-change\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/plan-feature-change\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"plan-feature-change\"\": {\" + \"\\n\" +\n@\" \"\"activation-profile-id\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"subscription-id\"\": \"\"\"\"\" + \"\\n\",\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"mail-to\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/plan-feature-change',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"plan-feature-change\": {\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\" \n }\n ],\n \"mail-to\": \"\"\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/plan-feature-change\"\n\npayload = json.dumps({\n \"plan-feature-change\": {\n \"activation-profile-id\": \"\",\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: PlanChangeForASim security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/provisioning-requests/reactivate: post: tags: - provisioning summary: Reactivate a SIM description: Reactivate a SIM for an account operationId: ReactivateASim parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: type: object properties: reactivate: required: - subscriptions type: object properties: subscriptions: type: array items: properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/InputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. example: null $$ref: '#/components/schemas/ReactivateProvisioningRequest_reactivate' $$ref: '#/components/schemas/ReactivateProvisioningRequest' required: true responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string data: type: object properties: provisioning-request-id: type: string message: type: string example: null $$ref: '#/components/schemas/CreateRequest_data' $$ref: '#/components/schemas/CreateRequest' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/reactivate' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"reactivate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n}'" - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/reactivate',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"reactivate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"reactivate\\\": {\\n \\\"subscriptions\\\": [\\n {\\n \\\"subscription-id\\\": \\\"\\\",\\n \\\"iccid\\\": \\\"\\\"\\n }\\n ],\\n \\\"mail-to\\\": \\\"\\\"\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/reactivate\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/reactivate\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"reactivate\"\": {\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"subscription-id\"\": \"\"\"\"\" + \"\\n\",\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"mail-to\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/reactivate',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"reactivate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\" \n }\n ],\n \"mail-to\": \"\"\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/reactivate\"\n\npayload = json.dumps({\n \"reactivate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\"\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: ReactivateASim security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/provisioning-requests/terminate: post: tags: - provisioning summary: Terminate a SIM description: Terminate a SIM for an account operationId: TerminateASim parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: type: object properties: terminate: required: - subscriptions type: object properties: subscriptions: type: array items: properties: subscription-id: type: string description: The subscription-id of the SIM iccid: type: string description: The ICCID of the subscription $$ref: '#/components/schemas/InputSuspendProvisioningRequest_suspend_subscriptions' description: Either __'subscription-id'__ or __'iccid'__ is required in the request mail-to: type: string description: Optional field that provides email notifications of all status changes for this request. To send to multiple addresses (20 maximum), add a comma (,) between each email address. force-enabled-esim-profile-termination: type: boolean description: Force termination when eSIM subscription is enabled (on an EID with many ICCIDs) example: false example: null $$ref: '#/components/schemas/TerminateProvisioningRequest_terminate' $$ref: '#/components/schemas/TerminateProvisioningRequest' required: true responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string data: type: object properties: provisioning-request-id: type: string message: type: string example: null $$ref: '#/components/schemas/CreateRequest_data' $$ref: '#/components/schemas/CreateRequest' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/terminate' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"terminate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\",\n \"force-enabled-esim-profile-termination\": \"\"\n }\n}'" - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/terminate',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"terminate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\",\n \"force-enabled-esim-profile-termination\": \"\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"terminate\\\": {\\n \\\"subscriptions\\\": [\\n {\\n \\\"subscription-id\\\": \\\"\\\",\\n \\\"iccid\\\": \\\"\\\"\\n }\\n ],\\n \\\"mail-to\\\": \\\"\\\",\\n \\\"force-enabled-esim-profile-termination\\\": \\\"\\\"\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/terminate\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/terminate\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"terminate\"\": {\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"subscription-id\"\": \"\"\"\"\" + \"\\n\",\" + \"\\n\" +\n@\" \"\"iccid\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"mail-to\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"force-enabled-esim-profile-termination\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/terminate',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"terminate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\",\n \"force-enabled-esim-profile-termination\": \"\"\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/terminate\"\n\npayload = json.dumps({\n \"terminate\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"iccid\": \"\"\n }\n ],\n \"mail-to\": \"\",\n \"force-enabled-esim-profile-termination\": \"\"\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: TerminateASim security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/provisioning-requests/{provisioning-request-id}: get: tags: - provisioning summary: Finds Request Status By ProvisioningRequestId description: Get details of a specific request made operationId: getRequestStatusByProvisioningRequestId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string - name: provisioning-request-id in: path required: true style: simple explode: false schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: request-type: type: object properties: subscriptions: type: array items: type: object properties: subscription-id: type: string iccid: type: string description: The ICCID of the subscription completion-status: type: string error-message: type: string example: null $$ref: '#/components/schemas/RequestStatus_requesttype_subscriptions' status: type: string description: ' submitted -- Request is submitted via api and got the acknowledgement back, failed -- Request creation failed, pending -- Request is created, completed -- Request is completed ' enum: - submitted - failed - pending - completed provisioning-request-id: type: string date-completed: type: string description: YYY:MM:DD:HH:MM:SS format: dateTime example: '2022-10-24T00:00:00' service-type: type: string number-of-subscriptions: type: integer date-created: type: string description: YYYY-MM-DD:HH:MM:SS format: dateTime example: '2022-10-24T00:00:00' request-type: type: string provisioned-by: type: string account-id: type: string activation-profile-id: type: string description: __Allowed:__ Activation | StateChange | Deactivation | Reactivation | PlanChange | ProfileChange example: null $$ref: '#/components/schemas/RequestStatus_requesttype' $$ref: '#/components/schemas/RequestStatus' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '409': description: Request Conflict headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: status: type: string errorMessage: type: string $$ref: '#/components/schemas/400_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '502': description: Bad Gateway headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '503': description: Service Unavailable headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '504': description: Gateway Timeout headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/{provisioning-request-id}'' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/{provisioning-request-id}',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/{provisioning-request-id}\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/{provisioning-request-id}\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/{provisioning-request-id}',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/provisioning-requests/{provisioning-request-id}\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getRequestStatusByProvisioningRequestId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/subscriptions: get: tags: - subscription summary: Lists All Subscription Details description: Get details on all subscriptions for an account operationId: getSubscriptionsByAccountId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string - name: page-index in: query description: page index starting with zero required: true style: form explode: true schema: type: integer - name: max-page-item in: query description: maximum 1000 records per page required: true style: form explode: true schema: type: integer - name: sort-field in: query description: the values are case-sensitive, if not specified, will be sorted based on created time. required: false style: form explode: true schema: type: string enum: - subscription-id - iccid - service-type-id - cost-center-id - name: sort-direction in: query description: the values are case-sensitive required: false style: form explode: true schema: type: string default: Desc enum: - Asc - Desc - name: imsi in: query required: false style: form explode: true schema: type: string - name: imei in: query required: false style: form explode: true schema: type: string - name: iccid in: query description: 'Please note to add iccids using comma separators and upto max of 100.
eg: 8765367892,856326787,8456095345,.....' required: false style: form explode: true schema: type: string - name: eid in: query description: 32 - digit unique identifier for the eSIM required: false style: form explode: true schema: type: string - name: sim-state in: query required: false style: form explode: true schema: type: string - name: msisdn in: query required: false style: form explode: true schema: type: string - name: show-state-history in: query description: default - false required: false style: form explode: true schema: type: boolean default: false enum: - true - false - name: last-modified-from in: query required: false description: 'Date from which subscription was last modified,eg: 2023-02-23T11:20:04.077Z' style: form explode: true schema: type: string - name: last-modified-to in: query required: false style: form description: 'Date to which subscription was last modified,eg: 2023-02-23T11:20:04.077Z' explode: true schema: type: string responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: page-info-result: type: object properties: total-count: type: integer page-index: type: integer max-page-item: type: integer example: null $$ref: '#/components/schemas/Subscriptions_pageinforesult' subscriptions: type: array items: type: object properties: subscription-id: type: string iccid: type: string description: The ICCID of the subscription eid: type: string description: The EID of a subscription, blank means this is not an esim example: '00000000000000000000000000000000' rsp-state: type: string description: State of the profile in eSIM example: enabled product-offer: type: string description: combination of plans, features and sim format types product-offer-type: type: string description: Differentiates the product offer types bewteen the manufacturers imei: type: string description: The unique identifier of the device the SIM is connected too imsi: type: string description: The unique identifier of the subscription on the network serial: type: string description: The serial number of the device attached to the SIM model: type: string description: The model number of the device attached to the SIM msisdns: type: array items: type: object properties: msisdn: type: string description: The phone number attached to the subscription example: null $$ref: '#/components/schemas/SubscriptionDetails_msisdns' last-active-profile: type: array description: The last known profile per state of the SIM items: type: object properties: profile-id: type: integer start-datetime-utc: type: string $$ref: '#/components/schemas/SubscriptionDetails_lastactiveprofile' last-active-imsi-msisdn: type: array description: The last known imsi msidn per state of the SIM items: type: object properties: msisdn: type: string imsi: type: string start-datetime-utc: type: string $$ref: '#/components/schemas/SubscriptionDetails_lastactiveimsimsisdn' last-effective-date-of-states: type: array description: The last known effective date per state of the SIM items: type: object properties: state: type: string start-date-time-utc: type: string example: null $$ref: '#/components/schemas/SubscriptionDetails_lasteffectivedateofstates' service-type-id: type: string description: The unique identifier of the service type $$ref: '#/components/schemas/service-type-id' states: type: array description: The state of the subscription items: type: object properties: state: type: string enum: - Stock - Active - Suspend - Suspend With Charge - Deactivated - Pending Scrap - Scrapped - Barred state-id: type: string start-datetime-utc: type: string format: date end-datetime-utc: type: string format: date is-current: type: boolean example: null $$ref: '#/components/schemas/SubscriptionDetails_states' cost-center-id: type: string description: The unique identifier of your cost center $$ref: '#/components/schemas/cost-center-id' profiles: type: array items: type: object properties: profile-id: type: string description: The unique identifier of the feature-plan combination $$ref: '#/components/schemas/profile-id' start-datetime-utc: type: string format: date end-datetime-utc: type: string format: date is-current: type: boolean example: null $$ref: '#/components/schemas/SubscriptionDetails_profiles' apn-data: type: array items: type: object properties: ip-address: type: string description: The address of the subscription apn-id: type: string example: null $$ref: '#/components/schemas/SubscriptionDetails_apndata' additional-fields: type: array description: A set of customer defined customer fields (key/value pairs) items: type: object properties: key: type: string value: type: string example: null $$ref: '#/components/schemas/SubscriptionDetails_additionalfields' $$ref: '#/components/schemas/SubscriptionDetails' $$ref: '#/components/schemas/Subscriptions' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' x-code-samples: - lang: cURL label: cURL source: 'curl --location --globoff ''{{baseUrl}}/v1/accounts/{account-id}/subscriptions?page-index=&max-page-item=&sort-field=&sort-direction=Desc&imsi=&imei=&iccid=&eid=&sim-state=&msisdn=&show-state-history=false&last-modified-from=&last-modified-to='' \ --header ''Accept: application/json''' - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'GET',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/subscriptions?page-index=&max-page-item=&sort-field=&sort-direction=Desc&imsi=&imei=&iccid=&eid=&sim-state=&msisdn=&show-state-history=false&last-modified-from=&last-modified-to=',\n 'headers': {\n 'Accept': 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/subscriptions?page-index=&max-page-item=&sort-field=&sort-direction=Desc&imsi=&imei=&iccid=&eid=&sim-state=&msisdn=&show-state-history=false&last-modified-from=&last-modified-to=\")\n .method(\"GET\", body)\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/subscriptions?page-index=&max-page-item=&sort-field=&sort-direction=Desc&imsi=&imei=&iccid=&eid=&sim-state=&msisdn=&show-state-history=false&last-modified-from=&last-modified-to=\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Get);\nrequest.AddHeader(\"Accept\", \"application/json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/subscriptions?page-index=&max-page-item=&sort-field=&sort-direction=Desc&imsi=&imei=&iccid=&eid=&sim-state=&msisdn=&show-state-history=false&last-modified-from=&last-modified-to=',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer ',\n 'x-api-key: ')\n CURLOPT_HTTPHEADER => array(\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/subscriptions?page-index=&max-page-item=&sort-field=&sort-direction=Desc&imsi=&imei=&iccid=&eid=&sim-state=&msisdn=&show-state-history=false&last-modified-from=&last-modified-to=\"\n\npayload = {}\nheaders = {\n 'Accept': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" __originalOperationId: getSubscriptionsByAccountId security: - {} - Auth: [] - api_key: [] /v1/accounts/{account-id}/subscription-requests: post: tags: - subscription summary: Update Subscription Details description: Create a subscription request to update Subscriptions operationId: updateSubscriptionsBySubscriptionId parameters: - name: account-id in: path description: The unique identifier of your account required: true style: simple explode: false schema: type: string requestBody: description: update subscriptions content: application/json: schema: required: - subscription-request type: object properties: subscription-request: required: - subscriptions type: object properties: subscriptions: type: array items: required: - subscription-id type: object properties: subscription-id: type: string additional-fields: type: array items: type: object properties: key: type: string value: type: string example: null $$ref: '#/components/schemas/UpdateSubscription_subscriptionrequest_additionalfields' example: null $$ref: '#/components/schemas/UpdateSubscription_subscriptionrequest_subscriptions' example: null $$ref: '#/components/schemas/UpdateSubscription_subscriptionrequest' $$ref: '#/components/schemas/UpdateSubscription' required: true responses: '200': description: 200 response headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: subscription-request-id: type: string subscription-request-type: type: array items: type: string subscription-request-status: type: string $$ref: '#/components/schemas/UpdatedSubscription' '400': description: Bad Request headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: oneOf: - type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' - type: object properties: subscription-request-id: type: string subscription-request-type: type: array items: type: string subscription-request-status: type: string error: type: object properties: code: type: integer message: type: string status: type: string example: null $$ref: '#/components/schemas/subscription_Error_error' $$ref: '#/components/schemas/subscription_Error' $$ref: '#/components/schemas/inline_response_400' '401': description: Unauthorised User headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: required: - error - message type: object properties: error: type: integer format: int32 message: type: string $$ref: '#/components/schemas/Error' '403': description: Forbidden headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: message: type: string $$ref: '#/components/schemas/xxx_Error' '404': description: The Specified Resource Was Not Found headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: INFO: type: string $$ref: '#/components/schemas/NotFound_Error' '500': description: Server Error headers: Access-Control-Allow-Origin: style: simple explode: false schema: type: string Access-Control-Allow-Methods: style: simple explode: false schema: type: string Access-Control-Allow-Credentials: style: simple explode: false schema: type: string Access-Control-Allow-Headers: style: simple explode: false schema: type: string content: application/json: schema: type: object properties: subscription-request-id: type: string subscription-request-type: type: array items: type: string subscription-request-status: type: string error: type: object properties: code: type: integer message: type: string status: type: string example: null $$ref: '#/components/schemas/subscription_Error_error' $$ref: '#/components/schemas/subscription_Error' x-code-samples: - lang: cURL label: cURL source: "curl --location --globoff '{{baseUrl}}/v1/accounts/{account-id}/subscription-requests' \\\n--header 'Content-Type: application/json'\n--header 'Authorization: Bearer ' \n--header 'x-api-key: '\n--header 'Accept: application/json' \\\n--data '{\n \"subscription-request\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"additional-fields\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}'" - lang: js label: NodeJs source: "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': '{{baseUrl}}/v1/accounts/{account-id}/subscription-requests',\n 'headers': {\n 'Content-Type': 'application/json',\n 'Accept': 'application/json'\n },\n body: JSON.stringify({\n \"subscription-request\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"additional-fields\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n })\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n" - lang: java label: Java source: "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"subscription-request\\\": {\\n \\\"subscriptions\\\": [\\n {\\n \\\"subscription-id\\\": \\\"\\\",\\n \\\"additional-fields\\\": [\\n {\\n \\\"key\\\": \\\"\\\",\\n \\\"value\\\": \\\"\\\"\\n } \\n]\\n }\\n ]\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"{{baseUrl}}/v1/accounts/{account-id}/subscription-requests\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Bearer \")\n .addHeader(\"x-api-key\", \"\")\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"Accept\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" - lang: cs label: C# source: "var options = new RestClientOptions(\"{{baseUrl}}/v1/accounts/{account-id}/subscription-requests\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"\", Method.Post);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"Accept\", \"application/json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"subscription-request\"\": {\" + \"\\n\" +\n@\" \"\"subscriptions\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"subscription-id\"\": \"\"\"\"\", \" + \"\\n\" +\n@\" \"\"additional-fields\"\": [ \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"key\"\": \"\"\"\"\", \"\\n\" +\n@\" \"\"value\"\": \"\"\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ] }\" + \"\\n\" +\n@\" ]\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" - lang: PHP label: Php source: " '{{baseUrl}}/v1/accounts/{account-id}/subscription-requests',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization: Bearer ',\n 'x-api-key: '),\n CURLOPT_POSTFIELDS =>'{\n \"subscription-request\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"additional-fields\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Accept: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" - lang: py label: Python source: "import requests\nimport json\n\nurl = \"{{baseUrl}}/v1/accounts/{account-id}/subscription-requests\"\n\npayload = json.dumps({\n \"subscription-request\": {\n \"subscriptions\": [\n {\n \"subscription-id\": \"\",\n \"additional-fields\":[\n {\n \"key\": \"