Skip to navigation

Bundle plans update fields

View as Markdown

Use this reference to view data dictionary details for update bundle plans template.

Hard product bundles combine multiple products, their component rate plans, and selected charges into a single purchasable bundle. A bundled product cannot have a non-bundled plan.

Fields with an asterisk mark (*) indicate mandatory fields.

You can download the Data Dictionary for Bundle Plans in CSV format - Bundle Plans.csv

NameDescriptionValue
Id*Unique identifier of the bundle product.string
Active CurrenciesCharge pricing, such as USD or EUR amounts.object
Cascade Entitlements Effective DatingDetermines whether changes to the bundle plan’s effective dates also update the effective dates of its associated entitlements.boolean
DescriptionDescription of the bundle plan.string
External Rate Plan IDIds used by an external system to identify rate plansstring. Enter multiple Ids, separated by comma.
NameName of the bundle plan.string
Product IdId of the bundle product that owns the planstring
Product Rate Plan NumberUnique number that idenfies the plan.string
Start DateEffective start date of the bundle product.date(yyyy-mm-dd)
End DateEffective end date of the bundle productdate(yyyy-mm-dd)
Rate Plan TypeIdentifier of the bundle plan.enum: rateplan_hard_bundle, rateplan_configurable_bundle, NULL. Allowed value: hard_bundle
StateIdentifies the bundle plan’s lifecycle status.enum
VersionIndicates the revision of the bundle plan.string
Bundle Config > Bundle Configuration IDReferences the component products included in the bundle. The array must not be empty or null.string
Bundle Config > Component IDsComponent plan IDs. The plans must belong to products listed in the product-level bundle_config.Array of plan IDs
Bundle Config > Component Group IDsIDs of option groups associated with the bundle.string. Enter multiple IDs, separated by commas.