Fetch plan version draft by external ID
This endpoint returns the plan’s unpublished draft version, with its changes applied on top of the latest published version. It returns a 404 if the plan has no draft.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Response
OK
The PlanVersionDraft resource represents a plan's unpublished next version: the prices and adjustments it will
have once published, built on top of base_version.
Optional description of what changes in this draft
The published version the draft is built on, the latest at read time.
Prices on the draft. 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 on the draft. If the plan has phases, this includes adjustments across all phases of the plan.
- PlanPhaseUsageDiscountAdjustment
- PlanPhaseAmountDiscountAdjustment
- PlanPhasePercentageDiscountAdjustment
- PlanPhaseTieredPercentageDiscountAdjustment
- PlanPhaseMinimumAdjustment
- PlanPhaseMaximumAdjustment