TAG LINE
TAG LINE
SMALL TITLE
Packages are products/offerings that are added to accounts and billed. A package contains one or more services, the services are the individual line items that charges are configured on.
identity READ-ONLY | "identity": 26 Type: Number This is the unique numeric identifier for the Package |
name | "name": "Gold Service Plan" Type: String User defined name for the Package. |
ownerId READ-ONLY | "ownerId": 19 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
start | "start": "2021-04-26T15:25:27.587Z" Type: Date Date Time for when this Package is available for purchase. Date and time values are specified in the ISO 8601 format. |
expiry | "expiry": "2021-04-26T15:25:27.587Z" Type: Date Date Time for when this Package is no longer available for purchase. Date and time values are specified in the ISO 8601 format. |
fullPeriod | "fullPeriod": true Type: Boolean Whether or not when this package charges the full period and does not prorate. |
invoiceDetail | "invoiceDetail": "Hello World" Type: String A user defined description for this Package |
postPaid | "postPaid": true Type: Boolean Whether or not this package is post-paid. |
billOnAccountBillDay | "billOnAccountBillDay": true Type: Boolean Determines whether the billing of the package is synchronised with the account bill day. |
defaultAccountPackageStatusTypeId | "defaultAccountPackageStatusTypeId": 8 Type: Number Unique identifier for the associated AccountPackageStatusType object. |
defaultAccountPackageStatusTypeName | "defaultAccountPackageStatusTypeName": "Sample Name" Type: String The name of the object associated with the defaultAccountPackageStatusTypeId property. |
packageCategoryId | "packageCategoryId": 23 Type: Number Unique identifier for the associated PackageCategory object. |
packageCategoryName | "packageCategoryName": "Sample Name" Type: String The name of the object associated with the packageCategoryId property. |
chargeRecurringIfUsage | "chargeRecurringIfUsage": true Type: Boolean Whether or not to only charge recurring fees if there are usage charges for this period. |
isGlobalAddOnEligible | "isGlobalAddOnEligible": true Type: Boolean Whether or not this package is eligible to have Global Add-ons attached to it. |
description | "description": "The best service plan available" Type: String A user defined description for this Package |
isQuantityAllowed | "isQuantityAllowed": false Type: Boolean Determines whether multiples of the package are allowed. |
id | "id": 12 Type: Number |
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 Package object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | Package/{id} |
| Delete an instance of the Package 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 Package object. |
Delete an instance of the Package object. DELETE Package/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "package"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Package/ |
| Retrieve all of the Package objects. | |
Retrieve all of the Package objects. GET Package/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Gold Service Plan",
"ownerId": 8,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 25,
"defaultAccountPackageStatusTypeName": "Sample Text Data",
"packageCategoryId": 20,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 18
}
]
} | |
| GET | Package/AvailableFor/Currency/{id} |
| Retrieve Package objects that are avaialable for the specified Currency. | |
| {id} | Unique identifier for the Currency object. |
Retrieve Package objects that are avaialable for the specified Currency. GET Package/AvailableFor/Currency/{id}HTTP/1.1 200 OK
{
"trackingId": "a09f1146-6e20-46b6-ba73-35755561f273",
"totalCount": 1,
"items": [
{
"identity": 2,
"name": "DialUp Package",
"created": "2005-02-11T11:23:11",
"fullPeriod": false,
"postPaid": false,
"syncToBillDay": true,
"defaultAccountPackageStatusTypeId": 99,
"defaultAccountPackageStatusTypeName": "Enable",
"packageCategoryId": 2,
"packageCategoryName": "Default"
}
]
} | |
| GET | Package/AvailableFor/SharePlan/Participation |
| Internal endpoint that is not currently used. | |
| GET | Package/Paged |
| Retrieve all of the Package 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 Package objects in a paged fashion. GET Package/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": "Gold Service Plan",
"ownerId": 20,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 10,
"defaultAccountPackageStatusTypeName": "Sample Text Data",
"packageCategoryId": 6,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 14
}
]
}
} | |
| GET | Package/Paged/Detail |
| Retrieve all of the Package 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 Package objects in a paged fashion with all object details. GET Package/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": "Gold Service Plan",
"ownerId": 3,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 15,
"defaultAccountPackageStatusTypeName": "Sample Text Data",
"packageCategoryId": 20,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 20,
"details": {
"services": [
{
"identity": 80,
"packageId": 31,
"packageName": "Sample Text Data",
"serviceId": 61,
"serviceName": "Sample Text Data",
"defaultInstances": 17,
"minimumInstances": 3,
"maximumInstances": 60,
"termId": 80,
"termName": "Sample Text Data",
"isUsageBucketSharePlanPackageService": true,
"usageClassDynamicId": 61,
"usageClassDynamicName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"serviceCategoryId": 43,
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"usageBuckets": [
{
"identity": 7,
"name": "Sample Text Data",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 28,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 76,
"refillFrequencyTypeId": 50,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 41,
"expireAfterFrequencyTypeId": 46,
"expireAfterFrequencyTypeName": "Sample Text Data",
"expireAfterRecurrence": 89,
"isAssociatedWithSharePlan": true,
"accountPackageActivation": true,
"overageUsageRatePlanId": 31,
"isSharedAcrossPackage": true,
"overageUsageRatePlanName": "Sample Text Data",
"isBytesInBinaryUnit": true,
"usageBucketBaseUnitId": 78,
"usageBucketBaseUnitName": "Sample Text Data",
"details": {
"tiers": [
{
"identity": 62,
"usageBucketId": 85,
"usageBucketName": "Sample Text Data",
"threshold": 90.55,
"flatCharge": 37.19,
"usageUnitId": 42,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 12,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 29,
"currencyId": 49,
"currencyName": "Sample Text Data",
"money": 27.29,
"priceBookId": 56,
"priceBookName": "Sample Text Data",
"tierOverride": true
}
],
"contributions": [
{
"identity": 37,
"usageBucketSharePlanParticipationId": 63,
"usageBucketId": 46,
"usageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 60.53,
"contributingUsageUnitId": 62,
"contributingUsageUnitName": "Sample Text Data",
"moneyCurrencyId": 84,
"serviceId": 49,
"serviceName": "Sample Text Data",
"packageId": 79,
"packageName": "Sample Text Data"
}
],
"usageBucketNotifications": [
{
"identity": 52,
"usageBucketServiceId": 68,
"emailConfigurationId": 11,
"emailConfigurationName": "Sample Text Data",
"webhookConfigurationId": 31,
"webhookConfigurationName": "Sample Text Data",
"thresholdPercent": 28,
"details": {
"emailConfiguration": {
"identity": 40,
"name": "Sample Text Data",
"eventSubscriptionId": 72,
"eventSubscriptionName": "Sample Text Data",
"emailTemplateId": 35,
"emailTemplateName": "Sample Text Data",
"details": {
"emailToAddresses": [
{
"identity": 66,
"emailConfigurationId": 98,
"emailConfigurationName": "Sample Text Data",
"userId": 82,
"userName": "Sample Text Data",
"contactTypeTypeId": 94,
"contactTypeTypeName": "Sample Text Data",
"email": "Sample Text Data"
}
]
}
},
"webhookConfiguration": {
"identity": 57,
"name": "Sample Text Data",
"url": "Sample Text Data",
"requestVerb": "Sample Text Data",
"webhookTemplateId": 66,
"webhookTemplateName": "Sample Text Data",
"keyValuePairAuthorizationTokenKey": "Sample Text Data",
"keyValuePairAuthorizationTokenValue": "Sample Text Data",
"eventSubscriptionId": 40,
"eventSubscriptionName": "Sample Text Data",
"webhookAuthorizationTypeId": 19,
"webhookAuthorizationTypeName": "Sample Text Data",
"oAuthUsername": "Sample Text Data",
"oAuthPassword": "Sample Text Data",
"oAuthClientId": "Sample Text Data",
"oAuthAuthorizationURL": "Sample Text Data",
"hasCredentialsSet": true,
"webhookFormatTypeId": 93,
"webhookFormatTypeName": "Sample Text Data",
"oAuthClientSecret": "Sample Text Data"
}
}
}
],
"usageBucketBase": [
{
"identity": 60,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"retired": true,
"usageBucketBaseUnitId": 29,
"usageBucketBaseUnitName": "Sample Text Data",
"details": {
"identity": 61,
"usageBucketBaseId": 69,
"usageBucketBaseName": "Sample Text Data",
"usageClassId": 70,
"usageClassName": "Sample Text Data",
"geoTreeLocationId": 12,
"geoTreeLocationName": "Sample Text Data",
"exclude": true,
"geoTreeLocationGroupId": 23,
"geoTreeLocationGroupName": "Sample Text Data"
}
}
]
}
}
]
}
}
],
"frequencies": [
{
"identity": 75,
"frequency": 98,
"isActive": true,
"packageId": 87,
"packageName": "Sample Text Data",
"frequencyTypeId": 20,
"frequencyTypeName": "Sample Text Data",
"termId": 0,
"termName": "Sample Text Data",
"sku": "Sample Text Data",
"name": "Sample Text Data",
"isUsageBucketSharePlanPackageFrequency": true,
"countingRuleId": 21,
"countingRuleName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
],
"currencies": [
{
"identity": 19,
"packageId": 68,
"packageName": "Sample Text Data",
"currencyId": 88,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data"
}
]
}
}
]
}
} | |
| GET | Package/{id} |
| Retrieve an instance of the Package object by its ID. | |
| {id} | Unique identifier for the Package object. |
Retrieve an instance of the Package object by its ID. GET Package/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Gold Service Plan",
"ownerId": 8,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 7,
"defaultAccountPackageStatusTypeName": "Sample Text Data",
"packageCategoryId": 10,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 17
}
} | |
| GET | Package/{id}/Detail |
| Retrieve deep detail of the Package 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 Package object. |
Retrieve deep detail of the Package object by its ID. GET Package/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Gold Service Plan",
"ownerId": 14,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 11,
"defaultAccountPackageStatusTypeName": "Sample Text Data",
"packageCategoryId": 14,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 2,
"details": {
"services": [
{
"identity": 80,
"packageId": 31,
"packageName": "Sample Text Data",
"serviceId": 61,
"serviceName": "Sample Text Data",
"defaultInstances": 17,
"minimumInstances": 3,
"maximumInstances": 60,
"termId": 80,
"termName": "Sample Text Data",
"isUsageBucketSharePlanPackageService": true,
"usageClassDynamicId": 61,
"usageClassDynamicName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"serviceCategoryId": 43,
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"usageBuckets": [
{
"identity": 7,
"name": "Sample Text Data",
"prorate": true,
"isInfiniteLastTier": true,
"isThresholdPerAccountService": true,
"usageBucketRefillTypeId": 28,
"usageBucketRefillTypeName": "Sample Text Data",
"refillFrequency": 76,
"refillFrequencyTypeId": 50,
"refillFrequencyTypeName": "Sample Text Data",
"expireAfterFrequency": 41,
"expireAfterFrequencyTypeId": 46,
"expireAfterFrequencyTypeName": "Sample Text Data",
"expireAfterRecurrence": 89,
"isAssociatedWithSharePlan": true,
"accountPackageActivation": true,
"overageUsageRatePlanId": 31,
"isSharedAcrossPackage": true,
"overageUsageRatePlanName": "Sample Text Data",
"isBytesInBinaryUnit": true,
"usageBucketBaseUnitId": 78,
"usageBucketBaseUnitName": "Sample Text Data",
"details": {
"tiers": [
{
"identity": 62,
"usageBucketId": 85,
"usageBucketName": "Sample Text Data",
"threshold": 90.55,
"flatCharge": 37.19,
"usageUnitId": 42,
"usageUnitName": "Sample Text Data",
"packageFrequencyId": 12,
"packageFrequencyName": "Sample Text Data",
"packageServiceId": 29,
"currencyId": 49,
"currencyName": "Sample Text Data",
"money": 27.29,
"priceBookId": 56,
"priceBookName": "Sample Text Data",
"tierOverride": true
}
],
"contributions": [
{
"identity": 37,
"usageBucketSharePlanParticipationId": 63,
"usageBucketId": 46,
"usageBucketName": "Sample Text Data",
"isContributing": true,
"contributingAmount": 60.53,
"contributingUsageUnitId": 62,
"contributingUsageUnitName": "Sample Text Data",
"moneyCurrencyId": 84,
"serviceId": 49,
"serviceName": "Sample Text Data",
"packageId": 79,
"packageName": "Sample Text Data"
}
],
"usageBucketNotifications": [
{
"identity": 52,
"usageBucketServiceId": 68,
"emailConfigurationId": 11,
"emailConfigurationName": "Sample Text Data",
"webhookConfigurationId": 31,
"webhookConfigurationName": "Sample Text Data",
"thresholdPercent": 28,
"details": {
"emailConfiguration": {
"identity": 40,
"name": "Sample Text Data",
"eventSubscriptionId": 72,
"eventSubscriptionName": "Sample Text Data",
"emailTemplateId": 35,
"emailTemplateName": "Sample Text Data",
"details": {
"emailToAddresses": [
{
"identity": 66,
"emailConfigurationId": 98,
"emailConfigurationName": "Sample Text Data",
"userId": 82,
"userName": "Sample Text Data",
"contactTypeTypeId": 94,
"contactTypeTypeName": "Sample Text Data",
"email": "Sample Text Data"
}
]
}
},
"webhookConfiguration": {
"identity": 57,
"name": "Sample Text Data",
"url": "Sample Text Data",
"requestVerb": "Sample Text Data",
"webhookTemplateId": 66,
"webhookTemplateName": "Sample Text Data",
"keyValuePairAuthorizationTokenKey": "Sample Text Data",
"keyValuePairAuthorizationTokenValue": "Sample Text Data",
"eventSubscriptionId": 40,
"eventSubscriptionName": "Sample Text Data",
"webhookAuthorizationTypeId": 19,
"webhookAuthorizationTypeName": "Sample Text Data",
"oAuthUsername": "Sample Text Data",
"oAuthPassword": "Sample Text Data",
"oAuthClientId": "Sample Text Data",
"oAuthAuthorizationURL": "Sample Text Data",
"hasCredentialsSet": true,
"webhookFormatTypeId": 93,
"webhookFormatTypeName": "Sample Text Data",
"oAuthClientSecret": "Sample Text Data"
}
}
}
],
"usageBucketBase": [
{
"identity": 60,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"retired": true,
"usageBucketBaseUnitId": 29,
"usageBucketBaseUnitName": "Sample Text Data",
"details": {
"identity": 61,
"usageBucketBaseId": 69,
"usageBucketBaseName": "Sample Text Data",
"usageClassId": 70,
"usageClassName": "Sample Text Data",
"geoTreeLocationId": 12,
"geoTreeLocationName": "Sample Text Data",
"exclude": true,
"geoTreeLocationGroupId": 23,
"geoTreeLocationGroupName": "Sample Text Data"
}
}
]
}
}
]
}
}
],
"frequencies": [
{
"identity": 75,
"frequency": 98,
"isActive": true,
"packageId": 87,
"packageName": "Sample Text Data",
"frequencyTypeId": 20,
"frequencyTypeName": "Sample Text Data",
"termId": 0,
"termName": "Sample Text Data",
"sku": "Sample Text Data",
"name": "Sample Text Data",
"isUsageBucketSharePlanPackageFrequency": true,
"countingRuleId": 21,
"countingRuleName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
],
"currencies": [
{
"identity": 19,
"packageId": 68,
"packageName": "Sample Text Data",
"currencyId": 88,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data"
}
]
}
}
} | |
| PATCH | Package/{id} |
| Update or Add the Package 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 Package object. |
Update or Add the Package object and optionally make changes to any child objects. PATCH Package/{id}
{
"details": {},
"packages": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "Gold Service Plan",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 4,
"packageCategoryId": 6,
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 21
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "package",
"instance": {
"identity": 1,
"name": "Gold Service Plan",
"ownerId": 2,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 4,
"defaultAccountPackageStatusTypeName": "Sample Text Data",
"packageCategoryId": 8,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 15
}
}
]
}
} | |
| POST | Package/ |
| Create a new instance of the Package object. | |
Create a new instance of the Package object. POST Package/
{
"name": "Gold Service Plan",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 25,
"packageCategoryId": 15,
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 25
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Gold Service Plan",
"ownerId": 14,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 19,
"defaultAccountPackageStatusTypeName": "Sample Text Data",
"packageCategoryId": 8,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 27
}
]
}
} | |
| PUT | Package/{id} |
| Update an existing instance of the Package object. | |
Update an existing instance of the Package object. PUT Package/{id}
{
"identity": 1,
"name": "Gold Service Plan",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 18,
"packageCategoryId": 2,
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 27
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Gold Service Plan",
"ownerId": 12,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z",
"expiry": "2021-04-26T15:25:27.587Z",
"fullPeriod": true,
"invoiceDetail": "Sample Text Data",
"postPaid": true,
"billOnAccountBillDay": true,
"defaultAccountPackageStatusTypeId": 21,
"defaultAccountPackageStatusTypeName": "Sample Text Data",
"packageCategoryId": 23,
"packageCategoryName": "Sample Text Data",
"chargeRecurringIfUsage": true,
"isGlobalAddOnEligible": true,
"description": "The best service plan available",
"isQuantityAllowed": false,
"id": 15
}
]
}
} | |