TAG LINE
TAG LINE
SMALL TITLE

Package / Service / Price Plan

(API Version v9)


Represents the linking of pricing for a Service assigned to a Package.


What can you do with PackageServicePricePlan?


Properties

Property Details
identity
READ-ONLY
"identity": 2
Type: Number
This is the unique numeric identifier for the PackageServicePricePlan
packageServiceId
"packageServiceId": 8
Type: Number
Unique identifier for the associated PackageService object.
packageServiceName
"packageServiceName": "Sample Name"
Type: String
The name of the object associated with the packageServiceId property.
packageFrequencyId
"packageFrequencyId": 19
Type: Number
Unique identifier for the associated PackageFrequency object.
packageFrequencyName
"packageFrequencyName": "Sample Name"
Type: String
The name of the object associated with the packageFrequencyId property.
packageCurrencyId
"packageCurrencyId": 19
Type: Number
Unique identifier for the associated PackageCurrency object.
packageCurrencyName
"packageCurrencyName": "Sample Name"
Type: String
The name of the object associated with the packageCurrencyId property.
accountPricePlanId
"accountPricePlanId": 13
Type: Number
Unique identifier for the associated AccountPricePlan object.
accountPricePlanName
"accountPricePlanName": "Sample Name"
Type: String
The name of the object associated with the accountPricePlanId property.
accountProductCodeId
"accountProductCodeId": 2
Type: Number
Unique identifier for the associated AccountProductCode object.
accountProductCodeName
"accountProductCodeName": "Sample Name"
Type: String
The name of the object associated with the accountProductCodeId property.
priceBookId
"priceBookId": 4
Type: Number
Unique identifier for the associated PriceBook object.
priceBookName
"priceBookName": "Sample Name"
Type: String
The name of the object associated with the priceBookId property.
generalLedgerId
"generalLedgerId": 16
Type: Number
Unique identifier for the associated GeneralLedger object.
generalLedgerName
"generalLedgerName": "Sample Name"
Type: String
The name of the object associated with the generalLedgerId property.
serviceTaxCategoryId
"serviceTaxCategoryId": 15
Type: Number
Unique identifier for the associated ServiceTaxCategory object.
serviceTaxCategoryName
"serviceTaxCategoryName": "Sample Name"
Type: String
The name of the object associated with the serviceTaxCategoryId property.
isTaxInclusive
"isTaxInclusive": true
Type: Boolean


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. Below you will find the child objects that can be updated as part of PATCH operations for the PackageServicePricePlan object.

Standard PATCH objects:

  • packageServiceRecurringPrice - create, update, delete
  • packageServiceTransitionPrice - create, update, delete

DataFlow PATCH objects:

  • packageServicePricePlan - create, update, delete
  • packageServiceRecurringPrice - create, update, delete
  • packageServiceTransitionPrice - create, update, delete

End Points

DELETEPackage/Service/PricePlan/{id}
Delete an instance of the PackageServicePricePlan 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 PackageServicePricePlan object.
Delete an instance of the PackageServicePricePlan object.
DELETE Package/Service/PricePlan/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "packageServicePricePlan"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETPackage/Service/PricePlan/
Retrieve all of the PackageServicePricePlan objects.
Retrieve all of the PackageServicePricePlan objects.
GET Package/Service/PricePlan/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "packageServiceId": 24,
            "packageServiceName": "Sample Text Data",
            "packageFrequencyId": 21,
            "packageFrequencyName": "Sample Text Data",
            "packageCurrencyId": 5,
            "packageCurrencyName": "Sample Text Data",
            "accountPricePlanId": 14,
            "accountPricePlanName": "Sample Text Data",
            "accountProductCodeId": 16,
            "accountProductCodeName": "Sample Text Data",
            "priceBookId": 25,
            "priceBookName": "Sample Text Data",
            "generalLedgerId": 12,
            "generalLedgerName": "Sample Text Data",
            "serviceTaxCategoryId": 3,
            "serviceTaxCategoryName": "Sample Text Data",
            "isTaxInclusive": true
        }
    ]
}
GETPackage/Service/PricePlan/AvailableFor/Account/{id}/AccountProductCode/{accountProductCodeId}
Retrieve the PackageServicePricePlan that is available for the specified Account and AccountProductCode.
{id}Unique identifier for the Account object.
{accountProductCodeId}Unique identifier for the AccountProductCode object.
Retrieve the PackageServicePricePlan that is available for the specified Account and AccountProductCode.
GET Package/Service/PricePlan/AvailableFor/Account/{id}/AccountProductCode/{accountProductCodeId}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "bc7b30cb-cb26-44f3-9a52-819adadb8721",
    "instance": {
        "identity": 2069,
        "packageServiceId": 1,
        "packageFrequencyId": 45,
        "packageFrequencyName": "DSL Package - 1 Month",
        "packageCurrencyId": 3,
        "isCountOnFirstUsage": false,
        "packageId": 1,
        "packageName": "DSL Package",
        "serviceId": 1,
        "serviceName": "Extreme DSL Service",
        "packageFrequencyPackageCurrencyIsActive": true,
        "currencyId": 1,
        "currencyName": "United States Dollar",
        "currencyCode": "USD",
        "statusTierTypeId": 1,
        "statusTierTypeName": "Not Tiered"
    }
}
GETPackage/Service/PricePlan/Paged
Retrieve all of the PackageServicePricePlan 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 PackageServicePricePlan objects in a paged fashion.
GET Package/Service/PricePlan/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "packageServiceId": 14,
                "packageServiceName": "Sample Text Data",
                "packageFrequencyId": 12,
                "packageFrequencyName": "Sample Text Data",
                "packageCurrencyId": 3,
                "packageCurrencyName": "Sample Text Data",
                "accountPricePlanId": 18,
                "accountPricePlanName": "Sample Text Data",
                "accountProductCodeId": 19,
                "accountProductCodeName": "Sample Text Data",
                "priceBookId": 15,
                "priceBookName": "Sample Text Data",
                "generalLedgerId": 14,
                "generalLedgerName": "Sample Text Data",
                "serviceTaxCategoryId": 27,
                "serviceTaxCategoryName": "Sample Text Data",
                "isTaxInclusive": true
            }
        ]
    }
}
GETPackage/Service/PricePlan/Paged/Detail
Retrieve all of the PackageServicePricePlan 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 PackageServicePricePlan objects in a paged fashion with all object details.
GET Package/Service/PricePlan/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "packageServiceId": 23,
                "packageServiceName": "Sample Text Data",
                "packageFrequencyId": 21,
                "packageFrequencyName": "Sample Text Data",
                "packageCurrencyId": 8,
                "packageCurrencyName": "Sample Text Data",
                "accountPricePlanId": 26,
                "accountPricePlanName": "Sample Text Data",
                "accountProductCodeId": 13,
                "accountProductCodeName": "Sample Text Data",
                "priceBookId": 27,
                "priceBookName": "Sample Text Data",
                "generalLedgerId": 25,
                "generalLedgerName": "Sample Text Data",
                "serviceTaxCategoryId": 1,
                "serviceTaxCategoryName": "Sample Text Data",
                "isTaxInclusive": true,
                "details": {
                    "recurringPrices": [
                        {
                            "identity": 85,
                            "packageServicePricePlanId": 70,
                            "serviceStatusTypeId": 8,
                            "serviceStatusTypeName": "Sample Text Data",
                            "amount": 89.2,
                            "pricePlanTierTypeId": 77,
                            "pricePlanTierTypeName": "Sample Text Data",
                            "details": {
                                "identity": 48,
                                "amount": 14.46,
                                "threshold": 14,
                                "packageServiceRecurringPriceId": 1
                            }
                        }
                    ],
                    "transitionPrices": [
                        {
                            "identity": 7,
                            "amount": 54.04,
                            "packageServicePricePlanId": 61,
                            "serviceTransitionId": 34,
                            "serviceTransitionName": "Sample Text Data",
                            "chargeServiceId": 20,
                            "chargeServiceName": "Sample Text Data",
                            "transitionDuration": 88,
                            "frequencyTypeId": 19,
                            "frequencyTypeName": "Sample Text Data",
                            "transitionDurationPenaltyAmount": 2.07,
                            "transitionLimit": 59
                        }
                    ],
                    "currentRatePlan": {
                        "identity": 13,
                        "name": "Sample Text Data",
                        "displayName": "Sample Text Data",
                        "start": "2021-04-26T15:25:27.587Z"
                    },
                    "nonRecurringPrices": [
                        {
                            "identity": 78,
                            "packageServicePricePlanId": 52,
                            "pricePlanTierTypeId": 24,
                            "pricePlanTierTypeName": "Sample Text Data",
                            "amount": 26.62,
                            "details": {
                                "tiers": [
                                    {
                                        "identity": 98,
                                        "packageServiceNonRecurringPriceId": 51,
                                        "amount": 64.52,
                                        "threshold": 6
                                    }
                                ]
                            }
                        }
                    ],
                    "packageServiceDiscounts": [
                        {
                            "identity": 35,
                            "packageServicePricePlanId": 78,
                            "discountName": "Sample Text Data",
                            "discountStart": "2021-04-26T15:25:27.587Z",
                            "discountEnd": "2021-04-26T15:25:27.587Z",
                            "isProrated": true,
                            "generalLedgerId": 56,
                            "generalLedgerName": "Sample Text Data",
                            "appliedOrder": 41,
                            "isActive": true,
                            "isFreeTrial": true,
                            "isNegativeAllowed": true,
                            "details": {
                                "packageServiceStatusDiscounts": [
                                    {
                                        "identity": 28,
                                        "packageServiceDiscountId": 71,
                                        "serviceStatusTypeId": 26,
                                        "serviceStatusTypeName": "Sample Text Data",
                                        "discountPromoCodeCurrencyId": 57,
                                        "discountId": 13,
                                        "details": {
                                            "discountAmounts": [
                                                {
                                                    "identity": 41,
                                                    "discountId": 59,
                                                    "discountTypeId": 79,
                                                    "discountTypeName": "Sample Text Data",
                                                    "frequency": 64,
                                                    "frequencyTypeId": 77,
                                                    "frequencyTypeName": "Sample Text Data",
                                                    "amount": 12.43,
                                                    "appliedOrder": 49
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}
GETPackage/Service/PricePlan/{id}
Retrieve an instance of the PackageServicePricePlan object by its ID.
{id}Unique identifier for the PackageServicePricePlan object.
Retrieve an instance of the PackageServicePricePlan object by its ID.
GET Package/Service/PricePlan/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "packageServiceId": 24,
        "packageServiceName": "Sample Text Data",
        "packageFrequencyId": 15,
        "packageFrequencyName": "Sample Text Data",
        "packageCurrencyId": 18,
        "packageCurrencyName": "Sample Text Data",
        "accountPricePlanId": 6,
        "accountPricePlanName": "Sample Text Data",
        "accountProductCodeId": 13,
        "accountProductCodeName": "Sample Text Data",
        "priceBookId": 12,
        "priceBookName": "Sample Text Data",
        "generalLedgerId": 14,
        "generalLedgerName": "Sample Text Data",
        "serviceTaxCategoryId": 14,
        "serviceTaxCategoryName": "Sample Text Data",
        "isTaxInclusive": true
    }
}
GETPackage/Service/PricePlan/{id}/Detail
Retrieve deep detail of the PackageServicePricePlan 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 PackageServicePricePlan object.
Retrieve deep detail of the PackageServicePricePlan object by its ID.
GET Package/Service/PricePlan/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "packageServiceId": 15,
        "packageServiceName": "Sample Text Data",
        "packageFrequencyId": 10,
        "packageFrequencyName": "Sample Text Data",
        "packageCurrencyId": 8,
        "packageCurrencyName": "Sample Text Data",
        "accountPricePlanId": 17,
        "accountPricePlanName": "Sample Text Data",
        "accountProductCodeId": 10,
        "accountProductCodeName": "Sample Text Data",
        "priceBookId": 12,
        "priceBookName": "Sample Text Data",
        "generalLedgerId": 26,
        "generalLedgerName": "Sample Text Data",
        "serviceTaxCategoryId": 19,
        "serviceTaxCategoryName": "Sample Text Data",
        "isTaxInclusive": true,
        "details": {
            "recurringPrices": [
                {
                    "identity": 85,
                    "packageServicePricePlanId": 70,
                    "serviceStatusTypeId": 8,
                    "serviceStatusTypeName": "Sample Text Data",
                    "amount": 89.2,
                    "pricePlanTierTypeId": 77,
                    "pricePlanTierTypeName": "Sample Text Data",
                    "details": {
                        "identity": 48,
                        "amount": 14.46,
                        "threshold": 14,
                        "packageServiceRecurringPriceId": 1
                    }
                }
            ],
            "transitionPrices": [
                {
                    "identity": 7,
                    "amount": 54.04,
                    "packageServicePricePlanId": 61,
                    "serviceTransitionId": 34,
                    "serviceTransitionName": "Sample Text Data",
                    "chargeServiceId": 20,
                    "chargeServiceName": "Sample Text Data",
                    "transitionDuration": 88,
                    "frequencyTypeId": 19,
                    "frequencyTypeName": "Sample Text Data",
                    "transitionDurationPenaltyAmount": 2.07,
                    "transitionLimit": 59
                }
            ],
            "currentRatePlan": {
                "identity": 13,
                "name": "Sample Text Data",
                "displayName": "Sample Text Data",
                "start": "2021-04-26T15:25:27.587Z"
            },
            "nonRecurringPrices": [
                {
                    "identity": 78,
                    "packageServicePricePlanId": 52,
                    "pricePlanTierTypeId": 24,
                    "pricePlanTierTypeName": "Sample Text Data",
                    "amount": 26.62,
                    "details": {
                        "tiers": [
                            {
                                "identity": 98,
                                "packageServiceNonRecurringPriceId": 51,
                                "amount": 64.52,
                                "threshold": 6
                            }
                        ]
                    }
                }
            ],
            "packageServiceDiscounts": [
                {
                    "identity": 35,
                    "packageServicePricePlanId": 78,
                    "discountName": "Sample Text Data",
                    "discountStart": "2021-04-26T15:25:27.587Z",
                    "discountEnd": "2021-04-26T15:25:27.587Z",
                    "isProrated": true,
                    "generalLedgerId": 56,
                    "generalLedgerName": "Sample Text Data",
                    "appliedOrder": 41,
                    "isActive": true,
                    "isFreeTrial": true,
                    "isNegativeAllowed": true,
                    "details": {
                        "packageServiceStatusDiscounts": [
                            {
                                "identity": 28,
                                "packageServiceDiscountId": 71,
                                "serviceStatusTypeId": 26,
                                "serviceStatusTypeName": "Sample Text Data",
                                "discountPromoCodeCurrencyId": 57,
                                "discountId": 13,
                                "details": {
                                    "discountAmounts": [
                                        {
                                            "identity": 41,
                                            "discountId": 59,
                                            "discountTypeId": 79,
                                            "discountTypeName": "Sample Text Data",
                                            "frequency": 64,
                                            "frequencyTypeId": 77,
                                            "frequencyTypeName": "Sample Text Data",
                                            "amount": 12.43,
                                            "appliedOrder": 49
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}
PATCHPackage/Service/PricePlan/{id}
Update or Add the PackageServicePricePlan 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 PackageServicePricePlan object.
Update or Add the PackageServicePricePlan object and optionally make changes to any child objects.
PATCH Package/Service/PricePlan/{id}

{
    "details": {},
    "packageServicePricePlans": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "packageServiceId": 20,
                "packageFrequencyId": 3,
                "packageCurrencyId": 6,
                "accountPricePlanId": 15,
                "accountProductCodeId": 27,
                "priceBookId": 14,
                "generalLedgerId": 0,
                "serviceTaxCategoryId": 10,
                "isTaxInclusive": true
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "packageServicePricePlan",
                "instance": {
                    "identity": 1,
                    "packageServiceId": 7,
                    "packageServiceName": "Sample Text Data",
                    "packageFrequencyId": 4,
                    "packageFrequencyName": "Sample Text Data",
                    "packageCurrencyId": 18,
                    "packageCurrencyName": "Sample Text Data",
                    "accountPricePlanId": 22,
                    "accountPricePlanName": "Sample Text Data",
                    "accountProductCodeId": 11,
                    "accountProductCodeName": "Sample Text Data",
                    "priceBookId": 26,
                    "priceBookName": "Sample Text Data",
                    "generalLedgerId": 22,
                    "generalLedgerName": "Sample Text Data",
                    "serviceTaxCategoryId": 3,
                    "serviceTaxCategoryName": "Sample Text Data",
                    "isTaxInclusive": true
                }
            }
        ]
    }
}
POSTPackage/Service/PricePlan/
Create a new instance of the PackageServicePricePlan object.
Create a new instance of the PackageServicePricePlan object.
POST Package/Service/PricePlan/

{
    "packageServiceId": 2,
    "packageFrequencyId": 8,
    "packageCurrencyId": 27,
    "accountPricePlanId": 18,
    "accountProductCodeId": 8,
    "priceBookId": 9,
    "generalLedgerId": 1,
    "serviceTaxCategoryId": 15,
    "isTaxInclusive": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "packageServiceId": 22,
                "packageServiceName": "Sample Text Data",
                "packageFrequencyId": 8,
                "packageFrequencyName": "Sample Text Data",
                "packageCurrencyId": 11,
                "packageCurrencyName": "Sample Text Data",
                "accountPricePlanId": 16,
                "accountPricePlanName": "Sample Text Data",
                "accountProductCodeId": 15,
                "accountProductCodeName": "Sample Text Data",
                "priceBookId": 5,
                "priceBookName": "Sample Text Data",
                "generalLedgerId": 19,
                "generalLedgerName": "Sample Text Data",
                "serviceTaxCategoryId": 24,
                "serviceTaxCategoryName": "Sample Text Data",
                "isTaxInclusive": true
            }
        ]
    }
}
PUTPackage/Service/PricePlan/{id}
Update an existing instance of the PackageServicePricePlan object.
Update an existing instance of the PackageServicePricePlan object.
PUT Package/Service/PricePlan/{id}

{
    "identity": 1,
    "packageServiceId": 4,
    "packageFrequencyId": 12,
    "packageCurrencyId": 15,
    "accountPricePlanId": 12,
    "accountProductCodeId": 10,
    "priceBookId": 18,
    "generalLedgerId": 13,
    "serviceTaxCategoryId": 17,
    "isTaxInclusive": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "packageServiceId": 15,
                "packageServiceName": "Sample Text Data",
                "packageFrequencyId": 17,
                "packageFrequencyName": "Sample Text Data",
                "packageCurrencyId": 17,
                "packageCurrencyName": "Sample Text Data",
                "accountPricePlanId": 20,
                "accountPricePlanName": "Sample Text Data",
                "accountProductCodeId": 27,
                "accountProductCodeName": "Sample Text Data",
                "priceBookId": 17,
                "priceBookName": "Sample Text Data",
                "generalLedgerId": 20,
                "generalLedgerName": "Sample Text Data",
                "serviceTaxCategoryId": 18,
                "serviceTaxCategoryName": "Sample Text Data",
                "isTaxInclusive": true
            }
        ]
    }
}
PUTPackage/Service/PricePlan/{id}/DiscountRank
Re-arrange the order of the Package Service Price Plan Discounts.The Rank defined based on the order of the discounts will be used to identify the priority. This API is expecting all the Package Service Price Plan Discount ids to be passed in order of priority.
{id}Unique identifier for the Package Service Price Plan object.
Re-arrange the order of the Package Service Price Plan Discounts.
PUT Package/Service/PricePlan/{id}/DiscountRank

[
  13,
  20,
  12,
  41
]
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "packageServiceId": 19,
                "packageServiceName": "Sample Text Data",
                "packageFrequencyId": 3,
                "packageFrequencyName": "Sample Text Data",
                "packageCurrencyId": 21,
                "packageCurrencyName": "Sample Text Data",
                "accountPricePlanId": 6,
                "accountPricePlanName": "Sample Text Data",
                "accountProductCodeId": 1,
                "accountProductCodeName": "Sample Text Data",
                "priceBookId": 17,
                "priceBookName": "Sample Text Data",
                "generalLedgerId": 8,
                "generalLedgerName": "Sample Text Data",
                "serviceTaxCategoryId": 18,
                "serviceTaxCategoryName": "Sample Text Data",
                "isTaxInclusive": true
            }
        ]
    }
}