Get Plan

GET

api

vendors

{vendorId}

plans

{planId}

Get Plan Details

curl --request GET \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/plans/{planId}

{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": {
    "id": "c4a9e3f8-a3b2-4d1c-8b7e-5a9f0d1e2c3b",
    "name": "Standard Tier",
    "includedInboundSeconds": 1000,
    "includedOutboundSeconds": 500,
    "inboundSecondsLimit": 5000,
    "outboundSecondsLimit": 2000,
    "inboundSecondPriceCent": 2,
    "outboundSecondPriceCent": 4,
    "inboundSecondOverusePriceCent": 3,
    "outboundSecondOverusePriceCent": 5,
    "enforceInboundSecondsLimit": true,
    "enforceOutboundSecondsLimit": false,
    "baseRecurringPriceCent": 1000
  },
  "traceId": "<string>"
}

Path Parameters

vendorId

string

required

ID of the Vendor (UUID)

planId

string

required

ID of the Plan (UUID)

Response

Successfully retrieved plan details

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

object

Payload data object

Show child attributes

data.id

string

required

Unique identifier of the plan (UUID).

Example:

"c4a9e3f8-a3b2-4d1c-8b7e-5a9f0d1e2c3b"

data.name

string

required

Name of the plan.

Example:

"Standard Tier"

data.includedInboundSeconds

integer<int32>

required

Number of inbound minutes included in the base price.

Example:

1000

data.includedOutboundSeconds

integer<int32>

required

Number of outbound minutes included in the base price.

Example:

500

data.inboundSecondsLimit

integer<int32>

required

Hard limit for inbound minutes (usage stops if exceeded and enforce=true).

Example:

5000

data.outboundSecondsLimit

integer<int32>

required

Hard limit for outbound minutes (usage stops if exceeded and enforce=true).

Example:

2000

data.inboundSecondPriceCent

integer<int32>

required

Price per inbound minute (within included amount, if applicable, otherwise standard rate). In Cents.

Example:

2

data.outboundSecondPriceCent

integer<int32>

required

Price per outbound minute (within included amount, if applicable, otherwise standard rate). In Cents.

Example:

4

data.inboundSecondOverusePriceCent

integer<int32>

required

Price per inbound minute after included amount is used. In Cents.

Example:

3

data.outboundSecondOverusePriceCent

integer<int32>

required

Price per outbound minute after included amount is used. In Cents.

Example:

5

data.enforceInboundSecondsLimit

boolean

required

Whether to enforce the hard limit for inbound minutes.

Example:

true

data.enforceOutboundSecondsLimit

boolean

required

Whether to enforce the hard limit for outbound minutes.

Example:

false

data.baseRecurringPriceCent

integer<int32>

required

Base recurring price for the plan (e.g., monthly). In Cents.

Example:

1000

traceId

string

Correlation or trace ID

Update PlanUpdates the details of an existing pricing plan.

⌘I

Get Plan Details

curl --request GET \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/plans/{planId}

{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": {
    "id": "c4a9e3f8-a3b2-4d1c-8b7e-5a9f0d1e2c3b",
    "name": "Standard Tier",
    "includedInboundSeconds": 1000,
    "includedOutboundSeconds": 500,
    "inboundSecondsLimit": 5000,
    "outboundSecondsLimit": 2000,
    "inboundSecondPriceCent": 2,
    "outboundSecondPriceCent": 4,
    "inboundSecondOverusePriceCent": 3,
    "outboundSecondOverusePriceCent": 5,
    "enforceInboundSecondsLimit": true,
    "enforceOutboundSecondsLimit": false,
    "baseRecurringPriceCent": 1000
  },
  "traceId": "<string>"
}

Overview

Realtime

Assistants

Agents

Agent Tasks

Organizations

Plans

Vendors

Path Parameters

Response