• Register

Plan Services

Description

A plan service represents the relationship between a plan and a service definition. It is created when a service definition is included in a plan.

NOTE:This object is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.

Object Fields

id

The id field is the primary identifier for the object.

type maxLength format default optional readonly createonly queryable sortable
integer no yes no yes no

object_type

The type of the object.

type maxLength format default optional readonly createonly queryable sortable
string 32 yes yes no no no

Relationships

Plan

A Plan Service has one and only one related Plan object. The related Plan object can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, plan from plan_services.

Service Definition

A Plan Service has one and only one related Service Definition object. The related Service Definition object can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, service_definition from plan_services.

Object Methods

The plan_service namespace contains the following methods for manipulating services.

plan_service.create
Create a plan service  .
plan_service.delete
Delete a plan service  .
plan_service.fetch
Get a specific plan service or a list of plan services  .
plan_service.validate
Validate a plan service  .

Docs Navigation