Update a plan

PATCH

//api/v1/platform/plans/{plan}

Updates commercial fields through PlanService::updatePlan().
is_active is applied via PlanService::setActive(), which rejects
deactivating the default plan. CSRF required.

Request

Authorization

API Key

Add parameter in cookie

replyable-session

Example:

replyable-session: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200PlatformPlanResponse

application/json

Administrative plan

Bodyapplication/json

🟠401Unauthenticated

🟠403Forbidden

🟠404NotFound

🟠419CsrfMismatch

🟠422ValidationError

🟠429TooManyRequests

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '//api/v1/platform/plans/' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "slug": "string",
    "description": "string",
    "is_active": true,
    "is_default": true,
    "sort_order": 0,
    "monthly_price": 0,
    "yearly_price": 0,
    "currency": "string",
    "trial_days": 0,
    "features": {},
    "limits": {},
    "metadata": {}
}'

Response Example

200 - Example 1

{
    "data": {
        "id": "string",
        "slug": "string",
        "name": "string",
        "description": "string",
        "is_active": true,
        "is_default": true,
        "sort_order": 0,
        "monthly_price": "string",
        "yearly_price": "string",
        "currency": "string",
        "trial_days": 0,
        "features": {
            "property1": true,
            "property2": true
        },
        "limits": {
            "property1": 0,
            "property2": 0
        },
        "metadata": {},
        "businesses_count": 0,
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "deleted_at": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-08-18 22:33:35

Show a plan for administration

Receive a billing provider webhook