---
agentTools:
  projectIndex: https://worldbox-api.readme.io/llms.txt
---

# Show Subscription

Show the subscription data

[block:api-header]
{
  "title": "Response"
}
[/block]

Among the attributes that differ to [List Subscription](docs:list-subscriptions)

[block:parameters]
{
  "data": {
    "h-0": "Attributes",
    "h-1": "Description",
    "0-0": "index",
    "0-1": "The list of win numbers for companies in the pool. For all these winning numbers you will receive a company report in your subscription."
  },
  "cols": 2,
  "rows": 1
}
[/block]

For more company details for a certain win number. Please use the [Company Information Endpoint](https://worldbox-api.readme.io/docs/companieswin)

[block:callout]
{
  "type": "danger",
  "title": "Long response time",
  "body": "Please be aware for subscriptions with several thousands of companies in the index like the CRR440, the response can get somehow slow. Please increase your system request time out."
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://testapi.worldbox.ch/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/subscription/{itemnumber}": {
      "get": {
        "summary": "Show Subscription",
        "description": "Show the subscription data",
        "operationId": "show-subscription",
        "parameters": [
          {
            "name": "itemnumber",
            "in": "path",
            "description": "The itemnumber of the subscription. Check your order details",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "index",
            "in": "query",
            "description": "Show the company index. the index includes a list of company win numbers available for this subscription",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"index\": \"CH0000019666,CH0000023111,CH0000024284,CH0000024372,CH0000024386,CH0000026284,CH0000027329,CH0000030379,CH0000033379,CH0000033384,CH0000033398,CH0000033401,CH0000033415,CH0000033429,CH0000033448,CH0000033453,CH0000033467,CH0000033472,CH0000033486,CH0000033491,CH0000033503,CH0000033517,CH0000033522,CH0000033536,CH0000033541,CH0000033555,CH0000033569,CH0000033574,CH0000033593,CH0000033605,CH0000033619,CH0000033624,CH0000033638,CH0000033657,CH0000033662,CH0000033676,CH0000033681,CH0000033695,CH0000033707,CH0000033712,CH0000033731,...\",\n    \"subscription\": {\n        \"language\": \"EN\",\n        \"itemnumber\": \"1711B1222\",\n        \"customerreference\": \"Your referencenumber\",\n        \"enddate\": \"2018-11-14T17:18:31Z\",\n        \"startdate\": \"2017-11-14T17:18:31Z\",\n        \"additionalinfo\": \"Some info for our stuff\",\n        \"name\": \"Swiss Energy\",\n        \"productcode\": \"CRB210\",\n        \"format\": \"XML\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "index": {
                      "type": "string",
                      "example": "CH0000019666,CH0000023111,CH0000024284,CH0000024372,CH0000024386,CH0000026284,CH0000027329,CH0000030379,CH0000033379,CH0000033384,CH0000033398,CH0000033401,CH0000033415,CH0000033429,CH0000033448,CH0000033453,CH0000033467,CH0000033472,CH0000033486,CH0000033491,CH0000033503,CH0000033517,CH0000033522,CH0000033536,CH0000033541,CH0000033555,CH0000033569,CH0000033574,CH0000033593,CH0000033605,CH0000033619,CH0000033624,CH0000033638,CH0000033657,CH0000033662,CH0000033676,CH0000033681,CH0000033695,CH0000033707,CH0000033712,CH0000033731,..."
                    },
                    "subscription": {
                      "type": "object",
                      "properties": {
                        "language": {
                          "type": "string",
                          "example": "EN"
                        },
                        "itemnumber": {
                          "type": "string",
                          "example": "1711B1222"
                        },
                        "customerreference": {
                          "type": "string",
                          "example": "Your referencenumber"
                        },
                        "enddate": {
                          "type": "string",
                          "example": "2018-11-14T17:18:31Z"
                        },
                        "startdate": {
                          "type": "string",
                          "example": "2017-11-14T17:18:31Z"
                        },
                        "additionalinfo": {
                          "type": "string",
                          "example": "Some info for our stuff"
                        },
                        "name": {
                          "type": "string",
                          "example": "Swiss Energy"
                        },
                        "productcode": {
                          "type": "string",
                          "example": "CRB210"
                        },
                        "format": {
                          "type": "string",
                          "example": "XML"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "text",
              "code": "http://testapi.worldbox.ch/v1/subscription/1711B0459"
            }
          ],
          "samples-languages": [
            "text"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6303ce04ea33c13c8859c3a3:5a0b2aafe9ae000010ad62c7"
}
```