Actions20
- Administrative API Actions
- List Available Services
- Create New Location Add Request
- Create Existing Location Add Request
- Create Existing Sub Account Add Request
- Cancel Services
- Cancel Sub Account Services
- Cancel All Sub Account Services
- Create Process Review Add Request
- List Add Requests
- Get Add Request
- List Sub Account Add Requests
- Get Sub Account Add Request
- List Services
- List Sub Account Services
- Create Sub Account
- Resources Apply Request
- Get Resources Apply Request Status
- List Accounts
- Get Account
- Update Account
Administrative API → Cancel Sub Account Services
AI-generatedSummary
Cancel or decrease quantities of services (SKUs) provisioned on a specified Yext sub-account by providing the sub account ID and a list of SKUs to remove.
Inputs
- Sub Account Id (required) — String identifier of the sub-account on which to cancel services.
- Sku Removals (required) — JSON array of objects specifying SKU identifiers and optional quantities to be removed or decreased from the sub-account's active services. Quantity defaults to 1 if omitted. If quantity reaches zero, the service is stopped.
- Agreement Id — Optional numeric ID of the agreement under which the services should be canceled, usually not required except in advanced cases.
Output shape
a JSON object representing the API response confirming the cancellation or update of the specified sub-account services
The operation modifies services for the given sub-account by stopping or reducing SKUs. To cancel all services on an account instead, a separate endpoint must be used.
Examples
Example 1: Decrease quantity of certain SKUs on a sub-account to stop specific services.
Provide 'Sub Account Id' with the target account ID and 'Sku Removals' with SKUs and quantities to remove or decrease. Optionally specify 'Agreement Id' for advanced use cases.