KORE Wireless Subscription API

API provides subscription enquiries made by the customer.

Operations 8

GET /v1/accounts/{account-id}/subscriptions Lists All Subscription Details #
POST /v1/accounts/{account-id}/subscription-requests Update Subscription Details #
POST /v1/accounts/{account-id}/subscription-requests/connected-hardware Update Connected Hardware Details #
POST /v1/accounts/{account-id}/subscription-requests/sim-transfer Transfer a SIM
GET /v1/accounts/{account-id}/subscriptions/{subscription-id} Finds Subscription Details For Given SubscriptionId #
GET /v1/accounts/{account-id}/subscription-requests/{subscription-request-id} Finds Subscription Request For Given ID #
POST /v1/accounts/{account-id}/subscription-requests/cost-center Update Subscription Cost Center
GET /v1/accounts/{account-id}/profiles/{profile-id} Finds Profile Details By ProfileId #

Documentation

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/kore-wireless-subscription-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kore-wireless-subscription-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Connectivity Subscription API
  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: subscription
  description: API provides subscription enquiries made by the customer.
paths:
  /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.<br /> 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=<integer>&max-page-item=<integer>&sort-field=<string>&sort-direction=Desc&imsi=<string>&imei=<string>&iccid=<string>&eid=<string>&sim-state=<string>&msisdn=<string>&show-state-history=false&last-modified-from=<string>&last-modified-to=<string>'' \

          --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=<integer>&max-page-item=<integer>&sort-field=<string>&sort-direction=Desc&imsi=<string>&imei=<string>&iccid=<string>&eid=<string>&sim-state=<string>&msisdn=<string>&show-state-history=false&last-modified-from=<string>&last-modified-to=<string>',\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=<integer>&max-page-item=<integer>&sort-field=<string>&sort-direction=Desc&imsi=<string>&imei=<string>&iccid=<string>&eid=<string>&sim-state=<string>&msisdn=<string>&show-state-history=false&last-modified-from=<string>&last-modified-to=<string>\")\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=<integer>&max-page-item=<integer>&sort-field=<string>&sort-direction=Desc&imsi=<string>&imei=<string>&iccid=<string>&eid=<string>&sim-state=<string>&msisdn=<string>&show-state-history=false&last-modified-from=<string>&last-modified-to=<string>\")\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: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n   CURLOPT_URL => '{{baseUrl}}/v1/accounts/{account-id}/subscriptions?page-index=<integer>&max-page-item=<integer>&sort-field=<string>&sort-direction=Desc&imsi=<string>&imei=<string>&iccid=<string>&eid=<string>&sim-state=<string>&msisdn=<string>&show-state-history=false&last-modified-from=<string>&last-modified-to=<string>',\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 <YOUR BEARER TOKEN>',\n   'x-api-key: <YOUR 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=<integer>&max-page-item=<integer>&sort-field=<string>&sort-direction=Desc&imsi=<string>&imei=<string>&iccid=<string>&eid=<string>&sim-state=<string>&msisdn=<string>&show-state-history=false&last-modified-from=<string>&last-modified-to=<string>\"\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 <YOUR BEARER TOKEN>' \n--header 'x-api-key: <YOUR API KEY>'\n--header 'Accept: application/json' \\\n--data '{\n  \"subscription-request\": {\n    \"subscriptions\": [\n       {\n        \"subscription-id\": \"<string>\",\n        \"additional-fields\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\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      \"su

# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kore-wireless/refs/heads/main/openapi/kore-wireless-subscription-api-openapi.yml