Skip to content

Update a plan

PUT
/api/v1/pricing/plans/{plan_id}

Update an existing pricing plan. By default operates in dry-run mode to preview changes.

plan_id
required
string

Plan identifier

object
name
string
tier
string
Allowed values: starter professional premium enterprise
monthly_price
string
annual_price
string
description
string
included_contacts
integer
included_users
integer
features
Array<string>
is_legacy
boolean
dry_run
boolean
default: true

Update result

object
data
object
dry_run
boolean
applied
boolean
changes
object
updated_plan
object
id
string
Example
professional
name
string
Example
Professional
tier
string
Allowed values: starter professional premium enterprise
monthly_price
string
Example
99.00
annual_price
string
Example
990.00
description
string
included_contacts
integer
Example
5000
included_users
integer
Example
10
features
Array<string>
is_legacy
boolean

Bad request - invalid input

object
error
object
code

Error code

string
Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR
message

Human-readable error message

string

Unauthorized - missing or invalid credentials

object
error
object
code

Error code

string
Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR
message

Human-readable error message

string

Resource not found

object
error
object
code

Error code

string
Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR
message

Human-readable error message

string