Copy a pricing plan schedule
Requires the QUOTE.PRICING_PLAN_SCHEDULE.CREATE or PRICING_PLAN_SCHEDULE.CREATE permission. Which one depends on the type of the subscription: QUOTE requires QUOTE.PRICING_PLAN_SCHEDULE.CREATE; BILLING and TEMPLATE require PRICING_PLAN_SCHEDULE.CREATE. A schedule of a BILLING or TEMPLATE subscription that is not DRAFT also requires PRICING_PLAN_SCHEDULE.WRITE_ACTIVE. Setting these fields also requires their own permission: discount requires PRICING_PLAN_SCHEDULE.DISCOUNT.EDIT; commitment requires PRICING_PLAN_SCHEDULE.COMMITMENT.EDIT; markup requires PRICING_PLAN_SCHEDULE.MARKUP.EDIT; override_pricings requires PRICING_PLAN_SCHEDULE.PRICING_OVERRIDE.EDIT.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Query parameters
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
Setting the value to true will set the start of the next schedule to the end of this schedule. Mutually exclusive with set_previous_end_at
Request
Global indexing settings applied to all indexed prices. Can be overridden per pricing, pricing item, or pricing item config via their own indexing_settings. When pricings, pricing_items and pricing_item_configs are omitted, everything is indexed using these settings.
Pricings to index, each with optional indexing settings that override the top-level indexing_settings.
Pricing items to index, each with optional indexing settings that override the top-level indexing_settings.
Pricing item configs to index, each with optional indexing settings that override the top-level indexing_settings.
What happens to the discounts of coupons that are still running on the original schedule. NONE (default) ends them with the original schedule. CARRY_OVER continues them on the new schedule for the remainder of their duration, without redeeming the coupons again.
Response
Resource ID of type PRICING_PLAN_SUBSCRIPTION
Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.
The number of units billed per One Off pricing item config priced FLAT. Overrides default_units; absent falls back to it, then to 1.
Pricing defined directly on this schedule, in addition to (or instead of) a linked pricing plan version / rate-card.
Whether this schedule is currently in effect, based on its start_at/end_at and ACTIVE status.