Sign in
Subscriptions

Get subscription schedule

Use when you need to load a single scheduled change (e.g. to show when a plan change or renewal takes effect).

get/v1/subscription-schedules/{id}

Path parameters

idstring required

Schedule ID

Response

OK

can_be_cancelledboolean

can_be_cancelled indicates if the schedule can be cancelled

cancelled_atstring date-time

cancelled_at is when the schedule was cancelled

configurationobject

configuration contains type-specific configuration (e.g., target_plan_id for plan changes)

created_atstring date-time

created_at timestamp

days_until_executioninteger

days_until_execution is the number of days until execution

error_messagestring

error_message contains the error if execution failed

executed_atstring date-time

executed_at is when the schedule was executed

execution_resultobject

execution_result contains type-specific execution result

idstring

id of the schedule

metadataobject

metadata from the schedule

schedule_type'plan_change' | 'cancellation'
scheduled_atstring date-time

scheduled_at is when the schedule will execute

status'pending' | 'executing' | 'executed' | 'cancelled' | 'failed'
subscription_idstring

subscription_id is the ID of the subscription

updated_atstring date-time

updated_at timestamp

Changes

Changed in 1 of the 12 revisions of this API.1