Jump to

• Request
• Response
• Examples

Cancel a Subscriber's Contract

post

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

Cancels the subscriber's contract that is passed in the request payload.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• 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.
• minimumCommitmentPeriod: integer (int32)
  The duration of the minimum commitment period.
• minimumCommitmentUnit: integer (int32)
  The unit for the minimum commitment period. Can be one of the following:

  • 0: Months
  • 1: Years
• minimumContractEndDate(required): string (date-time)
  The minimum date and time the contract stays before termination.
• originalCommitmentEndDate(required): string (date-time)
  The date and time the original commitment period end.
• 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
• status: integer (int32)
  The status for a contract.
• subscriberContractRef: object ResourceRef
• termsDescription: string
  The subscription terms' description.
• termsName(required): string
  The subscription terms' name.

{
    "required":[
        "bundleName",
        "commitmentEndDate",
        "commitmentStartDate",
        "earlyCancellationDate",
        "earlyCancellationFee",
        "id",
        "minimumContractEndDate",
        "originalCommitmentEndDate",
        "reducedCancellationFee",
        "renewalContractTerms",
        "termsName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "termsName":{
            "type":"string",
            "description":"The subscription terms' name."
        },
        "termsDescription":{
            "type":"string",
            "description":"The subscription terms' description."
        },
        "packageRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "bundleRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "subscriberContractRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "commitmentPeriod":{
            "type":"integer",
            "description":"The duration of the commitment period.",
            "format":"int32"
        },
        "commitmentUnit":{
            "type":"integer",
            "description":"The unit for the commitment period. Can be one of the following: <ul><li><b>0</b>: Months</li><li><b>1</b>: Days</li></ul>",
            "format":"int32"
        },
        "commitmentStartDate":{
            "type":"string",
            "description":"The date and time the commitment period starts.",
            "format":"date-time"
        },
        "commitmentEndDate":{
            "type":"string",
            "description":"The date and time the commitment period ends.",
            "format":"date-time"
        },
        "originalCommitmentEndDate":{
            "type":"string",
            "description":"The date and time the original commitment period end.",
            "format":"date-time"
        },
        "earlyCancellationAllowed":{
            "type":"boolean",
            "description":"Whether early cancellation is allowed (<b>true</b>) or not (<b>false</b>)."
        },
        "earlyCancellationDate":{
            "type":"string",
            "description":"The date and time of early cancellation.",
            "format":"date-time"
        },
        "earlyCancellationFee":{
            "type":"number",
            "description":"The fee for canceling a subscription early."
        },
        "reducedCancellationFee":{
            "type":"number",
            "description":"The reduced cancellation fee."
        },
        "autoRenew":{
            "type":"boolean",
            "description":"Whether to automatically renew the terms at the end of its commitment period (<b>true</b>) or not (<b>false</b>)."
        },
        "renewWithSameTerms":{
            "type":"boolean",
            "description":"Whether to renew with the same terms (<b>true</b>) or with different terms (<b>false</b>)."
        },
        "bundleName":{
            "type":"string",
            "description":"The name of the bundle associated with the subscription terms."
        },
        "currency":{
            "type":"integer",
            "description":"The currency associated with the subscription fee.",
            "format":"int32"
        },
        "gracePeriod":{
            "type":"integer",
            "description":"The duration of the grace period.",
            "format":"int32"
        },
        "packageId":{
            "type":"integer",
            "description":"The ID of package associated with the subscription terms.",
            "format":"int32"
        },
        "gracePeriodUnit":{
            "type":"integer",
            "description":"The unit for the grace period. Can be one of the following: <ul><li><b>0</b>: Months</li><li><b>1</b>: Days</li></ul>",
            "format":"int32"
        },
        "earlyCancellationType":{
            "type":"integer",
            "description":"The type of early cancelation fee. Can be one of the following: <ul><li><b>0</b>: Fixed</li><li><b>1</b>: Reducing</li></ul>",
            "format":"int32"
        },
        "minimumCommitmentPeriod":{
            "type":"integer",
            "description":"The duration of the minimum commitment period.",
            "format":"int32"
        },
        "minimumCommitmentUnit":{
            "type":"integer",
            "description":"The unit for the minimum commitment period. Can be one of the following: <ul><li><b>0</b>: Months</li><li><b>1</b>: Years</li></ul>",
            "format":"int32"
        },
        "renewalContractTerms":{
            "$ref":"#/components/schemas/SubscriptionTerms"
        },
        "minimumContractEndDate":{
            "type":"string",
            "description":"The minimum date and time the contract stays before termination.",
            "format":"date-time"
        },
        "status":{
            "type":"integer",
            "description":"The status for a contract.",
            "format":"int32"
        }
    }
}

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.

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• minimumCommitmentPeriod: integer (int32)
  The duration of the minimum commitment period.
• minimumCommitmentUnit: integer (int32)
  The unit for the minimum commitment period. Can be one of the following:

  • 0: Months
  • 1: Years
• minimumContractEndDate(required): string (date-time)
  The minimum date and time the contract stays before termination.
• originalCommitmentEndDate(required): string (date-time)
  The date and time the original commitment period end.
• 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
• status: integer (int32)
  The status for a contract.
• subscriberContractRef: object ResourceRef
• termsDescription: string
  The subscription terms' description.
• termsName(required): string
  The subscription terms' name.

{
    "required":[
        "bundleName",
        "commitmentEndDate",
        "commitmentStartDate",
        "earlyCancellationDate",
        "earlyCancellationFee",
        "id",
        "minimumContractEndDate",
        "originalCommitmentEndDate",
        "reducedCancellationFee",
        "renewalContractTerms",
        "termsName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "termsName":{
            "type":"string",
            "description":"The subscription terms' name."
        },
        "termsDescription":{
            "type":"string",
            "description":"The subscription terms' description."
        },
        "packageRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "bundleRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "subscriberContractRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "commitmentPeriod":{
            "type":"integer",
            "description":"The duration of the commitment period.",
            "format":"int32"
        },
        "commitmentUnit":{
            "type":"integer",
            "description":"The unit for the commitment period. Can be one of the following: <ul><li><b>0</b>: Months</li><li><b>1</b>: Days</li></ul>",
            "format":"int32"
        },
        "commitmentStartDate":{
            "type":"string",
            "description":"The date and time the commitment period starts.",
            "format":"date-time"
        },
        "commitmentEndDate":{
            "type":"string",
            "description":"The date and time the commitment period ends.",
            "format":"date-time"
        },
        "originalCommitmentEndDate":{
            "type":"string",
            "description":"The date and time the original commitment period end.",
            "format":"date-time"
        },
        "earlyCancellationAllowed":{
            "type":"boolean",
            "description":"Whether early cancellation is allowed (<b>true</b>) or not (<b>false</b>)."
        },
        "earlyCancellationDate":{
            "type":"string",
            "description":"The date and time of early cancellation.",
            "format":"date-time"
        },
        "earlyCancellationFee":{
            "type":"number",
            "description":"The fee for canceling a subscription early."
        },
        "reducedCancellationFee":{
            "type":"number",
            "description":"The reduced cancellation fee."
        },
        "autoRenew":{
            "type":"boolean",
            "description":"Whether to automatically renew the terms at the end of its commitment period (<b>true</b>) or not (<b>false</b>)."
        },
        "renewWithSameTerms":{
            "type":"boolean",
            "description":"Whether to renew with the same terms (<b>true</b>) or with different terms (<b>false</b>)."
        },
        "bundleName":{
            "type":"string",
            "description":"The name of the bundle associated with the subscription terms."
        },
        "currency":{
            "type":"integer",
            "description":"The currency associated with the subscription fee.",
            "format":"int32"
        },
        "gracePeriod":{
            "type":"integer",
            "description":"The duration of the grace period.",
            "format":"int32"
        },
        "packageId":{
            "type":"integer",
            "description":"The ID of package associated with the subscription terms.",
            "format":"int32"
        },
        "gracePeriodUnit":{
            "type":"integer",
            "description":"The unit for the grace period. Can be one of the following: <ul><li><b>0</b>: Months</li><li><b>1</b>: Days</li></ul>",
            "format":"int32"
        },
        "earlyCancellationType":{
            "type":"integer",
            "description":"The type of early cancelation fee. Can be one of the following: <ul><li><b>0</b>: Fixed</li><li><b>1</b>: Reducing</li></ul>",
            "format":"int32"
        },
        "minimumCommitmentPeriod":{
            "type":"integer",
            "description":"The duration of the minimum commitment period.",
            "format":"int32"
        },
        "minimumCommitmentUnit":{
            "type":"integer",
            "description":"The unit for the minimum commitment period. Can be one of the following: <ul><li><b>0</b>: Months</li><li><b>1</b>: Years</li></ul>",
            "format":"int32"
        },
        "renewalContractTerms":{
            "$ref":"#/components/schemas/SubscriptionTerms"
        },
        "minimumContractEndDate":{
            "type":"string",
            "description":"The minimum date and time the contract stays before termination.",
            "format":"date-time"
        },
        "status":{
            "type":"integer",
            "description":"The status for a contract.",
            "format":"int32"
        }
    }
}

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.

Back to Top

Response

200 Response

The subscriber's contract was canceled successfully.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to cancel a subscriber's contract 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/version/subscriptions/cancel/contract -H 'content-type: application/json' -d @file.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.
• file.json is the JSON file that specifies the contract to cancel.

Example of Request Body

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

{
   "accountRef": {
      "id":"0.0.0.1+-account+1607269" 
   },
   "subscriberContractRef": {
      "id":"0.0.0.1+-subscriber_contract+1607909"
   },
   "packageRef": {
      "id":"0.0.0.1+-plan+860103"
   }
}

Example of Response Body

If the contract is canceled successfully, the response code 200 is returned with true in the response body.

Back to Top