Jump to

• Request
• Response
• Examples

Delete Dynamic Charges for a Purchased Product

delete

/bcws/webresources/v1.0/subscriptions/offer/{id}/overridecharges

Deletes dynamic charges for the purchased product with the specified ID.

Request

Path Parameters

• id(required): string
  The ID of the purchased product or discount to delete dynamic charges from. For example: 0.0.0.1+-purchased_product+123123

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: array

Show Source

• Array of: object overriddenCharges

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OverriddenCharges"
    }
}

Nested Schema : overriddenCharges

Type: object

Show Source

• charges(required): array charges
  The charge details.
• event(required): string
  The event associated with the overridden charges.

{
    "required":[
        "charges",
        "event"
    ],
    "type":"object",
    "properties":{
        "event":{
            "type":"string",
            "description":"The event associated with the overridden charges."
        },
        "charges":{
            "type":"array",
            "description":"The charge details.",
            "items":{
                "$ref":"#/components/schemas/Charges"
            }
        }
    },
    "xml":{
        "name":"overriddenCharges"
    }
}

Nested Schema : charges

Type: array

The charge details.

Show Source

• Array of: object Charges
  The charge details.

{
    "type":"array",
    "description":"The charge details.",
    "items":{
        "$ref":"#/components/schemas/Charges"
    }
}

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.

{
    "required":[
        "charge",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "startDate":{
            "type":"string",
            "description":"The date and time the charge's validity starts.",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "description":"The date and time the charge's validity ends.",
            "format":"date-time"
        },
        "charge":{
            "type":"array",
            "description":"The charges.",
            "items":{
                "$ref":"#/components/schemas/Charge"
            }
        }
    },
    "description":"The charge details."
}

Nested Schema : charge

Type: array

The charges.

Show Source

• Array of: object Charge
  The charges.

{
    "type":"array",
    "description":"The charges.",
    "items":{
        "$ref":"#/components/schemas/Charge"
    }
}

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.

{
    "required":[
        "amount",
        "priceTag",
        "type"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The charge amount."
        },
        "priceTag":{
            "type":"string",
            "description":"The charge's price tag."
        },
        "type":{
            "type":"string",
            "description":"The charge type."
        }
    },
    "description":"The charges."
}

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object overriddenCharges

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OverriddenCharges"
    }
}

Nested Schema : overriddenCharges

Type: object

Show Source

• charges(required): array charges
  The charge details.
• event(required): string
  The event associated with the overridden charges.

{
    "required":[
        "charges",
        "event"
    ],
    "type":"object",
    "properties":{
        "event":{
            "type":"string",
            "description":"The event associated with the overridden charges."
        },
        "charges":{
            "type":"array",
            "description":"The charge details.",
            "items":{
                "$ref":"#/components/schemas/Charges"
            }
        }
    },
    "xml":{
        "name":"overriddenCharges"
    }
}

Nested Schema : charges

Type: array

The charge details.

Show Source

• Array of: object Charges
  The charge details.

{
    "type":"array",
    "description":"The charge details.",
    "items":{
        "$ref":"#/components/schemas/Charges"
    }
}

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.

{
    "required":[
        "charge",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "startDate":{
            "type":"string",
            "description":"The date and time the charge's validity starts.",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "description":"The date and time the charge's validity ends.",
            "format":"date-time"
        },
        "charge":{
            "type":"array",
            "description":"The charges.",
            "items":{
                "$ref":"#/components/schemas/Charge"
            }
        }
    },
    "description":"The charge details."
}

Nested Schema : charge

Type: array

The charges.

Show Source

• Array of: object Charge
  The charges.

{
    "type":"array",
    "description":"The charges.",
    "items":{
        "$ref":"#/components/schemas/Charge"
    }
}

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.

{
    "required":[
        "amount",
        "priceTag",
        "type"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The charge amount."
        },
        "priceTag":{
            "type":"string",
            "description":"The charge's price tag."
        },
        "type":{
            "type":"string",
            "description":"The charge type."
        }
    },
    "description":"The charges."
}

Back to Top

Response

200 Response

The charges were deleted successfully.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how delete dynamic charges for a purchased product by submitting DELETE requests on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Commands

The following command shows how to delete all dynamic charges for the product:

curl -X DELETE 'http://hostname:port/bcws/webresources/version/subscriptions/offer/0.0.0.1+-purchased_product+2832219/overridecharges' -H 'content-type: application/json'

The following command shows how to specify a request body to delete only the dynamic charges specified:

curl -X DELETE 'http://hostname:port/bcws/webresources/version/subscriptions/offer/0.0.0.1+-purchased_product+2832219/overridecharges' -H 'content-type: application/json' -d @deleteCharges.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.
• deleteCharges.json is the JSON file that specifies the loan to create.

Example of Request Body for Deleting Charges by Date Range

This example shows the contents of the deleteCharges.json file sent as the request body. It deletes only the charges that fall within the specified date range.

[
   {
      "event":"/event/billing/product/fee/cycle/cycle_forward_arrear",
      "charges":[
         {
            "startDate":"2021-10-19",
            "endDate":"2021-11-19",
         }
      ]
   }
]

Example of Request Body for Deleting Charges by Price Tag

This example shows the contents of the deleteCharges.json file sent as the request body. It deletes only the charges with the specified price tag.

[
   {
      "event":"/event/billing/product/fee/cycle/cycle_forward_arrear",
      "charges":[
         {
            "startDate":"2021-10-19",
            "endDate":"2021-11-19",
            "charge":[
               {
                  
                  "priceTag":"USD",
               },
               {
                  "priceTag":"Free Minutes",
               }
            ]
         }
      ]
   }
]

Example of Response Body

If successful, the response code 200 is returned with Ok in the response body.

Back to Top