1. REST API Reference for Billing Care
  2. Tasks
  3. Subscriptions

Get Unpurchased Bundles for a Package

post

/bcws/webresources/v1.0/subscriptions/unpurchased/bundles/{packageId}

Gets the list of unpurchased optional bundles that are available to a customer that has purchased a given package.

Note: Even though this is a POST request, it does not create or update anything in BRM.

Request

Path Parameters
Supported Media Types
Request Body - application/xml ()
The list of optional bundles that the customer has already purchased.
Root Schema : schema
Type: array
Show Source
Request Body - application/json ()
The list of optional bundles that the customer has already purchased.
Root Schema : schema
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

The list of available bundles were returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : bundle
Type: object
A bundle.
Show Source
Nested Schema : chargeoffers
Type: array
The list of charge offers in the bundle.
Show Source
Nested Schema : discountoffers
Type: array
The list of discount offers in the bundle.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : Service
Type: object
A service associated with the bundle.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Chargeoffers
Type: object
The list of charge offers in the bundle.
Show Source
Nested Schema : Discountoffers
Type: object
The list of discount offers in the bundle.
Show Source
Nested Schema : extension
Type: object
The extended attributes.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to retrieve all unpurchased bundles that are available for a customer that has purchased a specified package 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/unpurchased/bundles/0.0.0.1+-plan+865226 -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 bundles that the customer has already purchased.

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+-deal+875443]

Example of Response Body

This example shows the contents of the response body in JSON format.

{
   "bundleId": "0.0.0.1+-deal+865780", 
   "name": "Bundle1", 
   "permitted": "/service/ip", 
   "creationDate": null, 
   "description": "Bundle for IP deal",
   "chargeoffers": [], 
   "discountoffers": [], 
   "subscriptionTerms": {
      "extension": null,
      "id": "0.0.0.1+-subscription_terms+859193",
      "termsName": "Term_12month_Termination_allowed",
      "termsDescription": "",
      "packageRef": null,
      "bundleRef": {
         "id": "0.0.0.1+-deal+865780",
         "uri": null 
      },
      "serviceRef": null,
      "subscriberContractRef": {
         "id": "0.0.0.1+-subscriber_contract+1613606",
         "uri": null 
      },
      "accountRef": {
         "id": "0.0.0.1+-account+1607269",
         "uri": null
      },
      "commitmentPeriod": 12,
      "commitmentUnit": 0,
      "commitmentStartDate": 1400050800000,
      "commitmentEndDate": 1431586800000,
      "earlyCancellationAllowed": true,
      "earlyCancellationDate": null,
      "earlyCancellationFee": 0,
      "reducedCancellationFee": null,
      "autoRenew": false,
      "renewWithSameTerms": false,
      "bundleName": null,
      "currency": 840,
      "gracePeriod": 0,
      "gracePeriodUnit": 0,
      "earlyCancellationType": 0,
      "renewalContractTerms": null
   }, 
   "service": null
}
Back to Top