v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB

Subscriptions

Gets a list of subscription billing options and related data from active subscriptions

Billing options of inactive subscriptions are not returned, as they can not be purchased.

Licenses Required

Vista.Ocapi
Vista.Subscriptions

get/ocapi/v1/subscription-billing-options

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "billingOptions": [
    {
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "description": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "shortName": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    }
  ],
  "relatedData": {
    "subscriptions": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "discounts": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ]
  }
}