Jump to

• Request
• Response

Preview subscription products

post

/ccstore/v1/selfservice/subscriptionProducts/preview

Preview the specified subscription products

Request

Supported Media Types

• application/json

Body ()

Request payload to preview subscription products

Root Schema : previewSubscriptionProductsRequest

Type: object

Show Source

• cart(required): object cart

{
    "type":"object",
    "properties":{
        "cart":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/previewRequestCartItem"
                    }
                }
            },
            "required":[
                "items"
            ]
        }
    },
    "required":[
        "cart"
    ],
    "example":[
        {
            "cart":{
                "items":[
                    {
                        "output":[
                            {
                                "numberOfBillingCycles":2
                            }
                        ],
                        "subscriptionNumber":"PreviewSubsciption_Amend",
                        "closedDate":"2025-03-10",
                        "actionCode":"CLOSE",
                        "productPuId":"PreviewSubsciption_Amend-PRDT-176040"
                    }
                ]
            }
        }
    ]
}

Example:

[
    {
        "cart":{
            "items":[
                {
                    "output":[
                        {
                            "numberOfBillingCycles":2
                        }
                    ],
                    "subscriptionNumber":"PreviewSubsciption_Amend",
                    "closedDate":"2025-03-10",
                    "actionCode":"CLOSE",
                    "productPuId":"PreviewSubsciption_Amend-PRDT-176040"
                }
            ]
        }
    }
]

Nested Schema : cart

Type: object

Show Source

• items(required): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object previewRequestCartItem

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

Nested Schema : previewRequestCartItem

Type: object

Show Source

• actionCode(required): string
  Action code (applicable value: CLOSE)
• closedDate: string(date)
  Closed date (applicable & required for CLOSE action code). It should be in ISO Format: yyyy-MM-dd.
• closeReason: string
  Close reason (applicable & required for CLOSE action code).
• output: array output
• productPuId: string
  Subscription product PUID
• subscriptionNumber(required): string
  Subscription number

{
    "type":"object",
    "properties":{
        "output":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/previewOutput"
            }
        },
        "subscriptionNumber":{
            "description":"Subscription number",
            "type":"string"
        },
        "closedDate":{
            "format":"date",
            "description":"Closed date (applicable & required for CLOSE action code). It should be in ISO Format: yyyy-MM-dd.",
            "type":"string"
        },
        "actionCode":{
            "description":"Action code (applicable value: CLOSE)",
            "type":"string"
        },
        "productPuId":{
            "description":"Subscription product PUID",
            "type":"string"
        },
        "closeReason":{
            "description":"Close reason (applicable & required for CLOSE action code).",
            "type":"string"
        }
    },
    "required":[
        "actionCode",
        "subscriptionProductPuid",
        "subscriptionNumber"
    ]
}

Nested Schema : output

Type: array

Show Source

• Array of: object previewOutput

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

Nested Schema : previewOutput

Type: object

Show Source

• numberOfBillingCycles: integer
  Number of billing cycles

{
    "type":"object",
    "properties":{
        "numberOfBillingCycles":{
            "description":"Number of billing cycles",
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response

Body ()

Root Schema : previewSubscriptionProductsResponse

Type: object

Show Source

• cart: object cart
• links: array links

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

Nested Schema : cart

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/previewResponseCartItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : items

Type: array

Show Source

• Array of: object previewResponseCartItem

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

Nested Schema : previewResponseCartItem

Type: object

Show Source

• actionCode: string
  Action code (CLOSE)
• closeCreditMethod: string
  Close credit method (applicable for CLOSE action code).
• closedDate: string(date)
  Closed date (applicable for CLOSE action code).
• closeReason: string
  Close reason (applicable for CLOSE action code).
• estimatedCreditedAmount: string(double)
  The estimated amount to be credited.
• estimatedPenaltyAmount: string(double)
  The estimated penalty amount (applicable for CLOSE action code).
• output: array output
• productPuId: string
  Subscription product PUID
• subscriptionNumber: string
  Subscription number

{
    "type":"object",
    "properties":{
        "output":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/previewOutput"
            }
        },
        "subscriptionNumber":{
            "description":"Subscription number",
            "type":"string"
        },
        "estimatedCreditedAmount":{
            "format":"double",
            "description":"The estimated amount to be credited.",
            "type":"string"
        },
        "closedDate":{
            "format":"date",
            "description":"Closed date (applicable for CLOSE action code).",
            "type":"string"
        },
        "estimatedPenaltyAmount":{
            "format":"double",
            "description":"The estimated penalty amount (applicable for CLOSE action code).",
            "type":"string"
        },
        "closeCreditMethod":{
            "description":"Close credit method (applicable for CLOSE action code).",
            "type":"string"
        },
        "actionCode":{
            "description":"Action code (CLOSE)",
            "type":"string"
        },
        "productPuId":{
            "description":"Subscription product PUID",
            "type":"string"
        },
        "closeReason":{
            "description":"Close reason (applicable for CLOSE action code).",
            "type":"string"
        }
    }
}

Nested Schema : output

Type: array

Show Source

• Array of: object previewOutput

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

Nested Schema : previewOutput

Type: object

Show Source

• numberOfBillingCycles: integer
  Number of billing cycles

{
    "type":"object",
    "properties":{
        "numberOfBillingCycles":{
            "description":"Number of billing cycles",
            "type":"integer"
        }
    }
}

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 (CLOSE)

{
    "links":[
        {
            "rel":"self",
            "href":"/ccstore/v1/selfservice/subscriptionProducts/preview"
        }
    ],
    "cart":{
        "items":[
            {
                "output":[
                    {
                        "numberOfBillingCycles":"2"
                    }
                ],
                "estimatedCreditedAmount":"0",
                "subscriptionNumber":"PreviewSubsciption_Amend",
                "closedDate":"2025-03-10",
                "estimatedPenaltyAmount":"970.97",
                "closeCreditMethod":"ORA_PRORATE_WITH_CREDIT",
                "actionCode":"CLOSE",
                "productPuId":"PreviewSubsciption_Amend-PRDT-176040",
                "closeReason":"ORA_BREACH"
            }
        ]
    }
}

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

500 Response

Internal server error

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top