Skip to main content
PUT
/
api
/
v1
/
vendors
/
{vendorId}
/
plans
/
{planId}
Update Plan
curl --request PUT \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/plans/{planId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Standard Tier Plus",
  "includedInboundSeconds": 1200,
  "includedOutboundSeconds": 600,
  "inboundSecondsLimit": 6000,
  "outboundSecondsLimit": 2500,
  "inboundSecondPriceCent": 2,
  "outboundSecondPriceCent": 4,
  "inboundSecondOverusePriceCent": 4,
  "outboundSecondOverusePriceCent": 6,
  "enforceInboundSecondsLimit": true,
  "enforceOutboundSecondsLimit": true,
  "baseRecurringPriceCent": 1200
}
'
{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": null,
  "traceId": "<string>"
}

Path Parameters

​
vendorId
string
required

ID of the Vendor (UUID)

​
planId
string
required

ID of the Plan to update (UUID)

Body

application/json

Plan update data

Data required to update an existing pricing Plan.

​
name
string
required

Updated name of the plan.

Example:

"Standard Tier Plus"

​
includedInboundSeconds
integer<int32>
required

Updated number of inbound minutes included.

Example:

1200

​
includedOutboundSeconds
integer<int32>
required

Updated number of outbound minutes included.

Example:

600

​
inboundSecondsLimit
integer<int32>
required

Updated hard limit for inbound minutes.

Example:

6000

​
outboundSecondsLimit
integer<int32>
required

Updated hard limit for outbound minutes.

Example:

2500

​
inboundSecondPriceCent
integer<int32>
required

Updated price per inbound minute. In Cents.

Example:

2

​
outboundSecondPriceCent
integer<int32>
required

Updated price per outbound minute. In Cents.

Example:

4

​
inboundSecondOverusePriceCent
integer<int32>
required

Updated price per overuse inbound minute. In Cents.

Example:

4

​
outboundSecondOverusePriceCent
integer<int32>
required

Updated price per overuse outbound minute. In Cents.

Example:

6

​
enforceInboundSecondsLimit
boolean
required

Updated setting for enforcing inbound limit.

Example:

true

​
enforceOutboundSecondsLimit
boolean
required

Updated setting for enforcing outbound limit.

Example:

true

​
baseRecurringPriceCent
integer<int32>
required

Updated base recurring price. In Cents.

Example:

1200

Response

Plan successfully updated

Standard API response wrapper

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
timestamp
string<date-time>
required

Response timestamp in ISO-8601 format

Example:

"2025-04-17T14:23:30Z"

​
message
string

Human-readable message

​
data
any

Payload data object

Example:

null

​
traceId
string

Correlation or trace ID