Jump to

• Request
• Response

Modify subscription products

post

/ccstore/v1/selfservice/subscriptionProducts/modify

Modify the specified subscription products

Request

Supported Media Types

• application/json

Body ()

Request payload to modify subscription products

Root Schema : modifySubscriptionProductsRequest

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/subscriptionProductModifyRequestItem"
                    }
                }
            }
        }
    },
    "example":{
        "cart":{
            "items":[
                {
                    "reason":"Reason for modification",
                    "quantity":1,
                    "ratePlanId":"planB",
                    "comment":"Comment for modification",
                    "rootAssetKey":"abo_6da32e86-02be-487b-8e41-c4494a46e34c14",
                    "effectiveDate":"2025-07-27"
                },
                {
                    "reason":"Reason for modification",
                    "quantity":1,
                    "ratePlanId":"planC",
                    "comment":"Comment for modification",
                    "rootAssetKey":"abo_6da32e86-02be-487b-8e41-c4494a46e34c15",
                    "effectiveDate":"2025-07-27"
                }
            ]
        }
    }
}

Example:

{
    "cart":{
        "items":[
            {
                "reason":"Reason for modification",
                "quantity":1,
                "ratePlanId":"planB",
                "comment":"Comment for modification",
                "rootAssetKey":"abo_6da32e86-02be-487b-8e41-c4494a46e34c14",
                "effectiveDate":"2025-07-27"
            },
            {
                "reason":"Reason for modification",
                "quantity":1,
                "ratePlanId":"planC",
                "comment":"Comment for modification",
                "rootAssetKey":"abo_6da32e86-02be-487b-8e41-c4494a46e34c15",
                "effectiveDate":"2025-07-27"
            }
        ]
    }
}

Nested Schema : cart

Type: object

Show Source

• items(required): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object subscriptionProductModifyRequestItem

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

Nested Schema : subscriptionProductModifyRequestItem

Type: object

Show Source

• comment: string
  The comment for modifying the asset
• effectiveDate: string
  The amend effective date, refers to the specific date when changes made to the subscription becomes active (should be in ISO Date format: yyyy-MM-dd). Defaults to current date if asset contract start date is in past or contract start date.
• quantity: integer
  The new quantity of the asset
• ratePlanId: string
  The new rate plan number for the asset
• reason: string
  The reason for modifying the asset
• rootAssetKey(required): string
  The key of the asset to be modified

{
    "type":"object",
    "required":[
        "rootAssetKey"
    ],
    "properties":{
        "reason":{
            "description":"The reason for modifying the asset",
            "type":"string"
        },
        "quantity":{
            "description":"The new quantity of the asset",
            "type":"integer"
        },
        "ratePlanId":{
            "description":"The new rate plan number for the asset",
            "type":"string"
        },
        "comment":{
            "description":"The comment for modifying the asset",
            "type":"string"
        },
        "rootAssetKey":{
            "description":"The key of the asset to be modified",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The amend effective date, refers to the specific date when changes made to the subscription becomes active (should be in ISO Date format: yyyy-MM-dd). Defaults to current date if asset contract start date is in past or contract start date.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response

Body ()

Root Schema : modifySubscriptionProductsResponse

Type: object

Show Source

• links: array links
• orderId: string
  The ID of the order created for the modify subscription operation.
• transactionId: string
  The ID of the transaction resulting from the modify operation.

{
    "type":"object",
    "properties":{
        "orderId":{
            "description":"The ID of the order created for the modify subscription operation.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "transactionId":{
            "description":"The ID of the transaction resulting from the modify 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)

{
    "orderId":"o31245",
    "transactionId":"21275813"
}

400 Response

Bad request

500 Response

Internal server error

Back to Top