REST API Reference for Billing Care

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

offerId(required): string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The offer details were retrieved successfully.

Root Schema : offer

Type: object

Show Source

extension: object extension

The extended attributes.
id(required): string

The ID.
offerDetail(required): array offerDetail

{
    "required":[
        "id",
        "offerDetail"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "offerDetail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OfferDetail"
            }
        }
    },
    "xml":{
        "name":"offer"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : offerDetail

Type: array

Show Source

Array of: object offerDetail

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OfferDetail"
    }
}

Nested Schema : offerDetail

Type: object

Show Source

details(required): array details

The offer details.
event(required): string

The event associated with the offer.

{
    "required":[
        "details",
        "event"
    ],
    "type":"object",
    "properties":{
        "event":{
            "type":"string",
            "description":"The event associated with the offer."
        },
        "details":{
            "type":"array",
            "description":"The offer details.",
            "items":{
                "$ref":"#/components/schemas/Details"
            }
        }
    },
    "xml":{
        "name":"offerDetail"
    }
}

Nested Schema : details

Type: array

The offer details.

Show Source

Array of: object Details

The offer details.

{
    "type":"array",
    "description":"The offer details.",
    "items":{
        "$ref":"#/components/schemas/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.

{
    "required":[
        "balanceImpactResource",
        "fixedPriceTag",
        "scaledPriceTag"
    ],
    "type":"object",
    "properties":{
        "balanceImpactResource":{
            "type":"string",
            "description":"The resource that represents the balance impact of the offer."
        },
        "fixedAmount":{
            "type":"number",
            "description":"The fixed amount of the offer.",
            "format":"float"
        },
        "scaledAmount":{
            "type":"number",
            "description":"The scaled amount of the offer.",
            "format":"float"
        },
        "fixedPriceTag":{
            "type":"string",
            "description":"The fixed price tag of the offer."
        },
        "scaledPriceTag":{
            "type":"string",
            "description":"The scaled price tag of the offer."
        }
    },
    "description":"The offer details."
}

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