# Retrieve schedule plans for a charging sub-session

Retrieve schedule plans for a specific charging sub-session.

Schedule plans represent the charging plan parameters used to generate schedules for a charging session. Each plan contains information about the ready-by time, charging requirements, and constraints that were used to create the charging schedule.

Endpoint: GET /charging_sub_sessions/{charging_sub_session_id}/schedule_plans
Version: 2.0
Security: oauth2

## Path parameters:

  - `charging_sub_session_id` (string, required)
    Uniquely identify a specific charging sub-session.
    Example: "csub01HSH04KDEWF6Z4DB2J77J74K5"

## Header parameters:

  - `EvEnergy-Version` (number)
    Specify the version of this endpoint to use.
    Enum: 2

## Query parameters:

  - `expand` (array)
    Specify a url field to expand into a nested resource.
    Enum: "charging_sub_session"

  - `created_at__gte` (string)
    Filter schedule plans with created_at greater than or equal to this datetime.

  - `created_at__lte` (string)
    Filter schedule plans with created_at less than or equal to this datetime.

## Response 200 fields (application/json):

  - `url` (string)
    Example: "https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5/schedule_plans"

  - `charging_sub_session` (any)
    The charging sub-session these schedule plans belong to. Defaults to a url, but can be expanded to the full ChargingSubSession resource via the expand query parameter.

  - `schedule_plans` (array)
    A list of schedule plans for this charging sub-session.

  - `schedule_plans.id` (string)
    Unique identifier for this schedule plan.
    Example: "scpl01HSH04KDEWF6Z4DB2J77J74K5"

  - `schedule_plans.created_at` (string)
    When this schedule plan was created.
    Example: "2024-01-01T02:00:00Z"

  - `schedule_plans.ready_by_time` (string)
    The target time by which charging should be complete.
    Example: "2024-01-01T08:00:00Z"

  - `schedule_plans.price_threshold_minor_unit` (integer,null)
    Price threshold in minor currency units (e.g., cents/pence) multiplied by 100. For example, 1500 represents 15 pence (£0.15), and 50 represents 0.5 pence (£0.005). Null if no threshold set.
    Example: 1500

  - `schedule_plans.power_on_current_milliamps` (integer)
    The charging current in milliamps when power is on.
    Example: 32000

  - `schedule_plans.power_off_current_milliamps` (integer)
    The current in milliamps when power is off (typically 0).

  - `schedule_plans.seconds_to_charge` (integer)
    The number of seconds required to complete charging.
    Example: 10800

  - `schedule_plans.vehicle_charge_level_watt_hours` (integer,null)
    The vehicle's battery level in watt-hours at the time the plan was created. Null if unknown.
    Example: 25000

  - `schedule_plans.estimated_charge_rate_watts` (integer)
    The estimated charging rate in watts.
    Example: 7400

  - `schedule_plans.estimated_charge_rate_source` (string,null)
    The source of data used for estimating charge rate. Null if not specified.
    Enum: "CURRENT_SESSION_EVSE_DATA_LOGS", "CURRENT_SESSION_VEHICLE_DATA_LOGS", "ENERGY_TRANSFER_PERIODS", "DEFAULT_CHARGE_RATE", "MAX_EVSE_CHARGE_RATE", "MAX_VEHICLE_CHARGE_RATE", null

  - `schedule_plans.watt_hours_to_charge` (integer)
    The total energy required to complete charging in watt-hours.
    Example: 22000

  - `schedule_plans.min_charge_limit_percent` (integer)
    The minimum charge limit as a percentage (0-100).

  - `schedule_plans.max_charge_limit_percent` (integer)
    The maximum charge limit as a percentage (0-100).
    Example: 80

## Response 400 fields (application/problem+json):

  - `type` (string)
    Example: "https://api.ev.energy/v2/problems/example-problem/"

  - `status` (number)
    Example: 400

  - `title` (string, required)
    Example: "Short description"

  - `detail` (string, required)
    Example: "Long, more specific description."

  - `instance` (string)
    Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"

  - `notification` (object)
    Something that the user should be informed about.

  - `notification.id` (string, required)
    Unique identifier for the Notification
    Example: "notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.url` (string, required)
    Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.message_id` (string, required)
    Internal identifier for this notification type. E.g. 'ERR0023'

  - `notification.category` (any, required)
    Category of this notification type
    Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL"

  - `notification.event_time` (string, required)
    The timestamp of the event described by this notification

  - `notification.short_text_title` (string, required)
    Short title for the notification

  - `notification.short_text_body` (string, required)
    Short description of the event being notified

  - `notification.detail_page_title` (string)
    Title of a help page giving more information about this notification

  - `notification.detail_page_body` (string)
    Text of a help page giving more information about this notification

  - `notification.external_link` (string,null)
    URL of a web page giving further information about this notification

  - `notification.external_button_label` (string)
    Text to be displayed on a button leading to the external_link location

  - `notification.read_at` (string)
    When the user examined the contents of this notification

  - `notification.resolved_at` (string)
    When the problem associated with this notification was resolved

## Response 401 fields (application/problem+json):

  - `status` (number)
    Example: 401

  - `title` (string, required)
    Example: "Unauthorized"

  - `detail` (string, required)
    Example: "Authentication credentials were not provided."

## Response 403 fields (application/problem+json):

  - `status` (number)
    Example: 403

  - `title` (string, required)
    Example: "Forbidden"

  - `detail` (string, required)
    Example: "You do not have permission to perform this action."

## Response 404 fields (application/problem+json):

  - `status` (number)
    Example: 404

  - `title` (string, required)
    Example: "Not found"

  - `detail` (string, required)
    Example: "Resource does not exist or cannot be accessed."

## Response 406 fields (application/problem+json):

  - `status` (number)
    Example: 406

  - `title` (string, required)
    Example: "Not Acceptable"

  - `detail` (string, required)
    Example: "Could not satisfy the request Accept header."

## Response 429 fields (application/problem+json):

  - `type` (string)
    Example: "https://api.ev.energy/v2/problems/example-problem/"

  - `status` (number)
    Example: 400

  - `title` (string, required)
    Example: "Short description"

  - `detail` (string, required)
    Example: "Long, more specific description."

  - `instance` (string)
    Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"

  - `notification` (object)
    Something that the user should be informed about.

  - `notification.id` (string, required)
    Unique identifier for the Notification
    Example: "notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.url` (string, required)
    Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.message_id` (string, required)
    Internal identifier for this notification type. E.g. 'ERR0023'

  - `notification.category` (any, required)
    Category of this notification type
    Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL"

  - `notification.event_time` (string, required)
    The timestamp of the event described by this notification

  - `notification.short_text_title` (string, required)
    Short title for the notification

  - `notification.short_text_body` (string, required)
    Short description of the event being notified

  - `notification.detail_page_title` (string)
    Title of a help page giving more information about this notification

  - `notification.detail_page_body` (string)
    Text of a help page giving more information about this notification

  - `notification.external_link` (string,null)
    URL of a web page giving further information about this notification

  - `notification.external_button_label` (string)
    Text to be displayed on a button leading to the external_link location

  - `notification.read_at` (string)
    When the user examined the contents of this notification

  - `notification.resolved_at` (string)
    When the problem associated with this notification was resolved