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.