Sign in
Plans

Get plan details

Retrieve a specific plan. Use ?version=draft for the draft version, ?version=2 for a specific version number, or omit for the active version.

get/api/v1/plans/{plan_id}

Path parameters

plan_idstring MeteroidId required
Example:plan_7n42DGM5Tflk9n8mt7Fhc7

Plan ID

Query parameters

versionstring

Filter by version: "draft", a version number, or omitted for active

Response

Plan details

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 17 of the 54 revisions of this API.18432

  • v14e013b4e4a8f8See 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

  • v107a61fe347a511See 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

  • v1ed86d893d43e12See 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

  • v10cdc37620ffb1See the full diff
    • ○

      added the optional property entitlements to the response with the 200 status

      response-optional-property-added

  • v1ee465c53a4232See 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

  • v1de35c02bb0d221See 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 non-success response with the status 429

      response-non-success-status-added

  • v151c7018cc5ef9See the full diff
    • ○

      added the new optional query request parameter version

      new-optional-request-parameter

    • ○

      added the media type application/json for the response with the status 401

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    • ○

      added the optional property billing_cycles to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property period_start_day to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property self_service_rank to the response with the 200 status

      response-optional-property-added

    • ○

      added CAPACITY EXTRA_RECURRING ONE_TIME RATE SLOT USAGE discriminator mapping keys to the price_components/items/fee/oneOf[Fee]/ response property for the response status 200

      response-property-discriminator-mapping-added

    • ○

      removed capacity extra_recurring one_time rate slot usage discriminator mapping keys from the price_components/items/fee/oneOf[Fee]/ response property for the response status 200

      response-property-discriminator-mapping-deleted

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v11bbd84c95e4122See the full diff
    • ▲

      the response property price_components/items/fee became optional for the status 200

      response-property-became-optional

    • ▲

      added Fee subschema #1 to the price_components/items/fee response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      removed discriminator from price_components/items/fee response property for the response status 200

      response-property-discriminator-removed

    • ○

      removed RatePlanFee SlotPlanFee CapacityPlanFee UsagePlanFee ExtraRecurringPlanFee OneTimePlanFee from the price_components/items/fee response property oneOf list for the response status 200

      response-property-one-of-removed

  • v16b81fb70c39016See the full diff
    • ▲

      added PerUnitPlanPricing TieredPlanPricing VolumePlanPricing PackagePlanPricing MatrixPlanPricing to the price_components/items/fee/oneOf[UsagePlanFee]/pricing response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      mapped value for discriminator key MATRIX changed from MatrixPricing to MatrixPlanPricing for price_components/items/fee/oneOf[UsagePlanFee]/pricing response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key PACKAGE changed from PackagePricing to PackagePlanPricing for price_components/items/fee/oneOf[UsagePlanFee]/pricing response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key PER_UNIT changed from PerUnitPricing to PerUnitPlanPricing for price_components/items/fee/oneOf[UsagePlanFee]/pricing response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key TIERED changed from TieredPricing to TieredPlanPricing for price_components/items/fee/oneOf[UsagePlanFee]/pricing response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key VOLUME changed from VolumePricing to VolumePlanPricing for price_components/items/fee/oneOf[UsagePlanFee]/pricing response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      removed PerUnitPricing TieredPricing VolumePricing PackagePricing MatrixPricing from the price_components/items/fee/oneOf[UsagePlanFee]/pricing response property oneOf list for the response status 200

      response-property-one-of-removed

  • v19fba45d198be2See the full diff
    • ○

      api tag Plans added

      api-tag-added

    • ○

      api tag Plan removed

      api-tag-removed