Plans

Publish a draft plan version

Publishes the current draft version, making it the active version.

post/api/v1/plans/{plan_id}/publish

Path parameters

plan_idstring MeteroidId required

Example:plan_7n42DGM5Tflk9n8mt7Fhc7

Plan ID

Response

Plan published

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"
}

Changes

Changed in 8 of the 54 revisions of this API.1147

Aug 12, 2026v14e013b4e4a8f8See the full diff
- ▲
  the response property price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing/oneOf[TieredPlanPricing]/tiers/items/flat_cap became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing/oneOf[TieredPlanPricing]/tiers/items/flat_fee became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing/oneOf[VolumePlanPricing]/tiers/items/flat_cap became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing/oneOf[VolumePlanPricing]/tiers/items/flat_fee became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing/oneOf[TieredPlanPricing]/tiers/items/flat_cap became optional for the status 200
  response-property-became-optional
- ▲
  the response property price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing/oneOf[TieredPlanPricing]/tiers/items/flat_fee became optional for the status 200
  response-property-became-optional
- ▲
  the response property price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing/oneOf[VolumePlanPricing]/tiers/items/flat_cap became optional for the status 200
  response-property-became-optional
- ▲
  the response property price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing/oneOf[VolumePlanPricing]/tiers/items/flat_fee became optional for the status 200
  response-property-became-optional
Jun 1, 2026v107a61fe347a511See the full diff
- ▲
  removed the required property entitlements/items/value/oneOf[MeteredEntitlementValue]/overage_behavior from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property entitlements/items/value/oneOf[MeteredEntitlementValue]/warning_threshold_pct from the response with the 200 status
  response-optional-property-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 28, 2026v1ed86d893d43e12See the full diff
- ▲
  added BooleanEntitlementValue MeteredEntitlementValue to the entitlements/items/value response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  added discriminator to entitlements/items/value response property for the response status 200
  response-property-discriminator-added
- ○
  removed subschema #1 subschema #2 from the entitlements/items/value response property oneOf list for the response status 200
  response-property-one-of-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 18, 2026v10cdc37620ffb1See the full diff
- ○
  added the optional property entitlements to the response with the 200 status
  response-optional-property-added
Mar 31, 2026v1ee465c53a4232See the full diff
- ○
  response discriminator property name changed for price_components/items/fee/oneOf[Fee]/ response property from fee_type to type for the response status 200
  response-property-discriminator-property-name-changed
- ○
  response discriminator property name changed for price_components/items/fee/oneOf[Fee]/oneOf[UsagePlanFee]/pricing response property from discriminator to type for the response status 200
  response-property-discriminator-property-name-changed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 27, 2026v1de35c02bb0d231See the full diff
- ●
  added the new TOO_MANY_REQUESTS enum value to the code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new TOO_MANY_REQUESTS enum value to the code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new TOO_MANY_REQUESTS enum value to the code response property for the response status 409
  response-property-enum-value-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Mar 20, 2026v151c7018cc5ef1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 9, 2025v1dece17f86f991See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 274 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history