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

Update a subscription

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId Id of the business unit of the subscription integer

Required

subscriptionId Id of the subscription to update integer

Required

Body Parameters

The subscription to update

Subscription
NameDescriptionTypeAdditional information
Name The subscription's name.
string

Required.

Description A description of the subscription.
string

None.

Currency The currency the subscription is settled in
Currency

None.

ContractCount Number of contracts with the given subscription
integer

None.

ExceptionCount Number of contract exceptions with the given subscription
integer

None.

Components Components of the subscription.
Collection of SubscriptionComponent

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.

Operations Collection of OperationResult

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

Response Information

Resource Description

The updated subscription

Subscription
NameDescriptionTypeAdditional information
Name The subscription's name.
string

Required.

Description A description of the subscription.
string

None.

Currency The currency the subscription is settled in
Currency

None.

ContractCount Number of contracts with the given subscription
integer

None.

ExceptionCount Number of contract exceptions with the given subscription
integer

None.

Components Components of the subscription.
Collection of SubscriptionComponent

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.

Operations Collection of OperationResult

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.