Skip to navigation

Plans

A plan is a named set of prices for one agent. Customers are put on a plan through a subscription, so the same agent can be billed differently to different customers.

paygent plan create

paygent plan create --agent support-bot --name "Starter"
FlagDescription
--agent <agent>The agent this plan prices. Required, and cannot be changed later.
--name <name>Plan name. Required.
--type <type>standard (default) or custom.
--customer <customer>Scope a custom plan to this customer. Repeatable.
--from-file <path>JSON pricing document.

A new plan starts from its agent’s pricing unless you pass --from-file. An exported document can be reused:

paygent agent pricing show support-bot > pricing.json
paygent plan create --agent support-bot --name "Enterprise" --from-file pricing.json

paygent plan list

paygent plan list
paygent plan list --agent support-bot

--agent is the only server-side filter this API offers.

paygent plan get

paygent plan get Starter

paygent plan update

paygent plan update Starter --description "Entry tier"

paygent plan archive

Archive a plan without deleting it.

paygent plan archive Starter

paygent plan delete

paygent plan delete Starter --force