Service - Packages

Service package management for bundling multiple billable services together. Provides CRUD operations for creating, retrieving, updating, and deleting service packages. Each package contains a list of billable services with pre-configured billing frequency, pricing options, and pre-answered pricing factors. Packages can be applied to clients in bulk, creating multiple ClientBillableService records at once with the pre-configured settings.

OpenAPI Spec

Guides Operations Schemas

GET List ServicePackages
Lists all ServicePackages for the given tenant. Requires: ViewAll on ServicePackages.
/tenants/{tenant}/service-packages
POST Create ServicePackage
Creates a new ServicePackage for the specified tenant. Requires: Create on ServicePackages.
/tenants/{tenant}/service-packages
GET Get ServicePackage
Gets a ServicePackage for the specified tenant. Requires: ViewAll on ServicePackages.
/tenants/{tenant}/service-packages/{code}
PUT Update ServicePackage
Updates a ServicePackage for the specified tenant. Requires: Update on ServicePackages.
/tenants/{tenant}/service-packages/{code}
DELETE Delete ServicePackage
Deletes a ServicePackage for the specified tenant. Requires: Delete on ServicePackages.
/tenants/{tenant}/service-packages/{code}
POST Bulk Apply Package
Applies this service package to multiple clients at once. Creates ClientBillableService records for each package item for each client. Requires: Crea...
/tenants/{tenant}/service-packages/{code}/bulk-apply
POST Apply Service Package to Client
Applies a service package to a client, creating ClientBillableService records for each item in the package. Requires: Create on ClientBillableService...
/tenants/{tenant}/clients/{clientCode}/apply-service-package/{packageCode}
DELETE Remove Service Package from Client
Removes all client billable services linked to the specified service package. Requires: Delete on ClientBillableServices.
/tenants/{tenant}/clients/{clientCode}/apply-service-package/{packageCode}