Update a plan

patch

https://api.revenuehq.dev/applications/{applicationID}/plan-groups/{planGroupID}/plans/{planID}

Updates a plan by setting the values of the provided parameters.

Any parameters not included in the request payload will be left unchanged.

Returns the full plan object.

Authorized scopes:

owner
admin:full
admin:limited
application:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationID

uuid

required

The id of the application.

planGroupID

uuid

required

The id of the plan group.

planID

uuid

required

The id of the plan.

Body Params

name

string

If provided, this will overwrite the existing name. If not provided, or if an empty string is sent, this parameter will be ignored.

periodicity

object

If provided, this will overwrite the existing periodicity for the plan. If not provided, this parameter will be ignored.

The recurring periodicity for the plan. Any potential discounts or offers should not be considered -- only the final recurring periodicity. Unless the underlying plan group is managed by the Promo billing system, the duration must be a positive, non-zero value.

If the plan group is managed by the Promo billing system, the duration can be zero, which indicates that the plan will last forever.

entitlements

array of strings

If provided, this will overwrite the entitlement associated with the plan. If not provided, or if an empty array is sent, this parameter will be ignored. Only the names of the application's entitlements are sent in this array; the entitlements themselves will be pulled from the application's defined entitlements.

entitlements

callout

string

If provided, this will overwrite the existing callout. If provided as an empty string, the callout for this plan will be removed. If not provided, this parameter will be ignored.

apply_to_active

boolean

Defaults to false

If provided, and set to true, these changes will be pushed to all active subscriptions that are currently based on this plan. This update will be batched and happen as a backend job worker, and will not happen in real-time. Use extreme care when using this flag!

Headers

REVHQ-Version

integer

Responses

401

Unauthorized

200Plan updated successfully

500Server error