Change a web hosting package to a higher plan
Changes one web hosting package to a higher plan, for its price - after the user agreed to the AGB and the change.
Changes a web hosting package to a higher plan, for a higher price, by its site_id and an option_id of manitu_webhosting_upgrade_option_listPOST /v1/webhosting/upgrade/option/list; the change takes effect at once. Refused per field when the option is not on offer for the package (option_not_available), and with a conflict when the account may not order (order_not_allowed, with reason_list) or when the package cannot be changed now (not_configurable). Made with a session of the customer panel, the call is carried out at once; otherwise it waits until a person signed in to the customer panel approves it (approval_required; its state: manitu_approval_getPOST /v1/approval/get).
Counts against: writes (60 per hour per account)
manitu_webhosting_upgrade on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Changes a web hosting package to a higher plan, for a higher price, by its site_id and an option_id from manitu_webhosting_upgrade_option_listPOST /v1/webhosting/upgrade/option/list (tell the user the price from there first). The change takes effect at once. Waits for the user's approval in the customer panel: the call is answered with approval_required and a pending_action, its approval holding as elements the AGB as a document with a link, the change as a text and the new plan's price as a price - nothing is changed until the user approves it there. Refused per field when the option is not on offer for the package (option_not_available), and with a conflict when the account may not order (order_not_allowed, with reason_list) or the package cannot be changed now (not_configurable).
Arguments
site_id (required)integer | stringThe site_id of the package. Never guess one.
option_id (required)stringThe option_id of the plan to change to. Never guess one.
approval_tokenstringwrite-onlyThe token of the way call_again from the approval_required answer of the same call - only after the user said yes to everything in its elements. Valid 15 minutes, once.
Result structuredContent, checked against the schema
site_idintegerThe package.
previous_planobjectThe plan the package had.
previous_plan.namestringThe plan, e.g. Webhosting M.
previous_plan.price_centintegerThe price per period, in euro cent.
previous_plan.price_typestringnet: without VAT; gross: with VAT.
previous_plan.period_typestringWhat the price is for: month or year (times period_length), onetime, or none.
previous_plan.period_lengthintegerHow many months or years one period has.
planobjectThe plan the package has now.
plan.namestringThe plan, e.g. Webhosting M.
plan.price_centintegerThe price per period, in euro cent.
plan.price_typestringnet: without VAT; gross: with VAT.
plan.period_typestringWhat the price is for: month or year (times period_length), onetime, or none.
plan.period_lengthintegerHow many months or years one period has.
Authentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
site_id (required)integer | stringThe site_id of the package.
option_id (required)stringThe option_id of the plan to change to.
approval_tokenstringwrite-onlyThe token of the way call_again from the approval_required answer of the same call - only after the user said yes to everything in its elements. Valid 15 minutes, once.
Response in data; the rest of the body as on every call
site_idintegerThe package.
previous_planobjectThe plan the package had.
previous_plan.namestringThe plan, e.g. Webhosting M.
previous_plan.price_centintegerThe price per period, in euro cent.
previous_plan.price_typestringnet: without VAT; gross: with VAT.
previous_plan.period_typestringWhat the price is for: month or year (times period_length), onetime, or none.
previous_plan.period_lengthintegerHow many months or years one period has.
planobjectThe plan the package has now.
plan.namestringThe plan, e.g. Webhosting M.
plan.price_centintegerThe price per period, in euro cent.
plan.price_typestringnet: without VAT; gross: with VAT.
plan.period_typestringWhat the price is for: month or year (times period_length), onetime, or none.
plan.period_lengthintegerHow many months or years one period has.
Statuses
200Success.400The input is wrong, or the request itself (INVALID_INPUT). Each entry names its field and its reason - correct the input and call again.401No credential was presented, or it was not recognised (UNAUTHENTICATED).403The credential is valid, but may not do this (PERMISSION_DENIED). The reason says why - another credential is the way, not a repeat.429Too many calls. The Retry-After header says when to try again.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.