Publish plan version draft by external ID
This endpoint publishes the plan’s draft as the next numbered version. A draft that fails plan version validation is a 400 and is left as it was.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
Also make the new version the plan's default.
Response
Created
The PlanVersion resource represents the prices and adjustments present on a specific version of a plan.
Prices for this plan. If the plan has phases, this includes prices across all phases of the plan.
The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill.
Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present.
For more on the types of prices, see the core concepts documentation
- UnitPrice
- TieredPrice
- BulkPrice
- BulkWithFiltersPrice
- PackagePrice
- MatrixPrice
- ThresholdTotalAmountPrice
- TieredPackagePrice
- TieredWithMinimumPrice
- GroupedTieredPrice
- GroupedTieredMatrixPrice
- TieredPackageWithMinimumPrice
- PackageWithAllocationPrice
- UnitWithPercentPrice
- MatrixWithAllocationPrice
- TieredMatrixWithAllocationPrice
- MatrixWithThresholdDiscountsPrice
- TieredWithProrationPrice
- UnitWithProrationPrice
- GroupedAllocationPrice
- BulkWithProrationPrice
- GroupedWithProratedMinimumPrice
- GroupedWithMeteredMinimumPrice
- GroupedWithMinMaxThresholdsPrice
- MatrixWithDisplayNamePrice
- GroupedTieredPackagePrice
- MaxGroupTieredPackagePrice
- ScalableMatrixWithUnitPricingPrice
- ScalableMatrixWithTieredPricingPrice
- CumulativeGroupedBulkPrice
- CumulativeGroupedAllocationPrice
- DailyCreditAllowancePrice
- MeteredAllowancePrice
- MinimumCompositePrice
- PercentCompositePrice
- EventOutputPrice
- UnitWithMultiplierPrice
Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan.
- PlanPhaseUsageDiscountAdjustment
- PlanPhaseAmountDiscountAdjustment
- PlanPhasePercentageDiscountAdjustment
- PlanPhaseTieredPercentageDiscountAdjustment
- PlanPhaseMinimumAdjustment
- PlanPhaseMaximumAdjustment