Get subscription addon offers

Returns a collection of subscription addon offers.


  • Credentials as described in Authentication
  • SubscriptionId represents Id of subscription for which addon offers is requested


To get addon offers for a subscription, all you need is SubscriptionId. Get the instance of CrayonApiClient and get the token using the instance. This client token will be passed when retrieving addon offers.

Just, call Subscriptions.GetSubscriptionAddons() method to get all addon offers for a subscription by passing the token and SubscriptionId.

var client = new CrayonApiClient("");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = client.Subscriptions.GetSubscriptionAddons(token, subscriptionId);


Request Syntax:

Method Request URI

Request Parameters:

Name Type Required
subscriptionId int Yes

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:

GET $"{subscriptionId}/addon-offers"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >


If successful, this method returns a SubscriptionAddOnOfferCollection resource in the response body.

Response Body:

  "Items": [
      "Product": {
        "Id": 414578,
        "PartNumber": "2828BE95-46BA-4F91-B2FD-0BEF192ECF60",
        "PublisherProductId": null,
        "ItemLegalName": "Product addon item legal name 1",
        "ItemName": "Product addon item name 1"
      "Publisher": {
        "Id": 2,
        "Name": "Publisher Name"
      "Product": {
        "Id": 414622,
        "PartNumber": "6B648C1E-F472-46C0-8379-09F50A3315E0",
        "PublisherProductId": null,
        "ItemLegalName": "Product addon item legal name 2",
        "ItemName": "Product addon item name 2"
      "Publisher": {
        "Id": 2,
        "Name": "Publisher Name"
  "TotalHits": 2

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.