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

patch

https://{server_address}/ResourceServer/api/v10/Usage/Bucket/SharePlan/{id}

Path Params

integer

required

Unique identifier for the UsageBucketSharePlan object.

Body Params

System defined list of levels of sharing that can occur. Such as account level or invoice recipient level.

usageBucketShareLevelId

number

Unique identifier for the associated UsageBucketShareLevel object.

usageBucketShareLevelName

string

The name of the object associated with the usageBucketShareLevelId property.

name

string

description

string

usageBucketSharePlanActivationTypeId

number

Unique identifier for the associated UsageBucketSharePlanActivationType object.

usageBucketSharePlanActivationTypeName

string

The name of the object associated with the usageBucketSharePlanActivationTypeId property.

isActive

boolean

isAvailable

boolean

defaultServiceStatusTypeId

number

Unique identifier for the associated ServiceStatusType object.

defaultServiceStatusTypeName

string

The name of the object associated with the defaultServiceStatusTypeId property.

isPackageLevelParticipation

boolean

sharePlanTypeId

number

Unique identifier for the associated SharePlanType object.

sharePlanTypeName

string

The name of the object associated with the sharePlanTypeId property.

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.