Jump to

• Request
• Response
• Examples

Get Customized Account Offers

get

/bcws/webresources/v1.0/subscriptions/account/{id}/customizedoffers

Gets a list of customized account-level offers for an account.

Request

Path Parameters

• id(required): string
  The ID of the account.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The list of customized account-level offers was returned successfully.

Body ()

Root Schema : customizedOffers

Type: object

Show Source

• customizedOffer: array customizedOffer

{
    "type":"object",
    "properties":{
        "customizedOffer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomizedOffer"
            }
        }
    },
    "xml":{
        "name":"customizedOffers"
    }
}

Nested Schema : customizedOffer

Type: array

Show Source

• Array of: object CustomizedOffer

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

Nested Schema : CustomizedOffer

Type: object

Show Source

• contractEndDate: string (date-time)
• contractName: string
• contractRef: object ResourceRef
• contractStartDate: string (date-time)
• cycleDuration: integer (int32)
  The accounting cycle duration.
• cycleEndT(required): string (date-time)
  The date and time the cycle changes end.
• cycleStartT(required): string (date-time)
  The date and time the cycle changes start.
• dealName: string
  The name of the deal that contains the offer.
• dealRef: object ResourceRef
• description: string
  The offer's description.
• gracePeriodOffset: integer (int32)
  The number to offset the grace period by.
• gracePeriodUnit: integer (int32)
  The unit the grace period is measured in.
• id(required): string
  The ID.
• name: string
  The offer's name.
• overriddenCharges(required): array overriddenCharges
  The overridden charges.
• packageId: integer (int32)
  The package id of offer.
• planName: string
  The name of the package that contains the offer.
• planRef: object ResourceRef
• purchasedDate(required): string (date-time)
  The date on which the offer is purchased.
• purchaseDiscount(required): number
  The amount of the purchase fee discount.
• purchaseDiscountPercent(required): number
  The percentage amount by which to discount the purchase fee.
• purchasedProductRef: object ResourceRef
• purchaseEndT(required): string (date-time)
  The date and time the purchase changes end.
• purchaseFee(required): number
  The purchase fee amount.
• purchaseFeeOverriden(required): number
  The amount by which to override the purchase fee.
• purchaseStartT(required): string (date-time)
  The date and time the purchase changes start.
• quantity(required): number
  The quantity of offer.
• recurringDiscount(required): number
  The fixed amount of the recurring discount.
• recurringDiscountPercent(required): number
  The percentage amount of the recurring discount.
• recurringFee(required): number
  The amount of the recurring fee.
• recurringFeeOverriden(required): number
  The amount by which to override the recurring fee.
• renewalMode: integer (int32)
  How to handle the 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.
• serviceName: string
  The name of the service that contains the offer.
• serviceRef: object ResourceRef
• serviceType: string
  The type of the service that contains the offer.
• status: string
  The offer's status.
• terminationFee: number
  The amount of the early termination fee.
• termRef: object ResourceRef
• usageDiscount(required): number
  The amount of the usage discount.
• usageEndT(required): string (date-time)
  The date and time the usage changes end.
• usageStartT(required): string (date-time)
  The date and time the usage changes start.

{
    "required":[
        "cycleEndT",
        "cycleStartT",
        "id",
        "overriddenCharges",
        "purchaseDiscount",
        "purchaseDiscountPercent",
        "purchaseEndT",
        "purchaseFee",
        "purchaseFeeOverriden",
        "purchaseStartT",
        "purchasedDate",
        "quantity",
        "recurringDiscount",
        "recurringDiscountPercent",
        "recurringFee",
        "recurringFeeOverriden",
        "usageDiscount",
        "usageEndT",
        "usageStartT"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "purchasedProductRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "cycleDuration":{
            "type":"integer",
            "description":"The accounting cycle duration.",
            "format":"int32"
        },
        "recurringFee":{
            "type":"number",
            "description":"The amount of the recurring fee."
        },
        "recurringFeeOverriden":{
            "type":"number",
            "description":"The amount by which to override the recurring fee."
        },
        "recurringDiscount":{
            "type":"number",
            "description":"The fixed amount of the recurring discount."
        },
        "recurringDiscountPercent":{
            "type":"number",
            "description":"The percentage amount of the recurring discount."
        },
        "purchaseFee":{
            "type":"number",
            "description":"The purchase fee amount."
        },
        "purchaseFeeOverriden":{
            "type":"number",
            "description":"The amount by which to override the purchase fee."
        },
        "purchaseDiscount":{
            "type":"number",
            "description":"The amount of the purchase fee discount."
        },
        "purchaseDiscountPercent":{
            "type":"number",
            "description":"The percentage amount by which to discount the purchase fee."
        },
        "usageDiscount":{
            "type":"number",
            "description":"The amount of the usage discount."
        },
        "usageStartT":{
            "type":"string",
            "description":"The date and time the usage changes start.",
            "format":"date-time"
        },
        "usageEndT":{
            "type":"string",
            "description":"The date and time the usage changes end.",
            "format":"date-time"
        },
        "purchaseStartT":{
            "type":"string",
            "description":"The date and time the purchase changes start.",
            "format":"date-time"
        },
        "purchaseEndT":{
            "type":"string",
            "description":"The date and time the purchase changes end.",
            "format":"date-time"
        },
        "cycleStartT":{
            "type":"string",
            "description":"The date and time the cycle changes start.",
            "format":"date-time"
        },
        "cycleEndT":{
            "type":"string",
            "description":"The date and time the cycle changes end.",
            "format":"date-time"
        },
        "gracePeriodUnit":{
            "type":"integer",
            "description":"The unit the grace period is measured in.",
            "format":"int32"
        },
        "gracePeriodOffset":{
            "type":"integer",
            "description":"The number to offset the grace period by.",
            "format":"int32"
        },
        "renewalMode":{
            "type":"integer",
            "description":"How to handle the offer's cycle alignment when its bundle is reactivated. Possible values are: <ul><li><b>0</b>: Cycle aligns with the original billing date or configured specific day of the month.</li><li><b>1</b>: Cycle aligns with the reactivation date.</li></ul>",
            "format":"int32"
        },
        "terminationFee":{
            "type":"number",
            "description":"The amount of the early termination fee."
        },
        "overriddenCharges":{
            "type":"array",
            "description":"The overridden charges.",
            "items":{
                "$ref":"#/components/schemas/OverriddenCharges"
            }
        },
        "name":{
            "type":"string",
            "description":"The offer's name."
        },
        "planName":{
            "type":"string",
            "description":"The name of the package that contains the offer."
        },
        "dealName":{
            "type":"string",
            "description":"The name of the deal that contains the offer."
        },
        "serviceName":{
            "type":"string",
            "description":"The name of the service that contains the offer."
        },
        "serviceType":{
            "type":"string",
            "description":"The type of the service that contains the offer."
        },
        "dealRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "planRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "description":{
            "type":"string",
            "description":"The offer's description."
        },
        "status":{
            "type":"string",
            "description":"The offer's status."
        },
        "quantity":{
            "type":"number",
            "description":"The quantity of offer."
        },
        "packageId":{
            "type":"integer",
            "description":"The package id of offer.",
            "format":"int32"
        },
        "purchasedDate":{
            "type":"string",
            "description":"The date on which the offer is purchased.",
            "format":"date-time"
        },
        "contractName":{
            "type":"string"
        },
        "contractStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "contractEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "contractRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "termRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    }
}

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 : overriddenCharges

Type: array

The overridden charges.

Show Source

• Array of: object overriddenCharges

{
    "type":"array",
    "description":"The overridden charges.",
    "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."
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the customized charge offers for an account 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/account/0.0.0.1+-service-ip+156801/customizedoffers'

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.

{
    "customizedOffer": [
        {
            "id": "0.0.0.1+-product+143633",
            "purchasedProductRef": {
                "id": "0.0.0.1+-purchased_product+157313",
                "uri": null
            },
            "cycleDuration": 1,
            "recurringFee": 10,
            "recurringFeeOverriden": 0,
            "recurringDiscount": 0,
            "recurringDiscountPercent": 0,
            "purchaseFee": null,
            "purchaseFeeOverriden": 0,
            "purchaseDiscount": 0,
            "purchaseDiscountPercent": 0,
            "usageDiscount": 0,
            "usageStartT": 1601362800000,
            "usageEndT": 0,
            "purchaseStartT": 1601362800000,
            "purchaseEndT": 0,
            "cycleStartT": 1601362800000,
            "cycleEndT": 0,
            "terminationFee": null
        }
    ]
}

Back to Top