Configuration APIPricing Plan Schedules

Delete a pricingPlanSchedule by resource ID

Requires the PRICING_PLAN_SCHEDULE.DELETE 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.

Response

OK
pricing_plan_subscription_idstring

Resource ID of type PRICING_PLAN_SUBSCRIPTION

start_atdatetime
object_typestring or nullRead-only
idstring or nullRead-only
typeenum or null
The type of the pricing plan schedule.
Allowed values:
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.

end_atdatetime or null
pricing_currencyenum or null
The default alphabetic currency code representing the type of currency used for the pricing.
billing_periodobject
The renewal term after the initial term.
entitlementslist of objects or null
discountobject or null
markupobject
commitmentobject
promotion_codeslist of strings or null
coupon_idslist of strings or null
coupon_discountobject 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
combined_pricing_plan_versionobject or null
realign_invoice_date_to_pricing_plan_schedule_start_atboolean or null
created_atstring or nullRead-only

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error