TAG LINE
SMALL TITLE

Package / Frequency

(API Version v4)


Represents a frequency in which a Package can be sold.


What can you do with PackageFrequency?


Properties

Property Details
identity
READ-ONLY
"identity": 19
Type: Number
This is the unique numeric identifier for the PackageFrequency
frequency
"frequency": 8
Type: Number
Number representing how often this package bills.
isActive
"isActive": true
Type: Boolean
Whether or not this Package Frequency is active.
packageId
"packageId": 10
Type: Number
Unique identifier for the associated Package object.
packageName
"packageName": "Sample Name"
Type: String
The name of the object associated with the packageId property.
frequencyTypeId
"frequencyTypeId": 6
Type: Number
Unique identifier for the associated FrequencyType object.
frequencyTypeName
"frequencyTypeName": "Sample Name"
Type: String
The name of the object associated with the frequencyTypeId property.
termId
"termId": 3
Type: Number
Unique identifier for the associated Term object.
termName
"termName": "Sample Name"
Type: String
The name of the object associated with the termId property.
sku
"sku": "SKU-123-FOO"
Type: String
A user defined SKU identifier for this Package Frequency.
name
"name": "Monthly Gold Package"
Type: String
A user defined name for the Package Frequency.
isUsageBucketSharePlanPackageFrequency
"isUsageBucketSharePlanPackageFrequency": true
Type: Boolean
countingRuleId
"countingRuleId": 7
Type: Number
Unique identifier for the associated CountingRule object.
countingRuleName
"countingRuleName": "Sample Name"
Type: String
The name of the object associated with the countingRuleId property.
id
"id": 15
Type: Number


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

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v4/Package/Frequency/{id}
Delete an instance of the PackageFrequency object. Upon successful delete, this API will return a record of all of the reelated 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 PackageFrequency object.
Delete an instance of the PackageFrequency object.
DELETE api/v4/Package/Frequency/{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": "packageFrequency"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Package/Frequency/
Retrieve all of the PackageFrequency objects.
Retrieve all of the PackageFrequency objects.
GET api/v4/Package/Frequency/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "frequency": 16,
            "isActive": true,
            "packageId": 15,
            "packageName": "Sample Text Data",
            "frequencyTypeId": 23,
            "frequencyTypeName": "Sample Text Data",
            "termId": 26,
            "termName": "Sample Text Data",
            "sku": "SKU-123-FOO",
            "name": "Monthly Gold Package",
            "isUsageBucketSharePlanPackageFrequency": true,
            "countingRuleId": 22,
            "countingRuleName": "Sample Text Data",
            "id": 22
        }
    ]
}
GETapi/v4/Package/Frequency/AvailableFor/Package/{id}/Currency/{currencyId}
Retrieve the PackageFrequency objects for the specified Package and Currency
{id}Unique identifier for the Package object.
{currencyId}Unique identifier for the Currency object.
GETapi/v4/Package/Frequency/Paged
Retrieve all of the PackageFrequency 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 PackageFrequency objects in a paged fashion.
GET api/v4/Package/Frequency/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,
                "frequency": 3,
                "isActive": true,
                "packageId": 0,
                "packageName": "Sample Text Data",
                "frequencyTypeId": 25,
                "frequencyTypeName": "Sample Text Data",
                "termId": 11,
                "termName": "Sample Text Data",
                "sku": "SKU-123-FOO",
                "name": "Monthly Gold Package",
                "isUsageBucketSharePlanPackageFrequency": true,
                "countingRuleId": 6,
                "countingRuleName": "Sample Text Data",
                "id": 25
            }
        ]
    }
}
GETapi/v4/Package/Frequency/Paged/Detail
Retrieve all of the PackageFrequency 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 PackageFrequency objects in a paged fashion with all object details.
GET api/v4/Package/Frequency/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,
                "frequency": 12,
                "isActive": true,
                "packageId": 1,
                "packageName": "Sample Text Data",
                "frequencyTypeId": 24,
                "frequencyTypeName": "Sample Text Data",
                "termId": 3,
                "termName": "Sample Text Data",
                "sku": "SKU-123-FOO",
                "name": "Monthly Gold Package",
                "isUsageBucketSharePlanPackageFrequency": true,
                "countingRuleId": 21,
                "countingRuleName": "Sample Text Data",
                "id": 10,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Package/Frequency/{id}
Retrieve an instance of the PackageFrequency object by its ID.
{id}Unique identifier for the PackageFrequency object.
Retrieve an instance of the PackageFrequency object by its ID.
GET api/v4/Package/Frequency/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "frequency": 9,
        "isActive": true,
        "packageId": 7,
        "packageName": "Sample Text Data",
        "frequencyTypeId": 26,
        "frequencyTypeName": "Sample Text Data",
        "termId": 4,
        "termName": "Sample Text Data",
        "sku": "SKU-123-FOO",
        "name": "Monthly Gold Package",
        "isUsageBucketSharePlanPackageFrequency": true,
        "countingRuleId": 17,
        "countingRuleName": "Sample Text Data",
        "id": 12
    }
}
GETapi/v4/Package/Frequency/{id}/Detail
Retrieve deep detail of the PackageFrequency 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 PackageFrequency object.
Retrieve deep detail of the PackageFrequency object by its ID.
GET api/v4/Package/Frequency/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "frequency": 9,
        "isActive": true,
        "packageId": 12,
        "packageName": "Sample Text Data",
        "frequencyTypeId": 23,
        "frequencyTypeName": "Sample Text Data",
        "termId": 25,
        "termName": "Sample Text Data",
        "sku": "SKU-123-FOO",
        "name": "Monthly Gold Package",
        "isUsageBucketSharePlanPackageFrequency": true,
        "countingRuleId": 7,
        "countingRuleName": "Sample Text Data",
        "id": 4,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Package/Frequency/{id}
Update or Add the PackageFrequency 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 PackageFrequency object.
Update or Add the PackageFrequency object and optionally make changes to any child objects.
PATCH api/v4/Package/Frequency/{id}

{
    "details": {},
    "packageFrequencys": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "frequency": 9,
                "isActive": true,
                "packageId": 15,
                "frequencyTypeId": 21,
                "termId": 8,
                "sku": "SKU-123-FOO",
                "name": "Monthly Gold Package",
                "isUsageBucketSharePlanPackageFrequency": true,
                "countingRuleId": 17,
                "id": 25
            }
        ]
    }
}
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": "packageFrequency",
                "instance": {
                    "identity": 1,
                    "frequency": 7,
                    "isActive": true,
                    "packageId": 22,
                    "packageName": "Sample Text Data",
                    "frequencyTypeId": 6,
                    "frequencyTypeName": "Sample Text Data",
                    "termId": 27,
                    "termName": "Sample Text Data",
                    "sku": "SKU-123-FOO",
                    "name": "Monthly Gold Package",
                    "isUsageBucketSharePlanPackageFrequency": true,
                    "countingRuleId": 21,
                    "countingRuleName": "Sample Text Data",
                    "id": 9
                }
            }
        ]
    }
}
POSTapi/v4/Package/Frequency/
Create a new instance of the PackageFrequency object.
Create a new instance of the PackageFrequency object.
POST api/v4/Package/Frequency/

{
    "frequency": 7,
    "isActive": true,
    "packageId": 20,
    "frequencyTypeId": 18,
    "termId": 19,
    "sku": "SKU-123-FOO",
    "name": "Monthly Gold Package",
    "isUsageBucketSharePlanPackageFrequency": true,
    "countingRuleId": 27,
    "id": 17
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "frequency": 14,
                "isActive": true,
                "packageId": 19,
                "packageName": "Sample Text Data",
                "frequencyTypeId": 20,
                "frequencyTypeName": "Sample Text Data",
                "termId": 4,
                "termName": "Sample Text Data",
                "sku": "SKU-123-FOO",
                "name": "Monthly Gold Package",
                "isUsageBucketSharePlanPackageFrequency": true,
                "countingRuleId": 9,
                "countingRuleName": "Sample Text Data",
                "id": 8
            }
        ]
    }
}
POSTapi/v4/Package/Frequency/Search
Retreive a list of PackageFrequency objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of PackageFrequency objects based on search criteria.
POST api/v4/Package/Frequency/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "frequency": 18,
            "isActive": true,
            "packageId": 7,
            "packageName": "Sample Text Data",
            "frequencyTypeId": 9,
            "frequencyTypeName": "Sample Text Data",
            "termId": 27,
            "termName": "Sample Text Data",
            "sku": "SKU-123-FOO",
            "name": "Monthly Gold Package",
            "isUsageBucketSharePlanPackageFrequency": true,
            "countingRuleId": 3,
            "countingRuleName": "Sample Text Data",
            "id": 12
        }
    ]
}
PUTapi/v4/Package/Frequency/{id}
Update an existing instance of the PackageFrequency object.
Update an existing instance of the PackageFrequency object.
PUT api/v4/Package/Frequency/{id}

{
    "identity": 1,
    "frequency": 7,
    "isActive": true,
    "packageId": 11,
    "frequencyTypeId": 9,
    "termId": 3,
    "sku": "SKU-123-FOO",
    "name": "Monthly Gold Package",
    "isUsageBucketSharePlanPackageFrequency": true,
    "countingRuleId": 13,
    "id": 10
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "frequency": 22,
                "isActive": true,
                "packageId": 14,
                "packageName": "Sample Text Data",
                "frequencyTypeId": 6,
                "frequencyTypeName": "Sample Text Data",
                "termId": 21,
                "termName": "Sample Text Data",
                "sku": "SKU-123-FOO",
                "name": "Monthly Gold Package",
                "isUsageBucketSharePlanPackageFrequency": true,
                "countingRuleId": 19,
                "countingRuleName": "Sample Text Data",
                "id": 9
            }
        ]
    }
}