Client Plan

https://api.sigopt.com/v1/clients/CLIENT_ID/plan

Retrieves information about a client Plan.

Request Method: GET

Parameters

This endpoint takes no parameters.

Response

Plan object.

Example Request

plan = conn.clients(CLIENT_ID).plan().fetch()
Response
{
  "current_period": {
    "end": 1565983648,
    "experiments": [
      "1",
      "2"
    ],
    "object": "plan_period",
    "start": 1563391648
  },
  "name": "SigOpt Premium",
  "object": "plan",
  "ongoing_rules": {
    "max_categorical_breadth": 6,
    "max_checkpoints": null,
    "max_clients": null,
    "max_conditionals_breadth": 3,
    "max_constraints": null,
    "max_dimension": 10,
    "max_experiments": 10,
    "max_extra_failures": null,
    "max_metrics": null,
    "max_observations": 150,
    "max_parallelism": 6,
    "max_solutions": null,
    "max_users": null,
    "object": "plan_rules",
    "soft_limits": null,
    "supports_benchmarking": null,
    "supports_multitask": null
  },
  "rules": {
    "max_categorical_breadth": 6,
    "max_checkpoints": null,
    "max_clients": null,
    "max_conditionals_breadth": 3,
    "max_constraints": null,
    "max_dimension": 10,
    "max_experiments": 10,
    "max_extra_failures": null,
    "max_metrics": null,
    "max_observations": 150,
    "max_parallelism": 6,
    "max_solutions": null,
    "max_users": null,
    "object": "plan_rules",
    "soft_limits": null,
    "supports_benchmarking": null,
    "supports_multitask": null
  },
  "trial_rules": {
    "max_categorical_breadth": null,
    "max_checkpoints": null,
    "max_clients": null,
    "max_conditionals_breadth": null,
    "max_constraints": null,
    "max_dimension": null,
    "max_experiments": null,
    "max_extra_failures": null,
    "max_metrics": null,
    "max_observations": null,
    "max_parallelism": null,
    "max_solutions": null,
    "max_users": null,
    "object": "plan_rules",
    "soft_limits": null,
    "supports_benchmarking": null,
    "supports_multitask": null
  }
}