Request This endpoint expects an object.
start_at datetime Optional
The start at of the new schedule, and automatically the end at of the original schedule.
end_at datetime or null Optional
The end at of the new schedule. If not sent, the value of the original schedule is taken.
pricing_plan_version_id string or null Optional
The ID of the pricing plan version.
pricing_plan_version_selector object Optional
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 boolean or null Optional
Realign the invoice date to the start of the new schedule. Only allowed for EXACT billing.
status enum or null Optional
The status of the schedule.
Allowed values: DRAFT ACTIVE
Response Created
object_type string or null Optional Read-only
id string or null Optional Read-only
type enum or null Optional
The type of the pricing plan schedule.
Allowed values: TRIAL DEFAULT
status enum or null Optional
The status of the pricing plan schedule. Defaults to ACTIVE.
Allowed values: DRAFT ACTIVE
approval_status enum or null Optional Read-only
Approval status for schedules that are associated with an approval request
Allowed values: PENDING_REVIEW APPROVED DECLINED CANCELLED
pricing_plan_subscription_id string Optional
Resource ID of type PRICING_PLAN_SUBSCRIPTION
pricing_plan_id string or null Optional
The resource ID of the pricing plan.
pricing_plan_version_id string or null Optional
The resource ID of the pricing plan version.
pricing_plan_version_selector object Optional
Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.
end_at datetime or null Optional
pricing_currency enum or null Optional
The default alphabetic currency code representing the type of currency used for the pricing.
billing_period object Optional
entitlements list of objects or null Optional
coupon_discount object or null Optional
coupons list of objects or null Optional
seats_values list of objects or null Optional
units list of objects or null Optional
The number of units billed per One Off pricing item config priced FLAT. Overrides default_units; absent falls back to it, then to 1.
included_volumes list of objects or null Optional
enabled_pricings list of objects or null Optional
override_pricings list of objects or null Optional
pricing_categories list of objects or null Optional
Pricing defined directly on this schedule, in addition to (or instead of) a linked pricing plan version / rate-card.
combined_pricing_plan_version object or null Optional
realign_invoice_date_to_pricing_plan_schedule_start_at boolean or null Optional
created_at string or null Optional Read-only
updated_at string or null Optional Read-only
is_current boolean or null Optional Read-only
Whether this schedule is currently in effect, based on its start_at/end_at and ACTIVE status.
promotion_codes list of strings or null Optional Deprecated
coupon_ids list of strings or null Optional Deprecated
