Get a pricingPlanSchedule by resourceID

Requires the PRICING_PLAN_SCHEDULE.VIEW or QUOTE.PRICING_PLAN_SCHEDULE.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

expand[]list of stringsOptional
The id fields of the resources that are going to be expanded.
include_combined_pricing_plan_versionbooleanOptional
Get the pricing plan version with the pricing overrides.

Response

OK
object_typestring or nullRead-only
idstring or nullRead-only
typeenum or null
The type of the pricing plan schedule.
pricing_plan_subscription_idstring

Resource ID of type PRICING_PLAN_SUBSCRIPTION

pricing_plan_idstring or null
The resource ID of the pricing plan.
pricing_plan_version_idstring or null
The resource ID of the pricing plan version.
pricing_plan_version_selectorobject

Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.

start_atdatetime
end_atdatetime or null
pricing_currencyenum or null
The default alphabetic currency code representing the type of currency used for the pricing.
billing_periodobject
entitlementslist of objects or null
discountobject
markupobject
commitmentobject
coupon_discountobject or null
couponslist of objects or null
seats_valueslist of objects or null
included_volumeslist of objects or null
enabled_pricingslist of objects or null
override_pricingslist of objects or null
pricing_categorieslist of objects or null

Pricing defined directly on this schedule, in addition to (or instead of) a linked pricing plan version / rate-card.

combined_pricing_plan_versionobject or null