PUT v1/bunits/{bunitId}/subscriptions/{subscriptionId}/components/{componentId}

Update a component

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId Id of the business unit integer

Required

subscriptionId Id of the subscription integer

Required

componentId Id of the component integer

Required

Body Parameters

The component to be saved

SubscriptionComponent
NameDescriptionTypeAdditional information
Quantity IsCapacity is false:

Quantity is included in the component.

IsCapacity is true:

Quantity is the size of a capacity increase / step wise increment.
integer

None.

Price IsCapacity is false:

The unit price.

IsCapacity is true:

The price of a capacity increase.
decimal number

None.

IsCapacity Indicates whether the component is in capacity mode.


Capacity mode means that the component step wise
boolean

None.

IncludedBundles If component is in capacity mode then an included number of bundles/packages can be specified
Included bundles/packages will not be invoiced
integer

None.

StartDate When adding a product to a subscription set this date
date

None.

QuantityCalculationOption This option determines how the quantity of the product is calculated
Options are
Ultimo = 1,
Primo = 2,
Sum = 3,
Average = 4,
Minimum = 5,
Maximum = 6
QuantityCalculationOption

None.

Product Defines how this component will be invoiced.
Product

None.

ReplicationType ReplicationType

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

Response Information

Resource Description

The saved component

SubscriptionComponent
NameDescriptionTypeAdditional information
Quantity IsCapacity is false:

Quantity is included in the component.

IsCapacity is true:

Quantity is the size of a capacity increase / step wise increment.
integer

None.

Price IsCapacity is false:

The unit price.

IsCapacity is true:

The price of a capacity increase.
decimal number

None.

IsCapacity Indicates whether the component is in capacity mode.


Capacity mode means that the component step wise
boolean

None.

IncludedBundles If component is in capacity mode then an included number of bundles/packages can be specified
Included bundles/packages will not be invoiced
integer

None.

StartDate When adding a product to a subscription set this date
date

None.

QuantityCalculationOption This option determines how the quantity of the product is calculated
Options are
Ultimo = 1,
Primo = 2,
Sum = 3,
Average = 4,
Minimum = 5,
Maximum = 6
QuantityCalculationOption

None.

Product Defines how this component will be invoiced.
Product

None.

ReplicationType ReplicationType

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.