• 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"
    }
}

• Array of: object bundle
  A bundle.

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

• 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
  A service associated with the bundle.
• 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"
    }
}

• 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"
    }
}

• 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"
    }
}

• 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."
        }
    }
}

• serviceKey: string
  The service key.
• serviceType: string
  The service type.

{
    "type":"object",
    "properties":{
        "serviceKey":{
            "type":"string",
            "description":"The service key."
        },
        "serviceType":{
            "type":"string",
            "description":"The service type."
        }
    },
    "description":"A service associated with the bundle."
}

• 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.
• 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
• subscriberContractRef: object ResourceRef
• termsDescription: string
  The subscription terms' description.
• termsName(required): string
  The subscription terms' name.

{
    "required":[
        "bundleName",
        "commitmentEndDate",
        "commitmentStartDate",
        "earlyCancellationDate",
        "earlyCancellationFee",
        "id",
        "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"
        },
        "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"
        },
        "renewalContractTerms":{
            "$ref":"#/components/schemas/SubscriptionTerms"
        }
    }
}

• 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."
}

• 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."
}