Skip to main content
A product is a reusable, shareable checkout with a fixed price: one-time, or a subscription plan billed monthly or yearly. It is the same object the dashboard calls a product and the API calls a payment link. Create it once; every buyer uses the same one. Creating the first product is the merchant’s first go-live milestone. Requires agentaos 2.1 or newer (npm install -g agentaos@latest).

Create a product or plan

string
required
Product name buyers see.
number
required
Price in currency units: 29 means €29.00.
string
EUR or USD. Defaults to the org setting.
string
Shown on the checkout page.
boolean
default:"false"
Recurring plan instead of a one-time product. Needs --interval.
'month' | 'year'
Billing cadence for a plan.
number
Free-trial length, 1 to 730 days. Plans only. The buyer’s card is saved with nothing due today; the first charge happens when the trial ends.
string
https:// URL the buyer lands on after paying. ?sessionId=<id> is appended.
string
https:// URL the buyer lands on if they back out.
boolean
Output a single JSON object instead of the human-readable summary.
--json
  • id is the linkId: pass it to checkouts.create({ linkId }) for logged-in users, or to agenta subscriptions change-plan --to.
  • checkoutUrl is the buyer link: share it, or put it behind a Buy button. It carries no app user id.
  • Return URLs must be https://; plain-http and localhost are refused before the request is sent.
  • Products created from the CLI are test-mode products. Live products are created in the dashboard once the merchant is live.
A plan with a trial:
The hosted checkout then shows “Due today €0.00, then €290.00/yr after your 14-day free trial”, saves the card, and the subscription starts as trialing.

List products

--json

Next steps

Sell a subscription

Share the link, or check out a logged-in user with the linkId.

Subscriptions

List subscribers, change plans, cancel.