Skip to content

Update Revenue Plan

PUT
/revenue/plans/{plan_id}

Edit any subset of a plan’s fields.

Authorizations

Parameters

Path Parameters

plan_id
required

Plan id.

string

Plan id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
active
Any of:
boolean
list_price_cents
Any of:
integer
mrr_band
Any of:
string
Allowed values: <1k 1k-5k 5k-25k >25k
name
Any of:
string
>= 1 characters <= 255 characters
slug
Any of:
string
<= 255 characters

Responses

200

Successful Response

object
data
required

An activity, snapshot, plan or result, as the app returns it.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string