1. REST API Reference for Billing Care
  2. Tasks
  3. Subscriptions

Get Subscription Transition Paths

get

/bcws/webresources/v1.0/subscriptions/transitionPaths

Gets the available transition paths between subscription objects filtered by transition type, with optional filters for service and target object.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Transition paths were retrieved successfully.
Body ()
Root Schema : TransitionPaths
Type: object
Show Source
Nested Schema : bundle
Type: array
A bundle.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : package
Type: array
Show Source
Nested Schema : path
Type: array
Show Source
Nested Schema : bundle
Type: object
A bundle.
Show Source
Nested Schema : chargeoffers
Type: array
The list of charge offers in the bundle.
Show Source
Nested Schema : discountoffers
Type: array
The list of discount offers in the bundle.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : Service
Type: object
A service associated with the bundle.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Chargeoffers
Type: object
The list of charge offers in the bundle.
Show Source
Nested Schema : OfferAttributes
Type: object
Show Source
Nested Schema : attributes
Type: array
The list of attributes in an offer's attribute object.
Show Source
Nested Schema : Attributes
Type: object
The list of attributes in an offer's attribute object.
Show Source
Nested Schema : Discountoffers
Type: object
The list of discount offers in the bundle.
Show Source
Nested Schema : aliasList
Type: array
The list of aliases associated with the service.
Show Source
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : previousContracts
Type: array
Stores contracts previously linked to the current contract.
Show Source
Nested Schema : package
Type: object
Show Source
Nested Schema : balanceGroups
Type: array
Balance groups associated with the package.
Show Source
Nested Schema : serviceGroup
Type: array
Show Source
Nested Schema : serviceIds
Type: array
The list of service IDs associated with the package.
Show Source
Nested Schema : BalanceGroups
Type: object
Balance groups associated with the package.
Show Source
Nested Schema : limits
Type: array
Show Source
Nested Schema : rules
Type: array
The list of consumption rules that define the order in which to consume balances.
Show Source
Nested Schema : LimitType
Type: object
Show Source
  • The consumption rule. Can be one of the following:
    • 0: Not defined
    • 1: Earliest start time
    • 2: Latest start time
    • 3: Earliest expiration time
    • 4: Latest expiration time
    • 5: Earliest start time and latest expiration time
    • 6: Earliest start time and earliest expiration time
    • 7: Latest start time and earliest expiration time
    • 8: Latest start time and latest expiration time
    • 9: Earliest expiration time and earliest start time
    • 10: Earliest expiration time and latest start time
    • 10: Latest expiration time and earliest start time
    • 10: Latest expiration time and latest start time
  • The credit floor amount. The credit floor is the amount that indicates none of the balance has been used. For example, if an account is granted 200 minutes, the credit floor would be -200. For currency balances, the credit floor is usually 0.
  • The credit limit amount. A credit limit specifies the maximum amount of a balance that your customers can spend. For currency balances, the credit limit is the maximum balance of euros, dollars, or so on that can accumulate in an account. For noncurrency balances, the credit limit is the amount at which an account has used all of its minutes, gigabytes, or so on, which is usually 0.
  • The percent threshold for notifications. The account is sent a notification when this percent of the balance is used. The percentage must be a 5% increment. Use the decimal notation of the binary number for the bit position.

    For example, to notify the account when 90% of the free minutes have been used, you calculate 90/5=18, so use the 18th bit position, which is 131072 in decimal notation. To notify when 95% have been used, use the 19th bit position, which is 262144 in decimal notation.

  • The fixed threshold for notifications. The account is sent a notification when this fixed value of the balance is reached. You can set multiple values by using the | delimiter. For example, to notify the account when 30 minutes of usage remains and again when 5 minutes of usage remains, use |30.00|5.00
  • Whether to use a dynamic credit floor (true) or not (false). The default is false.
  • The resource ID.
Nested Schema : Rules
Type: object
The list of consumption rules that define the order in which to consume balances.
Show Source
  • The consumption rule. Can be one of the following:
    • 0: Not defined
    • 1: Earliest start time
    • 2: Latest start time
    • 3: Earliest expiration time
    • 4: Latest expiration time
    • 5: Earliest start time and latest expiration time
    • 6: Earliest start time and earliest expiration time
    • 7: Latest start time and earliest expiration time
    • 8: Latest start time and latest expiration time
    • 9: Earliest expiration time and earliest start time
    • 10: Earliest expiration time and latest start time
    • 10: Latest expiration time and earliest start time
    • 10: Latest expiration time and latest start time
  • The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
Nested Schema : GroupOfServices
Type: object
Show Source
Nested Schema : service
Type: array
Show Source
Nested Schema : ServiceInPlan
Type: object
Show Source
Nested Schema : aliasList
Type: array
The list of aliases associated with the service.
Show Source
Nested Schema : bundles
Type: array
The list of bundles in the service.
Show Source
Nested Schema : Bundles
Type: object
The list of bundles in the service.
Show Source
Nested Schema : chargeoffers
Type: array
The list of charge offers in the bundle.
Show Source
Nested Schema : discountoffers
Type: array
The list of discount offers in the bundle.
Show Source
Nested Schema : TransitionPath
Type: object
Show Source

404 Response

The requested endpoint or resource was not found. Verify the URL path, query parameters, and their types.

500 Response

An internal server error occurred.
Back to Top

Examples

Example 1 Response Body

cURL Command

This example shows how to get the available transition paths between subscription objects filtered by deals by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL". 

curl -X GET 'http://hostname:port/bcws/webresources/version/subscriptions/transitionPaths/?id'

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.
  • id is the deal ID.

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "bundle": [
        {
            "extension": null,
            "bundleId": "0.0.0.1+-deal+365061",
            "name": "deal_transition_1",
            "permitted": "/service/ip",
            "creationDate": 1765420061000,
            "description": "",
            "validTo": 0,
            "tags": null,
            "ref": {
                "id": "0.0.0.1+-deal+365061",
                "uri": null
            },
            "chargeoffers": [
                {
                    "name": "ip_product_transition_demo",
                    "description": "",
                    "ref": {
                        "id": "0.0.0.1+-product+366597",
                        "uri": null
                    },
                    "baseProductRef": null,
                    "baseProductName": null,
                    "baseProductCode": null,
                    "validityAlignMode": null,
                    "gracePeriodUnit": null,
                    "gracePeriodOffset": null,
                    "renewalMode": null,
                    "offerAttributeGroupRef": null,
                    "offerAttributes": null
                }
            ],
            "discountoffers": [
                {
                    "ref": {
                        "id": "0.0.0.1+-discount+388897",
                        "uri": null
                    },
                    "name": "Ip Discount",
                    "description": "",
                    "offerAttributeGroupRef": null,
                    "offerAttributes": null
                }
            ],
            "subscriptionTerms": null,
            "packageId": null,
            "service": null
        }
    ],
    "path": [
        {
            "fromRef": {
                "id": "0.0.0.1+-deal+367109",
                "uri": null
            },
            "toRef": {
                "id": "0.0.0.1+-deal+365061",
                "uri": null
            },
            "type": 2,
            "transitionOn": "/service/ip"
        }
    ],
    "package": []
}

Example 2 Response Body

cURL Command

This example shows how to get the available transition paths between subscription objects filtered by plan by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL". 

curl -X GET 'http://hostname:port/bcws/webresources/version/subscriptions/transitionPaths/?id'

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.
  • id is the plan ID. 
{
    "extension": null,
    "bundle": [],
    "path": [
        {
            "fromRef": {
                "id": "0.0.0.1+-plan+345086",
                "uri": null
            },
            "toRef": {
                "id": "0.0.0.1+-plan+347646",
                "uri": null
            },
            "type": 2,
            "transitionOn": "/service/broadband"
        }
    ],
    "package": [
        {
            "id": "0.0.0.1+-plan+347646",
            "creationDate": null,
            "description": "Package_Transition1",
            "lastModified": null,
            "validTo": null,
            "name": "Package_Transition1",
            "tags": null,
            "serviceGroup": [
                {
                    "service": [
                        {
                            "serviceKey": "custom-0.0.0.1+-plan+347646-0.0.0.1+-deal+346622-/service/broadband0",
                            "serviceType": "/service/broadband",
                            "balGrpIndex": 0,
                            "groupParent": false,
                            "subscriptionIndex": 0,
                            "login": null,
                            "aliasList": [],
                            "serviceObj": null,
                            "status": null,
                            "bundles": [
                                {
                                    "ref": {
                                        "id": "0.0.0.1+-deal+346622",
                                        "uri": null
                                    },
                                    "required": true,
                                    "name": "deal_brodband_1",
                                    "description": "",
                                    "chargeoffers": [
                                        {
                                            "name": "broadband_prod",
                                            "description": "",
                                            "ref": {
                                                "id": "0.0.0.1+-product+268268",
                                                "uri": null
                                            },
                                            "offerAttributeGroupRef": null,
                                            "offerAttributes": null,
                                            "baseProductRef": null,
                                            "baseProductName": null,
                                            "baseProductCode": null,
                                            "validityAlignMode": null,
                                            "gracePeriodUnit": 0,
                                            "gracePeriodOffset": 0,
                                            "renewalMode": 0
                                        }
                                    ],
                                    "discountoffers": [
                                        {
                                            "ref": {
                                                "id": "0.0.0.1+-discount+382563",
                                                "uri": null
                                            },
                                            "offerAttributeGroupRef": null,
                                            "offerAttributes": null,
                                            "name": "Broadband Discount 1",
                                            "description": ""
                                        }
                                    ],
                                    "elem": null
                                }
                            ]
                        }
                    ],
                    "groupIndex": 0
                }
            ],
            "packageId": null,
            "serviceIds": [],
            "purchaseFeeWaived": null,
            "terminationFeeWaived": null,
            "balanceGroups": [
                {
                    "limits": [],
                    "name": "Balance Group<Account>",
                    "rules": [],
                    "elem": 0,
                    "default": true
                }
            ],
            "subscriptionTerms": null
        }
    ]
}
Back to Top