API Docs / Schemas / CreateServicePackageRequest

CreateServicePackageRequest

Request DTO for creating a new service package

Properties

Name Type Description
name*string

The name of the service package

The name of the service package

descriptionstring

Description of what this package includes

Description of what this package includes

isArchivedboolean

Whether this package is archived (inactive)

Whether this package is archived (inactive)

usePackagePricingboolean

Whether this package uses a single package-level price instead of summing individual item prices

Whether this package uses a single package-level price instead of summing individual item prices

packagePricenumber

The flat price for the entire package. Required when UsePackagePricing is true.

The flat price for the entire package. Required when UsePackagePricing is true.

packageBillingFrequencyenum

OneOff Annual Quarterly Monthly

OneOff Annual Quarterly Monthly

proposalContentCodestring

The code of the proposal content block. Only used when UsePackagePricing is true.
When set, overrides the individual content blocks defined on each service in the package.
When null, proposals fall back to each service's own proposal content block.

The code of the proposal content block. Only used when UsePackagePricing is true.
When set, overrides the individual content blocks defined on each service in the package.
When null, proposals fall back to each service's own proposal content block.

itemsarray of CreateServicePackageItemRequest

The services to include in this package

The services to include in this package

JSON Example

{
  "name": "string",
  "description": "string",
  "isArchived": false,
  "usePackagePricing": false,
  "packagePrice": 0
}

Used By Operations