TAG LINE
SMALL TITLE

Account / Package / Current (View)

(API Version v2)


What can you do with AccountPackage?


Properties

Property Details
id
"id": "Hello World"
Type: String
This is the unique numeric identifier for the AccountPackage
accountId
"accountId": 27
Type: Number
Unique identifier for the associated Account object.
created
"created": "2005-04-11T14:56:24"
Type: Date
nextBill
"nextBill": "2005-04-11T14:56:24"
Type: Date
name
"name": "Hello World"
Type: String
oneTimeAmount
"oneTimeAmount": "Hello World"
Type: String
lastStatusChanged
"lastStatusChanged": "2005-04-11T14:56:24"
Type: Date
effective
"effective": "2005-04-11T14:56:24"
Type: Date
updated
"updated": "2005-04-11T14:56:24"
Type: Date
effectiveCancel
"effectiveCancel": "2005-04-11T14:56:24"
Type: Date
packageFrequencyId
"packageFrequencyId": 4
Type: Number
Unique identifier for the associated PackageFrequency object.
termId
"termId": 13
Type: Number
Unique identifier for the associated Term object.
createdByUserId
"createdByUserId": 24
Type: Number
Unique identifier for the associated User object.
billDay
"billDay": 1
Type: Number
updatedByUserId
"updatedByUserId": 24
Type: Number
Unique identifier for the associated User object.
usageBillDay
"usageBillDay": 0
Type: Number
activation
"activation": "2005-04-11T14:56:24"
Type: Date
finalBill
"finalBill": "2005-04-11T14:56:24"
Type: Date
lastBilled
"lastBilled": "2005-04-11T14:56:24"
Type: Date
accountSharePlanId
"accountSharePlanId": 24
Type: Number
Unique identifier for the associated AccountSharePlan object.
lastUsageBilled
"lastUsageBilled": "2005-04-11T14:56:24"
Type: Date
accountProductCodeId
"accountProductCodeId": 22
Type: Number
Unique identifier for the associated AccountProductCode object.
packageCategoryId
"packageCategoryId": 25
Type: Number
Unique identifier for the associated PackageCategory object.
chargeRecurringIfUsage
"chargeRecurringIfUsage": true
Type: Boolean
id
"id": "Hello World"
Type: String


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:

  • identity
  • accountId
  • name
  • oneTimeAmount
  • lastStatusChanged
  • effective
  • effectiveCancel
  • packageFrequencyId
  • termId
  • billDay
  • usageBillDay
  • finalBill
  • chargeRecurringIfUsage
  • accountSharePlanId
  • accountProductCodeId
  • packageCategoryId

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

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Account/Package/{id:long}
Delete an instance of the AccountPackage object.
GETapi/v2/Account/Package
Retrieve all of the AccountPackage objects.
GETapi/v2/Account/Package/Paged
Retreive all of the AccountPackage objects in a paged fashion.
GETapi/v2/Account/Package/Paged/Detail
Retreive all of the AccountPackage objects in a paged fashion with all object details.
GETapi/v2/Account/Package/{id:long}
Retrieve all of the AccountPackage objects.
GETapi/v2/Account/Package/{id:long}/Detail
Retrieve all of the AccountPackage objects.
PATCHapi/v2/Account/Package/{id:long}
Update the AccountPackage object and optionally make changes to any child objects.
POSTapi/v2/Account/Package
Create a new instance of the AccountPackage object.
POSTapi/v2/Account/Package/FromCatalog
Create a new instance of the AccountPackage object.
PUTapi/v2/Account/Package/{id:long}
Update an existing instance of the AccountPackage object.