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 TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The offer details were retrieved successfully.
Root Schema : offer
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
id(required): string
The ID.
-
offerDetail(required): array
offerDetail
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : offerDetail
Type:
Show Source
object
-
details(required): array
details
The offer details.
-
event(required): string
The event associated with the offer.
Nested Schema : details
Type:
array
The offer details.
Show Source
-
Array of:
object Details
The offer details.
Nested Schema : Details
Type:
object
The offer details.
Show Source
-
balanceImpactResource(required): string
The resource that represents the balance impact of the offer.
-
fixedAmount: number
(float)
The fixed amount of the offer.
-
fixedPriceTag(required): string
The fixed price tag of the offer.
-
scaledAmount: number
(float)
The scaled amount of the offer.
-
scaledPriceTag(required): string
The scaled price tag of the offer.
404 Response
The specified ID was not found.
500 Response
An internal server error occurred.
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": ""
}
]
}
]
}