Home
Version 3
Service Plans API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MX0.bUQNZx487NZaFnlnKcv7AmCrI23MHIQUOtd3s8tzXfY
Host: example.org
Cookie: 

Route

GET /v2/service_plans/08b0906c-0175-4e04-b7ac-43111414553f

cURL

curl "https://api.[your-domain.com]/v2/service_plans/08b0906c-0175-4e04-b7ac-43111414553f" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MX0.bUQNZx487NZaFnlnKcv7AmCrI23MHIQUOtd3s8tzXfY" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 928ba3e2-30d3-4c67-9f45-bf244c4d0eda
Content-Length: 654
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "08b0906c-0175-4e04-b7ac-43111414553f",
    "url": "/v2/service_plans/08b0906c-0175-4e04-b7ac-43111414553f",
    "created_at": "2015-01-27T19:14:31Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-1135",
    "free": false,
    "description": "desc-93",
    "service_guid": "14b9adea-d2f8-47db-bd1d-5846bc0c9217",
    "extra": null,
    "unique_id": "00058247-208d-4f74-9f44-68029df8a57f",
    "public": true,
    "active": true,
    "service_url": "/v2/services/14b9adea-d2f8-47db-bd1d-5846bc0c9217",
    "service_instances_url": "/v2/service_plans/08b0906c-0175-4e04-b7ac-43111414553f/service_instances"
  }
}