Update or Add the Package object and optionally make changes to any child objects.

patch

https://{server_address}/ResourceServer/api/v10/Package/{id}

Path Params

integer

required

Unique identifier for the Package object.

Body Params

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.

name

string

start

date-time

Date Time for when this Package is available for purchase. Date and time values are specified in the ISO 8601 format.

expiry

date-time

Date Time for when this Package is no longer available for purchase. Date and time values are specified in the ISO 8601 format.

fullPeriod

boolean

invoiceDetail

string

postPaid

boolean

billOnAccountBillDay

boolean

defaultAccountPackageStatusTypeId

number

Unique identifier for the associated AccountPackageStatusType object.

defaultAccountPackageStatusTypeName

string

The name of the object associated with the defaultAccountPackageStatusTypeId property.

packageCategoryId

number

Unique identifier for the associated PackageCategory object.

packageCategoryName

string

The name of the object associated with the packageCategoryId property.

chargeRecurringIfUsage

boolean

isGlobalAddOnEligible

boolean

description

string

isQuantityAllowed

boolean

number

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Patch 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.

400The request could not be processed.