REST API Reference for Billing Care

Cancel a Bundle

post

/bcws/webresources/v1.0/subscriptions/cancel/bundle

Cancels the bundle associated with account/service that is passed in the request payload.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

accountRef: object ResourceRef
dealRef: object ResourceRef
description: string

The product's descritpion.
effective: string (date-time)

The date and time the status takes effect.
extension: object extension

The extended attributes.
flag: integer (int32)

flag.
packageId: integer (int32)

The ID of the package.
serviceRef: object ResourceRef

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "effective":{
            "type":"string",
            "description":"The date and time the status takes effect.",
            "format":"date-time"
        },
        "packageId":{
            "type":"integer",
            "description":"The ID of the package.",
            "format":"int32"
        },
        "dealRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "description":{
            "type":"string",
            "description":"The product's descritpion."
        },
        "flag":{
            "type":"integer",
            "description":"flag.",
            "format":"int32"
        }
    },
    "xml":{
        "name":"bundleCancel"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Root Schema : schema

Type: object

Show Source

accountRef: object ResourceRef
dealRef: object ResourceRef
description: string

The product's descritpion.
effective: string (date-time)

The date and time the status takes effect.
extension: object extension

The extended attributes.
flag: integer (int32)

flag.
packageId: integer (int32)

The ID of the package.
serviceRef: object ResourceRef

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "effective":{
            "type":"string",
            "description":"The date and time the status takes effect.",
            "format":"date-time"
        },
        "packageId":{
            "type":"integer",
            "description":"The ID of the package.",
            "format":"int32"
        },
        "dealRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "description":{
            "type":"string",
            "description":"The product's descritpion."
        },
        "flag":{
            "type":"integer",
            "description":"flag.",
            "format":"int32"
        }
    },
    "xml":{
        "name":"bundleCancel"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Response

200 Response

The bundle was canceled successfully.

400 Response

BAD REQUEST (400) on null Account Id/Service Id/Deal Id

500 Response

An internal server error occurred.

Examples

This example shows how to cancel a bundle by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/v1.0/subscriptions/cancel/bundle' -H 'content-type: application/json' -d @cancelBun.json

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.
cancelBundle.json is the JSON file that specifies the event dispute to create.

Example of Request Body

This example shows the contents of the createDispute.json file sent as the request body.

{
   "dealRef":{
      "id":"0.0.0.1+-deal+41056",
      "uri":null
   },
   "serviceRef":{
      "id":"0.0.0.1+-service-email+175025",
      "uri":null
   },
   "accountRef":{
      "id":"0.0.0.1+-account+174257",
      "uri":null
   },
   "description":"Charges monthly for 1 email account.",
   "packageId":1
}

Example of Response Body

If successful, the response code 200 is returned with the following response body:

{
true
}