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

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 3 of the 108 revisions of this API.1377

Jul 9, 2026646d6658479b2See the full diff
- ▲
  the configuration response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the execution_result response's property type/format changed from / to object/ for status 200
  response-property-type-changed
Jul 9, 20267d57386313c747See the full diff
- ▲
  the configuration response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the execution_result response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the schedule_type response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ▲
  the status response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ●
  added the new cancellation enum value to the schedule_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new cancelled enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new executed enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new executing enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new failed enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new pending enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new plan_change enum value to the schedule_type response property for the response status 200
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 9, 20264b1a811c417977See the full diff
- ▲
  the cancelled_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the created_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the executed_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the schedule_type response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the scheduled_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the status response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the updated_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ○
  removed the cancellation enum value from the schedule_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the cancelled enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the executed enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the executing enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the failed enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the pending enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the plan_change enum value from the schedule_type response property for the response status 200
  response-property-enum-value-removed
This revision also has 121 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history