PricingPlans

Apply plan definitions to matching organizations (async)

Brings each matching organization up to the latest revision of its plan. Only the plan fields and feature flags the plan edits changed are updated, and only where the organization still had the old plan value; values set for an organization by hand are kept. Organizations already on the latest revision are not changed.

post/pricing-plans/apply

Request

  • Base URL: https://api.xfa.tech
  • URL: https://api.xfa.tech/pricing-plans/apply
  • Auth: HTTP bearer

Request body

planNamestring

If set, apply only to organizations on this specific plan, whether standard or custom (takes precedence over includeCustomPlans). If omitted, apply to all standard plans.

includeCustomPlansboolean required

When planName is omitted, whether to also apply to organizations on custom (non-standard) plans. Ignored when planName is set.

Example request

{
  "planName": "Advanced"
}

Response

Apply started — organizations will be updated asynchronously

messagestring

Example response

{
  "message": "apply started"
}

Changes

No recorded changes to this operation across all 1 revision of this API.