Jump to

• Request
• Response
• Examples

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

Request Body - application/xml ()

Root Schema : schema

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The bundles were returned successfully.

Body ()

Root Schema : bundleOffers

Type: object

Show Source

• bundleOffer: array bundleOffer
  A bundle.

{
    "type":"object",
    "properties":{
        "bundleOffer":{
            "type":"array",
            "description":"A bundle.",
            "items":{
                "$ref":"#/components/schemas/BundleOffer"
            }
        }
    },
    "xml":{
        "name":"bundleOffers"
    }
}

Nested Schema : bundleOffer

Type: array

A bundle.

Show Source

• Array of: object BundleOffer
  A bundle.

{
    "type":"array",
    "description":"A bundle.",
    "items":{
        "$ref":"#/components/schemas/BundleOffer"
    }
}

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.

{
    "type":"object",
    "properties":{
        "bundleId":{
            "type":"string",
            "description":"The ID of the bundle."
        },
        "name":{
            "type":"string",
            "description":"The name of the bundle."
        },
        "packageId":{
            "type":"string",
            "description":"The ID of the package."
        },
        "chargeoffers":{
            "type":"array",
            "description":"A list of charge offers.",
            "items":{
                "$ref":"#/components/schemas/Chargeoffers"
            }
        },
        "discountoffers":{
            "type":"array",
            "description":"A list of discount offers.",
            "items":{
                "$ref":"#/components/schemas/Discountoffers"
            }
        }
    },
    "description":"A bundle."
}

Nested Schema : chargeoffers

Type: array

A list of charge offers.

Show Source

• Array of: object Chargeoffers
  The list of charge offers in the bundle.

{
    "type":"array",
    "description":"A list of charge offers.",
    "items":{
        "$ref":"#/components/schemas/Chargeoffers"
    }
}

Nested Schema : discountoffers

Type: array

A list of discount offers.

Show Source

• Array of: object Discountoffers
  The list of discount offers in the bundle.

{
    "type":"array",
    "description":"A list of discount offers.",
    "items":{
        "$ref":"#/components/schemas/Discountoffers"
    }
}

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.

{
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The charge offer's name."
        },
        "description":{
            "type":"string",
            "description":"The charge offer's description."
        },
        "ref":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "baseProductRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "baseProductName":{
            "type":"string",
            "description":"The name of the base product of the charge offer."
        },
        "baseProductCode":{
            "type":"string",
            "description":"The code of the base product of the charge offer."
        },
        "validityAlignMode":{
            "type":"integer",
            "description":"This shows if the product is an addon product and alignment of validity with other products.",
            "format":"int32"
        },
        "gracePeriodUnit":{
            "type":"integer",
            "description":"The unit for the charge offer's grace period.",
            "format":"int32"
        },
        "gracePeriodOffset":{
            "type":"integer",
            "description":"The number to offset the grace period by.",
            "format":"int32"
        },
        "renewalMode":{
            "type":"integer",
            "description":"How to handle the charge offer's cycle alignment when its bundle is reactivated. Possible values are: <ul><li><b>0</b>: Cycle aligns with the original billing date or configured specific day of the month.</li><li><b>1</b>: Cycle aligns with the reactivation date.</li></ul>",
            "format":"int32"
        }
    },
    "description":"The list of charge offers in the bundle."
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"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

{
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "properties":{
        "ref":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The discount offer's name."
        },
        "description":{
            "type":"string",
            "description":"The discount offer's description."
        }
    },
    "description":"The list of discount offers in the bundle."
}

500 Response

An internal server error occurred.

Back to Top

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": []
         }
      ]
   }
}

Back to Top