Sign in

v1

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB
Product Plans

Update a Product Plan

Update an existing Product Plan. Only defaultPlan, description, name, status are updatable via API.

patch/product-plans/{id}

Path parameters

idstring required

The uberall unique id of the Product Plan

Request body

namestring

The name of the product plan

identifierstring

The Product Plan identifier based on your internal identification system

descriptionstring

Description of the plan

defaultPlanboolean

True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently

status'ACTIVE' | 'INACTIVE' | 'PENDING_APPROVAL' | 'DELETED'

Status of the Product Plan. Is possible to change an ACTIVE Product Plan to INACTIVE and vice versa.

Response

Product Plan successfully updated