Jump to

• Request
• Response

Get change reasons for subscription products

get

/ccstore/v1/selfservice/subscriptionProducts/changeReasons

Retrieves a list of change reasons for subscription products

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response

Body ()

Root Schema : changeReasonsResponse

Type: object

Show Source

• items: array items
• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/changeReason"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object changeReason

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/changeReason"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : changeReason

Type: object

Show Source

• dateModified: string(date)
  The date when the change reason was last modified
• displayValue: string
  The display value of the change reason
• id: integer
  Primary key of the change reason menu item.
• isStandardComponent: boolean
  Whether the change reason is a standard component
• orderNumber: integer
  The order number of the change reason
• value: string
  The value of the change reason

{
    "type":"object",
    "properties":{
        "displayValue":{
            "description":"The display value of the change reason",
            "type":"string"
        },
        "orderNumber":{
            "description":"The order number of the change reason",
            "type":"integer"
        },
        "dateModified":{
            "format":"date",
            "description":"The date when the change reason was last modified",
            "type":"string"
        },
        "id":{
            "description":"Primary key of the change reason menu item.",
            "type":"integer"
        },
        "isStandardComponent":{
            "description":"Whether the change reason is a standard component",
            "type":"boolean"
        },
        "value":{
            "description":"The value of the change reason",
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The hyperlink reference
• rel: string
  The relation of the link

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"The relation of the link",
            "type":"string"
        },
        "href":{
            "description":"The hyperlink reference",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "links":[
        {
            "rel":"self",
            "href":"/ccstore/v1/selfservice/subscriptionProducts/changeReasons"
        }
    ],
    "items":[
        {
            "displayValue":"Breach",
            "orderNumber":1,
            "dateModified":"2025-03-19",
            "id":36906477,
            "isStandardComponent":true,
            "value":"ORA_BREACH"
        },
        {
            "displayValue":"Non Compliant",
            "orderNumber":2,
            "dateModified":"2025-03-19",
            "id":36906499,
            "isStandardComponent":true,
            "value":"ORA_NON_COMPLIANCE"
        }
    ]
}

500 Response

Internal server error

Back to Top