v1

latestOpenAPI 3.1.0AGPL-3.0-only2026-07-1773264353.7 KB

Plans

Replace a plan

Full replacement of a plan's version. On a draft plan, updates in-place. On a published plan, creates a new version. Set status to DRAFT to stage as a new draft without publishing.

put/api/v1/plans/{plan_id}

Path parameters

plan_idstring MeteroidId required

Example:plan_7n42DGM5Tflk9n8mt7Fhc7

Plan ID

Request body

currencystring required

descriptionstring nullable

namestring required

status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED'

Example request

{
  "add_ons": [
    {
      "add_on_id": "add_7n42DGM5Tflk9n8mt7Fhc7",
      "price_id": "pri_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ],
  "components": [
    {
      "fee": {
        "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7"
      },
      "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ],
  "trial": {
    "trialing_plan_id": "plan_7n42DGM5Tflk9n8mt7Fhc7"
  }
}

Response

Plan updated

billing_cyclesinteger nullable

created_atstring date-time required

currencystring required

descriptionstring nullable

idstring MeteroidId required

namestring required

net_termsinteger required

period_start_dayinteger nullable

plan_type'STANDARD' | 'FREE' | 'CUSTOM' required

self_service_rankinteger nullable

status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED' required

versioninteger required

version_idstring MeteroidId required

Example response

{
  "entitlements": [
    {
      "feature_id": "feat_7n42DGM5Tflk9n8mt7Fhc7",
      "id": "ent_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ],
  "id": "plan_7n42DGM5Tflk9n8mt7Fhc7",
  "price_components": [
    {
      "fee": {
        "metric_id": "bm_7n42DGM5Tflk9n8mt7Fhc7"
      },
      "id": "price_7n42DGM5Tflk9n8mt7Fhc7",
      "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ],
  "product_family": {
    "id": "pf_7n42DGM5Tflk9n8mt7Fhc7"
  },
  "trial": {
    "trialing_plan_id": "plan_7n42DGM5Tflk9n8mt7Fhc7"
  },
  "version_id": "plv_7n42DGM5Tflk9n8mt7Fhc7"
}