Package / Service / Price Plan

What can you do with PackageServicePricePlan?


Properties

Property Details
id
"id": 543
Type: Number
This is the unique numeric identifier for the PackageServicePricePlan
packageServiceId
"packageServiceId": 209
Type: Number
Unique identifier for the associated PackageService object.
packageFrequencyId
"packageFrequencyId": 950
Type: Number
Unique identifier for the associated PackageFrequency object.
packageCurrencyId
"packageCurrencyId": 587
Type: Number
Unique identifier for the associated PackageCurrency object.
accountPricePlanId
"accountPricePlanId": 6
Type: Number
Unique identifier for the associated AccountPricePlan object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • packageServiceId
  • packageFrequencyId
  • packageCurrencyId
  • accountPricePlanId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the PackageServicePricePlan object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/Package/Service/PricePlan/{id:int}
Delete an instance of the PackageServicePricePlan object.
GETapi/v1/Package/Service/PricePlan
Retrieve all of the PackageServicePricePlan objects.
GETapi/v1/Package/Service/PricePlan/Metadata
Retrieve all of the meta data details of the PackageServicePricePlan object.
GETapi/v1/Package/Service/PricePlan/Metadata/{option}
Retrieve all the meta data details of the PackageServicePricePlan object based on provided options.
{option}Metadata options for the PackageServicePricePlan object.
GETapi/v1/Package/Service/PricePlan/Paged
Retreive all of the PackageServicePricePlan objects in a paged fashion.
GETapi/v1/Package/Service/PricePlan/Paged/Detail
Retreive all of the PackageServicePricePlan objects in a paged fashion with all object details.
GETapi/v1/Package/Service/PricePlan/{id:int}
Retrieve an instance of the PackageServicePricePlan object by it's ID.
{id:int}Unique identifier for the PackageServicePricePlan object.
GETapi/v1/Package/Service/PricePlan/{id:int}/Detail
Retreive all of the Detail objects for the specified PackageServicePricePlan.
{id:int}Unique identifier for the PackageServicePricePlan object.
PATCHapi/v1/Package/Service/PricePlan/{id:int}
Update the PackageServicePricePlan object and optionally make changes to any child objects.
POSTapi/v1/Package/Service/PricePlan
Create a new instance of the PackageServicePricePlan object.
PUTapi/v1/Package/Service/PricePlan/{id:int}
Update an existing instance of the PackageServicePricePlan object.