Service Plans API

Retrieve a Particular Service Plan

GET /v2/service_plans/:guid

Fields

Name	Description	Default	Valid Values	Example Values
guid	The guid of the service plan
name	The name of the service plan			100mb
free	A boolean describing if the service plan is free		true false
description	A description of the service plan			Let's you put data in your database!
extra	A JSON string with additional data about the plan			{"cost": "$2.00"}
unique_id	A guid for the service plan in the service broker (not the same as the cloud controller guid)
public	A boolean describing that the plan is visible to the all users	true
service_guid	The guid of the related service			deadbeef
active	A boolean that determines whether plans can be used to create new instances.		true false

Parameters

Name	Description	Valid Values	Example Values
guid	The guid of the Service Plan

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxIiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzYyfQ.SSMlvNVGQn-1UqN_yj5q7M2Rm-LEzRMQxvSepqavZo8
Host: example.org
Cookie: 

Route

GET /v2/service_plans/e5389673-a205-4432-8445-20a2d441953c

cURL

curl "https://api.[your-domain.com]/v2/service_plans/e5389673-a205-4432-8445-20a2d441953c" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxIiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzYyfQ.SSMlvNVGQn-1UqN_yj5q7M2Rm-LEzRMQxvSepqavZo8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 543c7cc1-5477-436f-a842-5ac12f251191
Content-Length: 652
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "e5389673-a205-4432-8445-20a2d441953c",
    "url": "/v2/service_plans/e5389673-a205-4432-8445-20a2d441953c",
    "created_at": "2015-02-10T01:42:42Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-47",
    "free": false,
    "description": "desc-10",
    "service_guid": "787e7d2b-7d78-428f-80ab-9f9f8727afb3",
    "extra": null,
    "unique_id": "a6fcc842-8020-4eb0-b2ff-d0abbdbf2c34",
    "public": true,
    "active": true,
    "service_url": "/v2/services/787e7d2b-7d78-428f-80ab-9f9f8727afb3",
    "service_instances_url": "/v2/service_plans/e5389673-a205-4432-8445-20a2d441953c/service_instances"
  }
}