Get subscription upgrade eligibility

Get subscription upgrade eligibility.



To get subscription upgrades eligibility, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.

Then call Subscriptions.GetTransitionEligibilities() method to get subscription upgrade eligibility by passing token and eligibilityType.

var subscriptionId = <organization id>;
var client = new CrayonApiClient("");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;

var result = client.Subscriptions.GetTransitionEligibilities(token, eligibilityType);


Request Syntax:

Method Request URI

Request Parameters:

Name Type Description
eligibilityType string Eligibility Type

Request Headers:

The following HTTP request headers are supported

Header Type Description
Authorization string Required. The authorization token in the form Bearer <token>.
Accept string Specifies the request and response type, “application/json”.
Content-Type string Specifies the media type of the resource, “application/json”.

Request Example:

POST $"{subscriptionId}/transition-eligibilities/{eligibilityType}"
Accept: application/json
Content-Type: application/json
Authorization: Bearer < Token >


If successful, this method returns collection of SubscriptionTransitionEligibility resource in the response body.

Response Body:

    "catalogItemId": "string",
    "title": "string",
    "description": "string",
    "quantity": 0,
    "eligibilities": [
        "errors": [
            "code": 0,
            "description": "string"
        "isEligible": true,
        "transitionType": "string"

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

Error Codes Description
200 Ok The request has succeeded.
400 Bad Request The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn’t be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications.
401 Unauthorized The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.
404 Not Found The server has not found anything matching the request.