For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Requires the PRICING_PLAN_SUBSCRIPTION.UPDATE or 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
versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource for which the action is posted.
Headers
x-platform-idstringOptional
Platform ID.
Request
This endpoint expects an object.
pricing_plan_idstringRequired
The pricing plan to move the subscription to. Must be a different pricing plan than the subscription's current one, and a sibling of it within the same pricing plan group.
start_atdatetime or nullOptional
Only allowed when the pricing plan group’s upgrade/downgrade timing policy for this transition is IMMEDIATE or IMMEDIATE_PRO_RATA; defaults to now. Not allowed when the policy is NEXT_BILLING_PERIOD.
billing_periodobjectOptional
Optionally change the billing period of the new schedule. Must be one of the target pricing plan version’s billing period settings values; if not set, the current billing period is kept.
Response
Created
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
typeenum or nullOptional
The type of the pricing plan schedule.
Allowed values:
statusenum or nullOptional
The status of the pricing plan schedule. Defaults to ACTIVE.
Allowed values:
approval_statusenum or nullOptionalRead-only
Approval status for schedules that are associated with an approval request
Allowed values:
pricing_plan_subscription_idstringOptional
Resource ID of type PRICING_PLAN_SUBSCRIPTION
pricing_plan_idstring or nullOptional
The resource ID of the pricing plan.
pricing_plan_version_idstring or nullOptional
The resource ID of the pricing plan version.
pricing_plan_version_selectorobjectOptional
Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.
start_atdatetimeOptional
end_atdatetime or nullOptional
pricing_currencyenum or nullOptional
The default alphabetic currency code representing the type of currency used for the pricing.
billing_periodobjectOptional
entitlementslist of objects or nullOptional
discountobjectOptional
markupobjectOptional
commitmentobjectOptional
coupon_discountobject or nullOptional
couponslist of objects or nullOptional
seats_valueslist of objects or nullOptional
unitslist of objects or nullOptional
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_volumeslist of objects or nullOptional
enabled_pricingslist of objects or nullOptional
override_pricingslist of objects or nullOptional
pricing_categorieslist of objects or nullOptional
Pricing defined directly on this schedule, in addition to (or instead of) a linked pricing plan version / rate-card.
combined_pricing_plan_versionobject or nullOptional
realign_invoice_date_to_pricing_plan_schedule_start_atboolean or nullOptional
created_atstring or nullOptionalRead-only
updated_atstring or nullOptionalRead-only
is_currentboolean or nullOptionalRead-only
Whether this schedule is currently in effect, based on its start_at/end_at and ACTIVE status.
promotion_codeslist of strings or nullOptionalDeprecated
coupon_idslist of strings or nullOptionalDeprecated
