Update a product churn feature
patch
/crmRestApi/resources/11.13.18.05/subscriptionAiFeatures/{SubscriptionProductPuid}
Request
Path Parameters
-
SubscriptionProductPuid(required): string
The public unique identifier of the suscription product.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountAreaCode: string
Maximum Length:
60
The area code associated with the acount. -
AccountAutoRenewalFlag: boolean
Maximum Length:
1
Indicates if the account should be renewed automatically. -
AccountAverageLastQtrBillAmount: number
The average last quarter bill amount for the account.
-
AccountAverageLastSixmthBillAmount: number
The six months average bill amount for the account.
-
AccountAverageLastYearBillAmount: number
The average bill amount for the account over the last year.
-
AccountBalance: number
The current balance of the account.
-
AccountChildIdList: string
Maximum Length:
1000
The list with the account children. -
AccountChildList: string
Maximum Length:
4000
A list with the account children. -
AccountCsmIdentifiedFlag: boolean
Maximum Length:
1
Indicates if the account is CSM identified. -
AccountHasChildFlag: boolean
Maximum Length:
1
Indicates if the account has a child. -
AccountLength: string
Maximum Length:
20
The length of the account. -
AccountOpportunitiesLost: number
The number of opportunties lost by the acount.
-
AccountOpportunitiesOpen: number
The number of open opportunities associated with the account.
-
AccountOverdueInvoices: number
The number of overdue invoices for the acount.
-
AccountParent: string
Maximum Length:
360
The parent of the account. -
AccountParentId: string
Maximum Length:
30
The unique identifier of the account parent. -
AccountProductCount: number
The number of account products.
-
AccountProductDowngrades: number
The downgrades for the account product.
-
AccountProductTerminations: number
The terminations associated with the account product.
-
AccountStartDate: string
(date)
The start date of the account.
-
AccountState: string
Maximum Length:
60
The state associated with the acount. -
AccountTotalSrs: number
The total service requests logged against the account.
-
AccountType: string
Maximum Length:
30
The type of the account. -
AverageRenewalDuration: number
The average duration of renewal for the product.
-
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Maximum Length:
15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
ProductAnnivPricingFlag: boolean
Maximum Length:
1
The annual pricing of the product. -
ProductBillingFrequency: string
Maximum Length:
1000
The frequency of the product billing. -
ProductBreachedRequests: number
The number of breached requests for the product.
-
ProductEvergreenFlag: boolean
Maximum Length:
1
Indicates if this is an evergreen product. -
ProductPastRenewals: number
The number of product renewals in the past.
-
ProductUsageChange: number
The Product Usage Change
-
UsageChargesLastNinetyDays: number
The user charges in the last 90 days.
-
UsageChargesLastThirtyDays: number
The user charges in the last 30 days.
-
UsageChargesMthToDate: number
The user charges in the last month.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptionAiFeatures-item-response
Type:
Show Source
object
-
AccountAreaCode: string
Maximum Length:
60
The area code associated with the acount. -
AccountAutoRenewalFlag: boolean
Maximum Length:
1
Indicates if the account should be renewed automatically. -
AccountAverageLastQtrBillAmount: number
The average last quarter bill amount for the account.
-
AccountAverageLastSixmthBillAmount: number
The six months average bill amount for the account.
-
AccountAverageLastYearBillAmount: number
The average bill amount for the account over the last year.
-
AccountBalance: number
The current balance of the account.
-
AccountChildIdList: string
Maximum Length:
1000
The list with the account children. -
AccountChildList: string
Maximum Length:
4000
A list with the account children. -
AccountCsmIdentifiedFlag: boolean
Maximum Length:
1
Indicates if the account is CSM identified. -
AccountHasChildFlag: boolean
Maximum Length:
1
Indicates if the account has a child. -
AccountLength: string
Maximum Length:
20
The length of the account. -
AccountOpportunitiesLost: number
The number of opportunties lost by the acount.
-
AccountOpportunitiesOpen: number
The number of open opportunities associated with the account.
-
AccountOverdueInvoices: number
The number of overdue invoices for the acount.
-
AccountParent: string
Maximum Length:
360
The parent of the account. -
AccountParentId: string
Maximum Length:
30
The unique identifier of the account parent. -
AccountProductCount: number
The number of account products.
-
AccountProductDowngrades: number
The downgrades for the account product.
-
AccountProductTerminations: number
The terminations associated with the account product.
-
AccountStartDate: string
(date)
The start date of the account.
-
AccountState: string
Maximum Length:
60
The state associated with the acount. -
AccountTotalSrs: number
The total service requests logged against the account.
-
AccountType: string
Maximum Length:
30
The type of the account. -
AverageRenewalDuration: number
The average duration of renewal for the product.
-
BillToAccount: string
Maximum Length:
240
The bill to account assciated with the subscription. -
BillToAccountId: integer
(int64)
The unique identifier of the bill to account.
-
BillToSite: string
Maximum Length:
150
The bill to address. -
BillToSiteUseId: integer
(int64)
The unique identifier of the bill to side.
-
Churn: string
Maximum Length:
1
The churn for the subscritpion. -
ClosedDate: string
(date)
The date when the subscription was closed.
-
CloseReason: string
Maximum Length:
30
The reason to close the subscritpion. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Maximum Length:
15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
EndDate: string
(date)
The date when the subscription ends.
-
InventoryItemId: integer
(int64)
The unique identifier for the inventory item.
-
InvoicingRule: string
Maximum Length:
80
The rule followed for invoicing the suscription. -
InvoicingRuleId: integer
(int64)
The unique identifier of the invoicing rule.
-
ItemNumber: string
Maximum Length:
300
The alternate unique identifier of the item. -
ItemUOM: string
Maximum Length:
15
The unit of measure for the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MonthlyRecurringRevenue: number
The monthly recurring revenue for the subscription.
-
PaymentMethod: string
Maximum Length:
30
The payment method associated with the subscription. -
PaymentTerms: string
Maximum Length:
240
The terms of payment for the subscription, if any. -
PaymentTermsId: integer
(int64)
The unique identifier of the payment terms.
-
PrimaryParty: string
Maximum Length:
360
The primary party associated with the subscription. -
PrimaryPartyId: integer
(int64)
The unique identifier of the primary party.
-
ProductAnnivPricingFlag: boolean
Maximum Length:
1
The annual pricing of the product. -
ProductBillingFrequency: string
Maximum Length:
1000
The frequency of the product billing. -
ProductBreachedRequests: number
The number of breached requests for the product.
-
ProductEvergreenFlag: boolean
Maximum Length:
1
Indicates if this is an evergreen product. -
ProductName: string
Maximum Length:
300
The name of the product. -
ProductNetPrice: number
The net price of the product subscribed.
-
ProductPastRenewals: number
The number of product renewals in the past.
-
ProductUsageChange: number
The Product Usage Change
-
Quantity: number
The quantity associated with the suscription.
-
RenewalType: string
Maximum Length:
30
The renewal type for the subscription. -
SalesProductType: string
Maximum Length:
30
The type of the sales product. -
StartDate: string
(date)
The date when the subscription starts.
-
Status: string
Maximum Length:
30
The status of the product. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SubscriptionProductPuid: string
Maximum Length:
120
The public unique identifier of the suscription product. -
UsageChargesLastNinetyDays: number
The user charges in the last 90 days.
-
UsageChargesLastThirtyDays: number
The user charges in the last 30 days.
-
UsageChargesMthToDate: number
The user charges in the last month.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.