TAG LINE
TAG LINE
SMALL TITLE
This object represents the top level container which holds account price plan details. This container will hold all the Packages with custom pricing for a specified Account.
identity READ-ONLY | "identity": 26 Type: Number This is the unique numeric identifier for the AccountPricePlan |
name | "name": "Hello World" Type: String This is the name given to the Price Plan. |
accountId | "accountId": 1 Type: Number Unique identifier for the associated Account object. |
accountName | "accountName": "Sample Name" Type: String The name of the object associated with the accountId property. |
description | "description": "Hello World" Type: String Text description of the Price Plan. |
start | "start": "2021-04-26T15:25:27.587Z" Type: Date |
end | "end": "2021-04-26T15:25:27.587Z" Type: Date |
isConsolidatedByInvoicer | "isConsolidatedByInvoicer": true Type: Boolean Whether or not sub accounts inherit this price plan. |
lastUsedForBilling READ-ONLY | "lastUsedForBilling": "2021-04-26T15:25:27.587Z" Type: Date When this price plan was last used for calculating pricing for an invoice. Date and time values are specified in the ISO 8601 format. |
includeChildAccounts | "includeChildAccounts": true Type: Boolean Determines whether child accounts should be included or not. |
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. 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:
| DELETE | Account/PricePlan/{id} |
| Delete an instance of the AccountPricePlan object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the AccountPricePlan object. |
Delete an instance of the AccountPricePlan object. DELETE Account/PricePlan/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountPricePlan"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Account/PricePlan/ |
| Retrieve all of the AccountPricePlan objects. | |
Retrieve all of the AccountPricePlan objects. GET Account/PricePlan/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 18,
"accountName": "Sample Text Data",
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"lastUsedForBilling": "2021-04-26T15:25:27.587Z",
"includeChildAccounts": true
}
]
} | |
| GET | Account/PricePlan/ActiveFor/Account/{id} |
| Retrieve the AccountPricePlan that is active right now for an Account. | |
| {id} | Unique identifier for the Account object. |
Retrieve the AccountPricePlan that is active right now for an Account. GET Account/PricePlan/ActiveFor/Account/{id}HTTP/1.1 200 OK
{
"trackingId": "b9e5eb9f-e754-4f29-88aa-993687632ee1",
"instance": {
"identity": 2,
"name": "Fall 2018",
"accountId": 10000000,
"accountName": "Anthem Records",
"description": "Autumn Special",
"start": "2018-10-01T00:00:00",
"isConsolidatedByInvoicer": true
}
} | |
| GET | Account/PricePlan/ActiveFor/Account/{id}/Detail |
| Retrieve the deep detail of the AccountPricePlan that is active right now for an Account including sub accounts. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the Account object. |
Retrieve the deep detail of the AccountPricePlan that is active right now for an Account including sub accounts. GET Account/PricePlan/ActiveFor/Account/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "106ab566-c0fd-46ed-8932-4365208cd0e3",
"instance": {
"identity": 2,
"name": "Fall 2018",
"accountId": 10000000,
"accountName": "Anthem Records",
"description": "Autumn Special",
"start": "2018-10-01T00:00:00",
"isConsolidatedByInvoicer": true,
"details": {
"pricePlans": {
"totalCount": 2,
"items": [
{
"identity": 1500,
"packageServiceId": 3,
"packageFrequencyId": 44,
"packageFrequencyName": "DialUp Package - 1 Month",
"packageCurrencyId": 2,
"accountPricePlanId": 2,
"accountPricePlanName": "Fall 2018",
"isCountOnFirstUsage": false,
"packageId": 2,
"packageName": "DialUp Package",
"serviceId": 2,
"serviceName": "Dialup Service",
"packageFrequencyPackageCurrencyIsActive": true,
"currencyId": 1,
"currencyName": "United States Dollar",
"currencyCode": "USD",
"statusTierTypeId": 2,
"statusTierTypeName": "Tier By Status",
"details": {
"recurringPrices": {
"totalCount": 1,
"items": [
{
"identity": 203,
"packageServicePricePlanId": 1500,
"serviceStatusTypeId": 12,
"serviceStatusTypeName": "Active",
"pricePlanTierTypeId": 1,
"pricePlanTierTypeName": "Tiered - Bracket Pricing",
"details": {
"totalCount": 2,
"items": [
{
"identity": 121,
"amount": 2.9,
"packageServiceRecurringPriceId": 203
},
{
"identity": 120,
"amount": 3.1,
"threshold": 10,
"packageServiceRecurringPriceId": 203
}
]
}
}
]
}
}
},
{
"identity": 1501,
"packageServiceId": 5,
"packageFrequencyId": 44,
"packageFrequencyName": "DialUp Package - 1 Month",
"packageCurrencyId": 2,
"accountPricePlanId": 2,
"accountPricePlanName": "Fall 2018",
"isCountOnFirstUsage": false,
"packageId": 2,
"packageName": "DialUp Package",
"serviceId": 6,
"serviceName": "Email Service",
"packageFrequencyPackageCurrencyIsActive": true,
"currencyId": 1,
"currencyName": "United States Dollar",
"currencyCode": "USD",
"statusTierTypeId": 2,
"statusTierTypeName": "Tier By Status",
"details": {
"recurringPrices": {
"totalCount": 1,
"items": [
{
"identity": 205,
"packageServicePricePlanId": 1501,
"serviceStatusTypeId": 12,
"serviceStatusTypeName": "Active",
"pricePlanTierTypeId": 3,
"pricePlanTierTypeName": "Tiered - Progressive Pricing",
"details": {
"totalCount": 3,
"items": [
{
"identity": 132,
"amount": 1.95,
"packageServiceRecurringPriceId": 205
},
{
"identity": 130,
"amount": 2.25,
"threshold": 6,
"packageServiceRecurringPriceId": 205
},
{
"identity": 131,
"amount": 2.1,
"threshold": 12,
"packageServiceRecurringPriceId": 205
}
]
}
}
]
}
}
}
]
}
}
}
} | |
| GET | Account/PricePlan/Paged |
| Retrieve all of the AccountPricePlan objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the AccountPricePlan objects in a paged fashion. GET Account/PricePlan/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 22,
"accountName": "Sample Text Data",
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"lastUsedForBilling": "2021-04-26T15:25:27.587Z",
"includeChildAccounts": true
}
]
}
} | |
| GET | Account/PricePlan/Paged/Detail |
| Retrieve all of the AccountPricePlan objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the AccountPricePlan objects in a paged fashion with all object details. GET Account/PricePlan/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 13,
"accountName": "Sample Text Data",
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"lastUsedForBilling": "2021-04-26T15:25:27.587Z",
"includeChildAccounts": true,
"details": {
"pricePlans": [
{
"identity": 43,
"packageServiceId": 57,
"packageFrequencyId": 46,
"packageFrequencyName": "Sample Text Data",
"packageCurrencyId": 13,
"accountPricePlanId": 40,
"accountPricePlanName": "Sample Text Data",
"accountProductCodeId": 30,
"accountProductCodeName": "Sample Text Data",
"priceBookId": 34,
"priceBookName": "Sample Text Data",
"packageId": 92,
"packageName": "Sample Text Data",
"serviceId": 88,
"serviceName": "Sample Text Data",
"packageFrequencyPackageCurrencyIsActive": true,
"currencyId": 3,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data",
"countingRuleId": 97,
"countingRuleName": "Sample Text Data",
"details": {
"recurringPrices": [
{
"identity": 34,
"packageServicePricePlanId": 82,
"serviceStatusTypeId": 29,
"serviceStatusTypeName": "Sample Text Data",
"amount": 38.09,
"pricePlanTierTypeId": 23,
"pricePlanTierTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"identity": 51,
"amount": 94.63,
"threshold": 78,
"packageServiceRecurringPriceId": 85,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
}
],
"transitionPrices": [
{
"identity": 11,
"amount": 20.55,
"packageServicePricePlanId": 79,
"serviceTransitionId": 50,
"serviceTransitionName": "Sample Text Data",
"chargeServiceId": 31,
"chargeServiceName": "Sample Text Data",
"transitionDuration": 77,
"frequencyTypeId": 86,
"frequencyTypeName": "Sample Text Data",
"transitionDurationPenaltyAmount": 94.98,
"transitionLimit": 98,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
],
"currentRatePlan": {
"identity": 59,
"name": "Sample Text Data",
"displayName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z"
},
"usageRateOverrides": [
{
"identity": 5,
"amount": 57.09,
"usageRateId": 3,
"usageRatePlanPackageServicePricePlanConnectorHistoryId": 94,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"usageRateTierOverrides": [
{
"identity": 86,
"packageServicePricePlanUsageRateOverrideId": 9,
"threshold": 70,
"amount": 77.18,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
}
],
"nonRecurringPrices": [
{
"identity": 3,
"packageServicePricePlanId": 49,
"pricePlanTierTypeId": 14,
"pricePlanTierTypeName": "Sample Text Data",
"amount": 77.54,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"tiers": [
{
"identity": 75,
"packageServiceNonRecurringPriceId": 22,
"amount": 41.2,
"threshold": 49,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
}
],
"packageServiceDiscounts": [
{
"identity": 27,
"packageServicePricePlanId": 80,
"discountName": "Sample Text Data",
"discountStart": "2021-04-26T15:25:27.587Z",
"discountEnd": "2021-04-26T15:25:27.587Z",
"isProrated": true,
"generalLedgerId": 81,
"generalLedgerName": "Sample Text Data",
"appliedOrder": 43,
"isActive": true,
"isFreeTrial": true,
"isNegativeAllowed": true,
"details": {
"packageServiceStatusDiscounts": [
{
"identity": 60,
"packageServiceDiscountId": 26,
"serviceStatusTypeId": 11,
"serviceStatusTypeName": "Sample Text Data",
"discountPromoCodeCurrencyId": 13,
"discountId": 37,
"details": {
"discountAmounts": [
{
"identity": 74,
"discountId": 89,
"discountTypeId": 28,
"discountTypeName": "Sample Text Data",
"frequency": 4,
"frequencyTypeId": 22,
"frequencyTypeName": "Sample Text Data",
"amount": 49.77,
"appliedOrder": 19
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
} | |
| GET | Account/PricePlan/{id} |
| Retrieve an instance of the AccountPricePlan object by its ID. | |
| {id} | Unique identifier for the AccountPricePlan object. |
Retrieve an instance of the AccountPricePlan object by its ID. GET Account/PricePlan/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"accountId": 15,
"accountName": "Sample Text Data",
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"lastUsedForBilling": "2021-04-26T15:25:27.587Z",
"includeChildAccounts": true
}
} | |
| GET | Account/PricePlan/{id}/Detail |
| Retrieve deep detail of the AccountPricePlan object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the AccountPricePlan object. |
Retrieve deep detail of the AccountPricePlan object by its ID. GET Account/PricePlan/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"accountId": 0,
"accountName": "Sample Text Data",
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"lastUsedForBilling": "2021-04-26T15:25:27.587Z",
"includeChildAccounts": true,
"details": {
"pricePlans": [
{
"identity": 43,
"packageServiceId": 57,
"packageFrequencyId": 46,
"packageFrequencyName": "Sample Text Data",
"packageCurrencyId": 13,
"accountPricePlanId": 40,
"accountPricePlanName": "Sample Text Data",
"accountProductCodeId": 30,
"accountProductCodeName": "Sample Text Data",
"priceBookId": 34,
"priceBookName": "Sample Text Data",
"packageId": 92,
"packageName": "Sample Text Data",
"serviceId": 88,
"serviceName": "Sample Text Data",
"packageFrequencyPackageCurrencyIsActive": true,
"currencyId": 3,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data",
"countingRuleId": 97,
"countingRuleName": "Sample Text Data",
"details": {
"recurringPrices": [
{
"identity": 34,
"packageServicePricePlanId": 82,
"serviceStatusTypeId": 29,
"serviceStatusTypeName": "Sample Text Data",
"amount": 38.09,
"pricePlanTierTypeId": 23,
"pricePlanTierTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"identity": 51,
"amount": 94.63,
"threshold": 78,
"packageServiceRecurringPriceId": 85,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
}
],
"transitionPrices": [
{
"identity": 11,
"amount": 20.55,
"packageServicePricePlanId": 79,
"serviceTransitionId": 50,
"serviceTransitionName": "Sample Text Data",
"chargeServiceId": 31,
"chargeServiceName": "Sample Text Data",
"transitionDuration": 77,
"frequencyTypeId": 86,
"frequencyTypeName": "Sample Text Data",
"transitionDurationPenaltyAmount": 94.98,
"transitionLimit": 98,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
],
"currentRatePlan": {
"identity": 59,
"name": "Sample Text Data",
"displayName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z"
},
"usageRateOverrides": [
{
"identity": 5,
"amount": 57.09,
"usageRateId": 3,
"usageRatePlanPackageServicePricePlanConnectorHistoryId": 94,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"usageRateTierOverrides": [
{
"identity": 86,
"packageServicePricePlanUsageRateOverrideId": 9,
"threshold": 70,
"amount": 77.18,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
}
],
"nonRecurringPrices": [
{
"identity": 3,
"packageServicePricePlanId": 49,
"pricePlanTierTypeId": 14,
"pricePlanTierTypeName": "Sample Text Data",
"amount": 77.54,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"tiers": [
{
"identity": 75,
"packageServiceNonRecurringPriceId": 22,
"amount": 41.2,
"threshold": 49,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
}
],
"packageServiceDiscounts": [
{
"identity": 27,
"packageServicePricePlanId": 80,
"discountName": "Sample Text Data",
"discountStart": "2021-04-26T15:25:27.587Z",
"discountEnd": "2021-04-26T15:25:27.587Z",
"isProrated": true,
"generalLedgerId": 81,
"generalLedgerName": "Sample Text Data",
"appliedOrder": 43,
"isActive": true,
"isFreeTrial": true,
"isNegativeAllowed": true,
"details": {
"packageServiceStatusDiscounts": [
{
"identity": 60,
"packageServiceDiscountId": 26,
"serviceStatusTypeId": 11,
"serviceStatusTypeName": "Sample Text Data",
"discountPromoCodeCurrencyId": 13,
"discountId": 37,
"details": {
"discountAmounts": [
{
"identity": 74,
"discountId": 89,
"discountTypeId": 28,
"discountTypeName": "Sample Text Data",
"frequency": 4,
"frequencyTypeId": 22,
"frequencyTypeName": "Sample Text Data",
"amount": 49.77,
"appliedOrder": 19
}
]
}
}
]
}
}
]
}
}
]
}
}
} | |
| PATCH | Account/PricePlan/{id} |
| Update or Add the AccountPricePlan object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the AccountPricePlan object. |
Update or Add the AccountPricePlan object and optionally make changes to any child objects. PATCH Account/PricePlan/{id}
{
"details": {},
"accountPricePlans": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "Sample Text Data",
"accountId": 2,
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"includeChildAccounts": true
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "accountPricePlan",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"accountId": 26,
"accountName": "Sample Text Data",
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"lastUsedForBilling": "2021-04-26T15:25:27.587Z",
"includeChildAccounts": true
}
}
]
}
} | |
| POST | Account/PricePlan/ |
| Create a new instance of the AccountPricePlan object. | |
Create a new instance of the AccountPricePlan object. POST Account/PricePlan/
{
"name": "Sample Text Data",
"accountId": 13,
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"includeChildAccounts": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 10,
"accountName": "Sample Text Data",
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"lastUsedForBilling": "2021-04-26T15:25:27.587Z",
"includeChildAccounts": true
}
]
}
} | |
| POST | Account/PricePlan/{id}/Patch |
| This method is only created as work around in order to provide PATCH capability for Salesforce that can only submit POST calls. Typically an internal API with limited use. | |
| {id} | Unique identifier for the AccountPricePlan object. |
| PUT | Account/PricePlan/{id} |
| Update an existing instance of the AccountPricePlan object. | |
Update an existing instance of the AccountPricePlan object. PUT Account/PricePlan/{id}
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 19,
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"includeChildAccounts": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"accountId": 26,
"accountName": "Sample Text Data",
"description": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"isConsolidatedByInvoicer": true,
"lastUsedForBilling": "2021-04-26T15:25:27.587Z",
"includeChildAccounts": true
}
]
}
} | |