Get Purchased Bundles for a Service
get
/bcws/webresources/v1.0/subscriptions/service/{id}/bundledetails
Gets a list of purchased bundles. Values are returned for the name and description parameters only, all others are null.
Request
Path Parameters
-
id(required): string
The ID of the service to get bundles for, for example: 0.0.0.1+-service-email+345678
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The bundles for the service.
Root Schema : bundleList
Type:
Show Source
object
-
bundle(required): array
bundle
A bundle.
-
extension: object
extension
The extended attributes.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : bundle
Type:
object
A bundle.
Show Source
-
bundleId: string
The ID of the bundle.
-
chargeoffers: array
chargeoffers
The list of charge offers in the bundle.
-
creationDate(required): string
(date-time)
The date and time the bundle was created.
-
description: string
The bundle's description.
-
discountoffers: array
discountoffers
The list of discount offers in the bundle.
-
extension: object
extension
The extended attributes.
-
name: string
The name of the bundle.
-
permitted: string
The purchase level permitted for the bundle. This can be a single service (for example, /service/email), all services (/service), all accounts (/account), or all accounts and services (*).
-
ref: object
ResourceRef
-
service: object
Service
A service associated with the bundle.
-
subscriptionTerms: object
schema
-
tags: string
The tags associated with the bundle.
-
validTo: string
(date-time)
The date and time the validity period ends.
Nested Schema : chargeoffers
Type:
array
The list of charge offers in the bundle.
Show Source
-
Array of:
object Chargeoffers
The list of charge offers in the bundle.
Nested Schema : discountoffers
Type:
array
The list of discount offers in the bundle.
Show Source
-
Array of:
object Discountoffers
The list of discount offers in the bundle.
Nested Schema : extension
Type:
object
The extended attributes.
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 : Service
Type:
object
A service associated with the bundle.
Show Source
-
serviceKey: string
The service key.
-
serviceType: string
The service type.
Nested Schema : schema
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
autoRenew: boolean
Whether to automatically renew the terms at the end of its commitment period (true) or not (false).
-
bundleName(required): string
The name of the bundle associated with the subscription terms.
-
bundleRef: object
ResourceRef
-
commitmentEndDate(required): string
(date-time)
The date and time the commitment period ends.
-
commitmentPeriod: integer
(int32)
The duration of the commitment period.
-
commitmentStartDate(required): string
(date-time)
The date and time the commitment period starts.
-
commitmentUnit: integer
(int32)
The unit for the commitment period. Can be one of the following:
- 0: Months
- 1: Days
-
currency: integer
(int32)
The currency associated with the subscription fee.
-
earlyCancellationAllowed: boolean
Whether early cancellation is allowed (true) or not (false).
-
earlyCancellationDate(required): string
(date-time)
The date and time of early cancellation.
-
earlyCancellationFee(required): number
The fee for canceling a subscription early.
-
earlyCancellationType: integer
(int32)
The type of early cancelation fee. Can be one of the following:
- 0: Fixed
- 1: Reducing
-
extension: object
extension
The extended attributes.
-
gracePeriod: integer
(int32)
The duration of the grace period.
-
gracePeriodUnit: integer
(int32)
The unit for the grace period. Can be one of the following:
- 0: Months
- 1: Days
-
id(required): string
The ID.
-
packageId: integer
(int32)
The ID of package associated with the subscription terms.
-
packageRef: object
ResourceRef
-
reducedCancellationFee(required): number
The reduced cancellation fee.
-
renewalContractTerms(required): object
schema
-
renewWithSameTerms: boolean
Whether to renew with the same terms (true) or with different terms (false).
-
serviceRef: object
ResourceRef
-
subscriberContractRef: object
ResourceRef
-
termsDescription: string
The subscription terms' description.
-
termsName(required): string
The subscription terms' name.
Nested Schema : Chargeoffers
Type:
object
The list of charge offers in the bundle.
Show Source
-
baseProductCode: string
The code of the base product of the charge offer.
-
baseProductName: string
The name of the base product of the charge offer.
-
baseProductRef: object
ResourceRef
-
description(required): string
The charge offer's description.
-
gracePeriodOffset: integer
(int32)
The number to offset the grace period by.
-
gracePeriodUnit: integer
(int32)
The unit for the charge offer's grace period.
-
name(required): string
The charge offer's name.
-
ref: object
ResourceRef
-
renewalMode: integer
(int32)
How to handle the charge 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.
-
validityAlignMode: integer
(int32)
This shows if the product is an addon product and alignment of validity with other products.
Nested Schema : Discountoffers
Type:
object
The list of discount offers in the bundle.
Show Source
-
description(required): string
The discount offer's description.
-
name(required): string
The discount offer's name.
-
ref: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An internal server error occurred.
Examples
This example shows how to get the bundles that have been purchase for a specified 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-telco-gprs+167003/bundledetails'
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,
"bundle": [
{
"extension": null,
"bundleId": null,
"name": "Deal with GPRS Service",
"permitted": null,
"creationDate": null,
"description": "Deal with GPRS service.",
"validTo": null,
"tags": null,
"ref": null,
"chargeoffers": [],
"discountoffers": [],
"subscriptionTerms": null,
"service": null
}
]
}