Get Customized Charge Offers for a Service
get
/bcws/webresources/v1.0/subscriptions/service/{id}/customizedoffers
Gets all customized charge offers that match the specified service ID.
Request
Path Parameters
-
id(required): string
The ID of the service.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The list of customized charge offers was returned successfully.
Nested Schema : CustomizedOffer
Type:
Show Source
object
-
contractEndDate: string
(date-time)
-
contractName: string
-
contractRef: object
ResourceRef
-
contractStartDate: string
(date-time)
-
cycleDuration: integer
(int32)
The accounting cycle duration.
-
cycleEndT(required): string
(date-time)
The date and time the cycle changes end.
-
cycleStartT(required): string
(date-time)
The date and time the cycle changes start.
-
dealName: string
The name of the deal that contains the offer.
-
dealRef: object
ResourceRef
-
description: string
The offer's description.
-
gracePeriodOffset: integer
(int32)
The number to offset the grace period by.
-
gracePeriodUnit: integer
(int32)
The unit the grace period is measured in.
-
id(required): string
The ID.
-
name: string
The offer's name.
-
overriddenCharges(required): array
overriddenCharges
The overridden charges.
-
packageId: integer
(int32)
The package id of offer.
-
planName: string
The name of the package that contains the offer.
-
planRef: object
ResourceRef
-
purchasedDate(required): string
(date-time)
The date on which the offer is purchased.
-
purchaseDiscount(required): number
The amount of the purchase fee discount.
-
purchaseDiscountPercent(required): number
The percentage amount by which to discount the purchase fee.
-
purchasedProductRef: object
ResourceRef
-
purchaseEndT(required): string
(date-time)
The date and time the purchase changes end.
-
purchaseFee(required): number
The purchase fee amount.
-
purchaseFeeOverriden(required): number
The amount by which to override the purchase fee.
-
purchaseStartT(required): string
(date-time)
The date and time the purchase changes start.
-
quantity(required): number
The quantity of offer.
-
recurringDiscount(required): number
The fixed amount of the recurring discount.
-
recurringDiscountPercent(required): number
The percentage amount of the recurring discount.
-
recurringFee(required): number
The amount of the recurring fee.
-
recurringFeeOverriden(required): number
The amount by which to override the recurring fee.
-
renewalMode: integer
(int32)
How to handle the 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.
-
serviceName: string
The name of the service that contains the offer.
-
serviceRef: object
ResourceRef
-
serviceType: string
The type of the service that contains the offer.
-
status: string
The offer's status.
-
terminationFee: number
The amount of the early termination fee.
-
termRef: object
ResourceRef
-
usageDiscount(required): number
The amount of the usage discount.
-
usageEndT(required): string
(date-time)
The date and time the usage changes end.
-
usageStartT(required): string
(date-time)
The date and time the usage changes start.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : overriddenCharges
Type:
Show Source
object
-
charges(required): array
charges
The charge details.
-
event(required): string
The event associated with the overridden charges.
Nested Schema : charges
Type:
array
The charge details.
Show Source
-
Array of:
object Charges
The charge details.
Nested Schema : Charges
Type:
object
The charge details.
Show Source
-
charge(required): array
charge
The charges.
-
endDate: string
(date-time)
The date and time the charge's validity ends.
-
startDate(required): string
(date-time)
The date and time the charge's validity starts.
Nested Schema : Charge
Type:
object
The charges.
Show Source
-
amount(required): number
The charge amount.
-
priceTag(required): string
The charge's price tag.
-
type(required): string
The charge type.
500 Response
An internal server error occurred.
Examples
This example shows how to get the customized charge offers for a given service 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/service/0.0.0.1+-service-broadband+125400/customizedoffers
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.
{
"customizedOffer": [
{
"id": "0.0.0.1+-product+106933",
"purchasedProductRef": {
"id": "0.0.0.1+-purchased_product+124888",
"uri": null
},
"cycleDuration": 1,
"recurringFee": null,
"recurringFeeOverriden": 0,
"recurringDiscount": 0,
"recurringDiscountPercent": 0,
"purchaseFee": null,
"purchaseFeeOverriden": 0,
"purchaseDiscount": 0,
"purchaseDiscountPercent": 0,
"usageDiscount": 0,
"usageStartT": 1638316800000,
"usageEndT": 0,
"purchaseStartT": 1638316800000,
"purchaseEndT": 0,
"cycleStartT": 1638316800000,
"cycleEndT": 0,
"gracePeriodUnit": 0,
"gracePeriodOffset": 0,
"renewalMode": 0,
"terminationFee": null,
"overriddenCharges": [
{
"event": "/event/billing/product/fee/purchase",
"charges": [
{
"startDate": 1634601600000,
"endDate": 1637280000000,
"charge": [
{
"amount": 105,
"priceTag": "USD",
"type": "Amount"
}
]
}
]
}
]
},
{
"id": "0.0.0.1+-discount+109493",
"purchasedProductRef": {
"id": "0.0.0.1+-purchased_discount+124376",
"uri": null
},
"cycleDuration": 0,
"recurringFee": null,
"recurringFeeOverriden": null,
"recurringDiscount": null,
"recurringDiscountPercent": null,
"purchaseFee": null,
"purchaseFeeOverriden": null,
"purchaseDiscount": null,
"purchaseDiscountPercent": null,
"usageDiscount": null,
"usageStartT": 1638316800000,
"usageEndT": 0,
"purchaseStartT": 1638316800000,
"purchaseEndT": 0,
"cycleStartT": 1638316800000,
"cycleEndT": 0,
"gracePeriodUnit": null,
"gracePeriodOffset": null,
"renewalMode": null,
"terminationFee": null,
"overriddenCharges": [
{
"event": "/event/billing/product/fee/purchase",
"charges": [
{
"startDate": 1634601600000,
"endDate": 1637280000000,
"charge": [
{
"amount": 105,
"priceTag": "USD",
"type": "Amount"
}
]
}
]
}
]
}
]
}