List all Subscriptions

GET /v1/subscriptions

The subscriptions are returned sorted by the specified sortPropertyName. Available to the roles: csp

Headers

  • X-Tenant string Required

    This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Query parameters

  • pageNumber integer(int32)

    A cursor for pagination across multiple pages of results. The default value is 1.

  • pageSize integer(int32)

    The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.

  • The search query string.

  • The name of the property to sort the customers by. Possible values: Offer.Name, Status, StartDate or EndDate

  • if set to true [ascending order].

Responses

GET /v1/subscriptions
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/subscriptions \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200)
{
  "items": [
    {
      "id": "string",
      "orderId": "string",
      "offerId": "string",
      "customerId": "string",
      "providerInstanceId": "string",
      "resellerId": "string",
      "subscriptionName": "string",
      "offerName": "string",
      "offerType": {
        "name": "string"
      },
      "isAddonOffer": true,
      "isTrialOffer": true,
      "providerOfferId": "string",
      "subscriptionStatus": {
        "name": "string"
      },
      "startDate": "2024-05-04T09:42:00+00:00",
      "endDate": "2024-05-04T09:42:00+00:00",
      "cancellationAllowedUntil": "2024-05-04T09:42:00+00:00",
      "quantity": 42,
      "listPrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "revenuePrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "erpPrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "customMargin": {
        "marginRule": {
          "name": "string"
        },
        "value": 42.0
      },
      "billingFrequency": {
        "name": "string"
      },
      "billingType": {
        "name": "string"
      },
      "termDuration": {
        "name": "string"
      },
      "segment": {
        "name": "string"
      },
      "parentSubscriptionId": "string",
      "providerSubscriptionId": "string",
      "autoRenewal": true,
      "providerData": "string",
      "internalId": "string"
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}
Response examples (200)
{
  "items": [
    {
      "id": "string",
      "orderId": "string",
      "offerId": "string",
      "customerId": "string",
      "providerInstanceId": "string",
      "resellerId": "string",
      "subscriptionName": "string",
      "offerName": "string",
      "offerType": {
        "name": "string"
      },
      "isAddonOffer": true,
      "isTrialOffer": true,
      "providerOfferId": "string",
      "subscriptionStatus": {
        "name": "string"
      },
      "startDate": "2024-05-04T09:42:00+00:00",
      "endDate": "2024-05-04T09:42:00+00:00",
      "cancellationAllowedUntil": "2024-05-04T09:42:00+00:00",
      "quantity": 42,
      "listPrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "revenuePrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "erpPrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "customMargin": {
        "marginRule": {
          "name": "string"
        },
        "value": 42.0
      },
      "billingFrequency": {
        "name": "string"
      },
      "billingType": {
        "name": "string"
      },
      "termDuration": {
        "name": "string"
      },
      "segment": {
        "name": "string"
      },
      "parentSubscriptionId": "string",
      "providerSubscriptionId": "string",
      "autoRenewal": true,
      "providerData": "string",
      "internalId": "string"
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}