Account / Price Plan

What can you do with AccountPricePlan?


Properties

Property Details
id
"id": 663
Type: Number
This is the unique numeric identifier for the AccountPricePlan
name
"name": "Hello World"
Type: String
accountId
"accountId": 971
Type: Number
Unique identifier for the associated Account object.
description
"description": "Hello World"
Type: String
start
"start": "2005-04-11T14:56:24"
Type: Date
end
"end": "2005-04-11T14:56:24"
Type: Date


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:

  • name
  • accountId
  • description
  • start
  • end

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 AccountPricePlan object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

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