Migrate a pricing plan schedule to a new pricing plan version
Requires the PRICING_PLAN_SCHEDULE.CREATE 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
version
version
resourceId
The ID of the resource to be requested.
Headers
x-platform-id
Platform ID.
Query parameters
expand[]
The id fields of the resources that are going to be expanded.
set_previous_end_at
Setting the value to true will set the end of the previous schedule to the start of this schedule. Mutually exclusive with set_next_start_at
Request
This endpoint expects an object.
start_at
The start at of the new schedule, and automatically the end at of the original schedule.
end_at
The end at of the new schedule. If not sent, the value of the original schedule is taken.
pricing_plan_version_id
The ID of the pricing plan version.
pricing_plan_version_selector
Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.
realign_invoice_date_to_pricing_plan_schedule_start_at
Realign the invoice date to the start of the new schedule. Only allowed for EXACT billing.
Response
Created
object_type
id
type
The type of the pricing plan schedule.
pricing_plan_subscription_id
Resource ID of type PRICING_PLAN_SUBSCRIPTION
pricing_plan_id
The resource ID of the pricing plan.
pricing_plan_version_id
The resource ID of the pricing plan version.
pricing_plan_version_selector
Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.
start_at
end_at
pricing_currency
The default alphabetic currency code representing the type of currency used for the pricing.
billing_period
entitlements
discount
markup
commitment
coupon_discount
coupons
seats_values
included_volumes
enabled_pricings
override_pricings
pricing_categories
Pricing defined directly on this schedule, in addition to (or instead of) a linked pricing plan version / rate-card.
combined_pricing_plan_version
realign_invoice_date_to_pricing_plan_schedule_start_at
created_at
promotion_codesDeprecated
coupon_idsDeprecated
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error