Update a plan
PATCH
/api/v1/profiles/{id}
prm_profiles_update
Partial update. Numeric and foreign-key fields can be cleared to null by sending null explicitly, which is distinct from omitting them.
Editing a plan does not re-provision the subscribers already on it, with one exception: switching enforce_expiration off clears every subscriber's expiration to null (never expires), and switching it on gives each subscriber without a date one plan period from now. Their quota and window were written at activation time; a price or limit change applies to the next activation, not retroactively.
At a glance
- Authentication
- Staff token or session
- Requires permission
-
prm_profiles_updateEdit profiles - Rate limit
t_mutate
Parameters
| Parameter | Description |
|---|---|
idrequired
path · integer
|
Plan id. |
Errors
| Code | When it is returned |
|---|---|
ERR_VALIDATION400
|
the merged result is a prepaid/postpaid plan that limits expiration without a period (reason profile_expiration_period_required), or an out-of-range value |