Plans

Create a plan

Changed on

Create a new plan with components and pricing. Set status to ACTIVE to publish immediately, or DRAFT to stage for review.

post/api/v1/plans

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

currencystring required
descriptionstring nullable
namestring required
plan_type'STANDARD' | 'FREE' | 'CUSTOM' required
product_family_idstring MeteroidId required
self_service_rankinteger nullable
status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED' required

Example request

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

Response

Plan created

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

  • v14e013b4e4a8fRevision changes
    • breaking

      the ///////// request property format changed from no format to decimal

    • breaking

      the ///////// request property format changed from no format to decimal

    • breaking

      the /////// request property format changed from no format to decimal

    • breaking

      the /////// request property format changed from no format to decimal

    • breaking

      the ///////// request property format changed from no format to decimal

    • breaking

      the ///////// request property format changed from no format to decimal

    • breaking

      the //////////// request property format changed from no format to decimal

    • breaking

      the //////////// request property format changed from no format to decimal

    • breaking

      the response property ////////////////// became nullable for the status

    • breaking

      the response property ////////////////// became nullable for the status

    • breaking

      the response property ////////////////// became nullable for the status

    • breaking

      the response property ////////////////// became nullable for the status

    • breaking

      the response property ////////////////// became optional for the status

    • breaking

      the response property ////////////////// became optional for the status

    • breaking

      the response property ////////////////// became optional for the status

    • breaking

      the response property ////////////////// became optional for the status

    • info

      the request property ////////////// became nullable

    • info

      the request property ////////////// became nullable

    • info

      the request property ////////////// became nullable

    • info

      the request property ////////////// became nullable

    • info

      the request property ////////////// became optional

    • info

      the request property ////////////// became optional

    • info

      the request property ////////////// became optional

    • info

      the request property ////////////// became optional

  • v107a61fe347a5Revision changes
    • breaking

      removed the required property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status