Get Offer Details

get

/bcws/webresources/v1.0/subscriptions/offers/{offerId}

Gets the details for the charge or discount offer that matches the specified ID.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The offer details were retrieved successfully.
Body ()
Root Schema : offer
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : offerDetail
Type: array
Show Source
Nested Schema : offerDetail
Type: object
Show Source
Nested Schema : details
Type: array
The offer details.
Show Source
Nested Schema : Details
Type: object
The offer details.
Show Source

404 Response

The specified ID was not found.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to get offer details by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/subscriptions/offers/0.0.0.1+-product+44832'

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.

Example of Response Body

This example shows the contents of the response body in JSON format.
{
    "extension": null,
    "id": "0.0.0.1+-product+44832",
    "offerDetail": [
        {
            "event": "/event/billing/product/fee/cycle/cycle_forward_monthly",
            "details": [
                {
                    "balanceImpactResource": "840",
                    "fixedAmount": 0.0,
                    "scaledAmount": 3.0,
                    "fixedPriceTag": "",
                    "scaledPriceTag": ""
                }
            ]
        }
    ]
}
Back to Top