Get Bundles and Offers for Services
post
/bcws/webresources/v1.0/subscriptions/service/bundleoffers
Gets the bundles and their associated charge offers and discount offers for one or more services.
Note: Even though this is a POST request, it does not create or update anything in BRM.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
The request body consists of a list of one or more services.
The request body consists of a list of one or more services.
Response
Supported Media Types
- application/xml
- application/json
200 Response
The bundles were returned successfully.
Nested Schema : bundleOffer
Type:
array
A bundle.
Show Source
-
Array of:
object BundleOffer
A bundle.
Nested Schema : BundleOffer
Type:
object
A bundle.
Show Source
-
bundleId: string
The ID of the bundle.
-
chargeoffers: array
chargeoffers
A list of charge offers.
-
discountoffers: array
discountoffers
A list of discount offers.
-
name: string
The name of the bundle.
-
packageId: string
The ID of the package.
Nested Schema : chargeoffers
Type:
array
A list of charge offers.
Show Source
-
Array of:
object Chargeoffers
The list of charge offers in the bundle.
Nested Schema : discountoffers
Type:
array
A list of discount offers.
Show Source
-
Array of:
object Discountoffers
The list of discount offers in the bundle.
Nested Schema : Chargeoffers
Type:
object
The list of charge offers in the bundle.
Show Source
-
baseProductCode: string
The code of the base product of the charge offer.
-
baseProductName: string
The name of the base product of the charge offer.
-
baseProductRef: object
ResourceRef
-
description(required): string
The charge offer's description.
-
gracePeriodOffset: integer
(int32)
The number to offset the grace period by.
-
gracePeriodUnit: integer
(int32)
The unit for the charge offer's grace period.
-
name(required): string
The charge offer's name.
-
ref: object
ResourceRef
-
renewalMode: integer
(int32)
How to handle the charge offer's cycle alignment when its bundle is reactivated. Possible values are:
- 0: Cycle aligns with the original billing date or configured specific day of the month.
- 1: Cycle aligns with the reactivation date.
-
validityAlignMode: integer
(int32)
This shows if the product is an addon product and alignment of validity with other products.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : Discountoffers
Type:
object
The list of discount offers in the bundle.
Show Source
-
description(required): string
The discount offer's description.
-
name(required): string
The discount offer's name.
-
ref: object
ResourceRef
500 Response
An internal server error occurred.
Examples
This example shows how to view bundle offers associated with one or more services by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X POST http://hostname:port/bcws/webresources/version/subscriptions/service/bundleoffers -H 'content-type: application/json' -d @file.json
where:
- hostname is the URL for the Billing Care REST server.
- port is the port for the Billing Care REST server.
- version is the version of the API you're using, such as v1.0.
- file.json is the JSON file that lists the service IDs.
Example of Request Body
This shows an example of the contents of the file.json file sent as the request body.
["0.0.0.1+-service-ip+1606694"]
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"0.0.0.1+-service-ip+1606694": {
"bundleOffer": [
{
"bundleId": "0.0.0.1+-deal+856633",
"name": "Ip_Deal",
"packageId": "224",
"chargeoffers": [
{
"chargeRef": {
"id": "0.0.0.1+-purchased_product+1608742",
"uri": null
},
"name": "IP",
"description": "",
"isRequired": true,
"status": "1",
"lastStatusChange": 1393676070000
}
],
"discountoffers": []
}
]
}
}