Jump to

• Request
• Response
• Examples

Get Bundles for Transition

get

/bcws/webresources/v1.0/subscriptions/bundles/{id}/transition

Gets the list of bundles that the specified bundle can transition to with the specified transition type.

Both the id parameter and the type query parameter are required.

Request

Path Parameters

• id(required): string
  The ID of the bundle, such as 0.0.0.1+-deal+456789.

Query Parameters

• type: integer(int32)
  The type of transition, which can be upgrade (1), downgrade (2), generation change (3), red (101), blue (102), or green (103).

  This query parameter is required.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The list of bundles was returned successfully.

Body ()

Root Schema : bundleList

Type: object

Show Source

• bundle(required): array bundle
  A bundle.
• extension: object extension
  The extended attributes.

{
    "required":[
        "bundle"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "bundle":{
            "type":"array",
            "description":"A bundle.",
            "items":{
                "$ref":"#/components/schemas/Bundle"
            }
        }
    },
    "xml":{
        "name":"bundleList"
    }
}

Nested Schema : bundle

Type: array

A bundle.

Show Source

• Array of: object bundle
  A bundle.

{
    "type":"array",
    "description":"A bundle.",
    "items":{
        "$ref":"#/components/schemas/Bundle"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : bundle

Type: object

A bundle.

Show Source

• bundleId: string
  The ID of the bundle.
• chargeoffers: array chargeoffers
  The list of charge offers in the bundle.
• creationDate(required): string (date-time)
  The date and time the bundle was created.
• description: string
  The bundle's description.
• discountoffers: array discountoffers
  The list of discount offers in the bundle.
• extension: object extension
  The extended attributes.
• name: string
  The name of the bundle.
• permitted: string
  The purchase level permitted for the bundle. This can be a single service (for example, /service/email), all services (/service), all accounts (/account), or all accounts and services (*).
• ref: object ResourceRef
• service: object Service
• subscriptionTerms: object SubscriptionTerms
• tags: string
  The tags associated with the bundle.
• validTo: string (date-time)
  The date and time the validity period ends.

{
    "required":[
        "creationDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "bundleId":{
            "type":"string",
            "description":"The ID of the bundle."
        },
        "name":{
            "type":"string",
            "description":"The name of the bundle."
        },
        "permitted":{
            "type":"string",
            "description":"The purchase level permitted for the bundle. This can be a single service (for example, <b>/service/email</b>), all services (<b>/service</b>), all accounts (<b>/account</b>), or all accounts and services (<b>*</b>)."
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the bundle was created.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"The bundle's description."
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the validity period ends.",
            "format":"date-time"
        },
        "tags":{
            "type":"string",
            "description":"The tags associated with the bundle."
        },
        "ref":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "chargeoffers":{
            "type":"array",
            "description":"The list of charge offers in the bundle.",
            "items":{
                "$ref":"#/components/schemas/Chargeoffers"
            }
        },
        "discountoffers":{
            "type":"array",
            "description":"The list of discount offers in the bundle.",
            "items":{
                "$ref":"#/components/schemas/Discountoffers"
            }
        },
        "subscriptionTerms":{
            "$ref":"#/components/schemas/SubscriptionTerms"
        },
        "service":{
            "$ref":"#/components/schemas/Service"
        }
    },
    "description":"A bundle.",
    "xml":{
        "name":"bundle"
    }
}

Nested Schema : chargeoffers

Type: array

The list of charge offers in the bundle.

Show Source

• Array of: object Chargeoffers
  The list of charge offers in the bundle.

{
    "type":"array",
    "description":"The list of charge offers in the bundle.",
    "items":{
        "$ref":"#/components/schemas/Chargeoffers"
    }
}

Nested Schema : discountoffers

Type: array

The list of discount offers in the bundle.

Show Source

• Array of: object Discountoffers
  The list of discount offers in the bundle.

{
    "type":"array",
    "description":"The list of discount offers in the bundle.",
    "items":{
        "$ref":"#/components/schemas/Discountoffers"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

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

Type: object

Show Source

• accountNumber: string
  The account number associated with the service.
• discounts: array discounts
• extension: object extension
  The extended attributes.
• products: array products
• serviceDetails: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "serviceDetails":{
            "$ref":"#/components/schemas/ServiceBase"
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number associated with the service."
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Product"
            }
        },
        "discounts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Discount"
            }
        }
    }
}

Nested Schema : SubscriptionTerms

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 SubscriptionTerms
• 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 : Chargeoffers

Type: object

The list of charge offers in the bundle.

Show Source

• baseProductCode: string
  The code of the base product of the charge offer.
• baseProductName: string
  The name of the base product of the charge offer.
• baseProductRef: object ResourceRef
• description(required): string
  The charge offer's description.
• gracePeriodOffset: integer (int32)
  The number to offset the grace period by.
• gracePeriodUnit: integer (int32)
  The unit for the charge offer's grace period.
• name(required): string
  The charge offer's name.
• ref: object ResourceRef
• renewalMode: integer (int32)
  How to handle the charge 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.
• validityAlignMode: integer (int32)
  This shows if the product is an addon product and alignment of validity with other products.

{
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The charge offer's name."
        },
        "description":{
            "type":"string",
            "description":"The charge offer's description."
        },
        "ref":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "baseProductRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "baseProductName":{
            "type":"string",
            "description":"The name of the base product of the charge offer."
        },
        "baseProductCode":{
            "type":"string",
            "description":"The code of the base product of the charge offer."
        },
        "validityAlignMode":{
            "type":"integer",
            "description":"This shows if the product is an addon product and alignment of validity with other products.",
            "format":"int32"
        },
        "gracePeriodUnit":{
            "type":"integer",
            "description":"The unit for the charge offer's grace period.",
            "format":"int32"
        },
        "gracePeriodOffset":{
            "type":"integer",
            "description":"The number to offset the grace period by.",
            "format":"int32"
        },
        "renewalMode":{
            "type":"integer",
            "description":"How to handle the charge 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"
        }
    },
    "description":"The list of charge offers in the bundle."
}

Nested Schema : Discountoffers

Type: object

The list of discount offers in the bundle.

Show Source

• description(required): string
  The discount offer's description.
• name(required): string
  The discount offer's name.
• ref: object ResourceRef

{
    "required":[
        "description",
        "name"
    ],
    "type":"object",
    "properties":{
        "ref":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The discount offer's name."
        },
        "description":{
            "type":"string",
            "description":"The discount offer's description."
        }
    },
    "description":"The list of discount offers in the bundle."
}

Nested Schema : discounts

Type: array

Show Source

• Array of: object Discount

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

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : products

Type: array

Show Source

• Array of: object Product

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

Nested Schema : Discriminator: @class

Type: object

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• accountRef: object ResourceRef
• aliasList: array aliasList
  The list of aliases associated with the service.
• balanceGroupRef: object ResourceRef
• balGrpIndex: integer (int32)
  The balance group index.
• creationDate: string (date-time)
  The date and time the service type was created.
• effectiveDate: string (date-time)
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• lastModified: string (date-time)
  The date and time the service was last modified.
• lastStatusChange: string (date-time)
  The date and time of the last status change.
• lastStatusComment: string
  The comment associated with the last status change.
• lifeCycleState: integer (int32)
  The current life cycle state.
• login(required): string
  The login associated with the service.
• name: string
  The name of the service.
• nameinfoObj: object ResourceRef
• password(required): string
  The password associated with the service.
• passwordExpiration: string (date-time)
  The date and time the password expires.
• passwordStatus: integer (int32)
  The current status of the password.
• pendingDeferredActionsCount: integer (int32)
  The number of deferred actions that are pending for the service.
• serviceAccessLevel: string
  The service access level.
• status: integer (int32)
  The status.
• statusFlags: integer (int32)
  The status flags.
• subscriptionServiceRef: object ResourceRef
• svcExpLastNotiOffset: string
  The notification offset.
• svcExpLastNotiT: string (date-time)
  The last notification time.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : Discount

Type: object

Show Source

• description: string
  The discount's description.
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• lastStatusChange: string (date-time)
  The date and time the discount's status was last changed.
• name: string
  The discount's name.
• planName: string
  The name of the package containing the discount.
• purchaseDate(required): string (date-time)
  The date and time the discount was purchased.
• purchaseEndDate(required): string (date-time)
  The date and time the purchase ends.
• status: string
  The discount's status
• type: integer (int32)
  The type of discount. Can be one of the following:

  • 0: Optional
  • 1: Required
  • 2: Regular

{
    "required":[
        "purchaseDate",
        "purchaseEndDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The discount's name."
        },
        "planName":{
            "type":"string",
            "description":"The name of the package containing the discount."
        },
        "description":{
            "type":"string",
            "description":"The discount's description."
        },
        "purchaseDate":{
            "type":"string",
            "description":"The date and time the discount was purchased.",
            "format":"date-time"
        },
        "purchaseEndDate":{
            "type":"string",
            "description":"The date and time the purchase ends.",
            "format":"date-time"
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time the discount's status was last changed.",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "description":"The discount's status"
        },
        "type":{
            "type":"integer",
            "description":"The type of discount. Can be one of the following: <ul><li><b>0</b>: Optional</li><li><b>1</b>: Required</li><li><b>2</b>: Regular</li></ul>",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Product

Type: object

Show Source

• contractEndDate: string (date-time)
  The end date for the contract.
• contractName: string
  The name of the contract.
• contractRef: object ResourceRef
• contractStartDate: string (date-time)
  The start date for the contract.
• description: string
  The product's descritpion.
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• isOfferCustomized: boolean
  Whether the product contains customized offers (true) or not (false).
• lastStatusChange: string (date-time)
  The date and time the product's status was last changed.
• name: string
  The product's name.
• planName: string
  The name of the package that contains the product.
• productRef: object ResourceRef
• purchaseDate(required): string (date-time)
  The date and time the product was purchased.
• purchaseEndDate(required): string (date-time)
  The date and time the purchase ends.
• status: string
  The product's status.
• termRef: object ResourceRef
• type: integer (int32)
  The type of product. Can be one of the following:

  • 0: Optional
  • 1: Required
  • 2: Regular

{
    "required":[
        "purchaseDate",
        "purchaseEndDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "productRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The product's name."
        },
        "planName":{
            "type":"string",
            "description":"The name of the package that contains the product."
        },
        "description":{
            "type":"string",
            "description":"The product's descritpion."
        },
        "purchaseDate":{
            "type":"string",
            "description":"The date and time the product was purchased.",
            "format":"date-time"
        },
        "purchaseEndDate":{
            "type":"string",
            "description":"The date and time the purchase ends.",
            "format":"date-time"
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time the product's status was last changed.",
            "format":"date-time"
        },
        "isOfferCustomized":{
            "type":"boolean",
            "description":"Whether the product contains customized offers (<b>true</b>) or not (<b>false</b>)."
        },
        "status":{
            "type":"string",
            "description":"The product's status."
        },
        "type":{
            "type":"integer",
            "description":"The type of product. Can be one of the following: <ul><li><b>0</b>: Optional</li><li><b>1</b>: Required</li><li><b>2</b>: Regular</li></ul>",
            "format":"int32"
        },
        "contractName":{
            "type":"string",
            "description":"The name of the contract."
        },
        "contractStartDate":{
            "type":"string",
            "description":"The start date for the contract.",
            "format":"date-time"
        },
        "contractEndDate":{
            "type":"string",
            "description":"The end date for the contract.",
            "format":"date-time"
        },
        "contractRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "termRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : aliasList

Type: array

The list of aliases associated with the service.

Show Source

• Array of: object AliasList
  The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : AliasList

Type: object

The list of aliases associated with the service.

Show Source

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

Nested Schema : extension

Type: object

The extended attributes.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the bundles that a specified bundle can transition to with the specified transition type 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/bundles/0.0.0.1+-deal+8860917/transition?type=1'

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.

{
    "extension":null,
    "bundle":[
        {
            "extension":null,
            "bundleId":"0.0.0.1+-deal+8862965",
            "name":"DealBroadband2",
            "permitted":"/service/broadband",
            "creationDate":1500961416000,
            "description":"",
            "validTo":0,
            "tags":"Uncategorized",
            "ref":{
                "id":"0.0.0.1+-deal+8862965",
                "uri":null
            },
            "chargeoffers":[
                {
                    "name":"Product_BroadBand2",
                    "description":"",
                    "ref":{
                        "id":"0.0.0.1+-product+8863605","uri":null
                    }
                }
            ],
            "discountoffers":[],
            "subscriptionTerms":null,
            "service":null
        }
    ]
}

Back to Top