asksteps: get the link where the user books a plan
asksteps_start_checkoutReturns the link where the user books a plan themselves, with that plan preselected, and the exact net price. Requires "billing:write". NOTHING is bought by this call and nothing can be: the customer enters their payment details with the payment provider and gives the statutory acknowledgement personally — asksteps never sees card data, and that declaration is not one a machine can make for someone. Use this for a FIRST purchase. To move an existing paid account between plans, use asksteps_change_plan instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| interval | No | "month" (default) or "year". | |
| plan_code | Yes | Plan code: "starter", "professional" or "business". Call asksteps_get_capabilities for the catalogue. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Link where the user completes the purchase themselves. Give it to them verbatim. | |
| note | Yes | One sentence for the user. On "confirmation_required" it names the plan, the price and what changes — read it out before asking. | |
| status | Yes | Outcome. One of: "changed" (the plan is now different), "confirmation_required" (read the note to the user and call again with confirm = true if they agree), "checkout_required" (give them the url; only they can enter payment details), "not_allowed" (outside the mandate — the note says which limit), "not_connected", "error". Authorisation can also refuse before the tool runs: "plan_required" (the account's plan does not include agent access), "not_enabled" (the account owner has not switched agent access on), "owner_required" (only the account owner may do this), "mandate_required" (the owner has not granted a mandate for this). The note then says what the user has to do. | |
| interval | No | The billing interval this price refers to: "month" or "year". | |
| planCode | No | The plan code after the change, when something changed. | |
| priceCents | No | The net price per interval in cents, so you can state it exactly instead of estimating. |