Skip to main content
GET
/
v1
/
subscription-schedules
/
{id}
Get subscription schedule
curl --request GET \
  --url https://us.api.flexprice.io/v1/v1/subscription-schedules/{id}
{
  "can_be_cancelled": true,
  "cancelled_at": "<string>",
  "configuration": {},
  "created_at": "<string>",
  "days_until_execution": 123,
  "error_message": "<string>",
  "executed_at": "<string>",
  "execution_result": {},
  "id": "<string>",
  "metadata": {},
  "schedule_type": "plan_change",
  "scheduled_at": "<string>",
  "status": "pending",
  "subscription_id": "<string>",
  "updated_at": "<string>"
}

Path Parameters

​
id
string
required

Schedule ID

Response

200 - application/json

OK

Full details of a subscription schedule

​
can_be_cancelled
boolean

can_be_cancelled indicates if the schedule can be cancelled

​
cancelled_at
string

cancelled_at is when the schedule was cancelled

​
configuration
object

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

​
created_at
string

created_at timestamp

​
days_until_execution
integer

days_until_execution is the number of days until execution

​
error_message
string

error_message contains the error if execution failed

​
executed_at
string

executed_at is when the schedule was executed

​
execution_result
object

execution_result contains type-specific execution result

​
id
string

id of the schedule

​
metadata
object

metadata from the schedule

​
schedule_type
enum<string>
Available options:
plan_change,
cancellation
​
scheduled_at
string

scheduled_at is when the schedule will execute

​
status
enum<string>
Available options:
pending,
executing,
executed,
cancelled,
failed
​
subscription_id
string

subscription_id is the ID of the subscription

​
updated_at
string

updated_at timestamp