Jump to

• Request
• Response

Terminates subscription products

post

/ccstore/v1/selfservice/subscriptionProducts/terminate

Terminates the specified subscription products

Request

Supported Media Types

• application/json

Body ()

Request payload to terminate subscription products

Root Schema : terminateSubscriptionProductsRequest

Type: object

Show Source

• cart(required): object cart

{
    "type":"object",
    "required":[
        "cart"
    ],
    "properties":{
        "cart":{
            "type":"object",
            "required":[
                "items"
            ],
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/subscriptionProductTerminateRequestItem"
                    }
                }
            }
        }
    },
    "example":{
        "cart":{
            "items":[
                {
                    "reason":"Reason for termination",
                    "comment":"Comment for termination",
                    "rootAssetKey":"abo_6da32e86-02be-487b-8e41-c4494a46e34c14",
                    "effectiveDate":"2025-06-25"
                },
                {
                    "reason":"Reason for termination",
                    "comment":"Comment for termination",
                    "rootAssetKey":"abo_6da32e86-02be-487b-8e41-c4494a46e34c15",
                    "effectiveDate":"2025-06-25"
                }
            ]
        }
    }
}

Example:

{
    "cart":{
        "items":[
            {
                "reason":"Reason for termination",
                "comment":"Comment for termination",
                "rootAssetKey":"abo_6da32e86-02be-487b-8e41-c4494a46e34c14",
                "effectiveDate":"2025-06-25"
            },
            {
                "reason":"Reason for termination",
                "comment":"Comment for termination",
                "rootAssetKey":"abo_6da32e86-02be-487b-8e41-c4494a46e34c15",
                "effectiveDate":"2025-06-25"
            }
        ]
    }
}

Nested Schema : cart

Type: object

Show Source

• items(required): array items

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/subscriptionProductTerminateRequestItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object subscriptionProductTerminateRequestItem

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

Nested Schema : subscriptionProductTerminateRequestItem

Type: object

Show Source

• comment: string
  The comment for terminating the asset
• effectiveDate(required): string(date)
  The date when the asset should be terminated, It should be in ISO date formate: yyyy-MM-dd.
• reason(required): string
  The reason for terminating the asset
• rootAssetKey(required): string
  The key of the asset to be terminated

{
    "type":"object",
    "required":[
        "rootAssetKey",
        "effectiveDate",
        "reason"
    ],
    "properties":{
        "reason":{
            "description":"The reason for terminating the asset",
            "type":"string"
        },
        "comment":{
            "description":"The comment for terminating the asset",
            "type":"string"
        },
        "rootAssetKey":{
            "description":"The key of the asset to be terminated",
            "type":"string"
        },
        "effectiveDate":{
            "format":"date",
            "description":"The date when the asset should be terminated, It should be in ISO date formate: yyyy-MM-dd.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response

Body ()

Root Schema : terminateSubscriptionProductsResponse

Type: object

Show Source

• links: array links
• transactionId: string
  The ID of the transaction resulting from the terminate operation

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "transactionId":{
            "description":"The ID of the transaction resulting from the terminate operation",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

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)

{
    "transactionId":"21275813"
}

400 Response

Bad request

500 Response

Internal server error

Back to Top