Create a subscription product grouping assignment
post
/crmRestApi/resources/11.13.18.05/subscriptionProductsGroupingAssignments
Request
Header Parameters
-
Metadata-Context: string
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: string
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-
AccountingRuleId: integer
(int64)
Title:
Accounting Rule IDThe accounting rule ID of the subscription product. -
AlignBillingDay: number
Title:
Align Billing DayThe align billing day of the subscription product. -
AlignBillingFrom: string
(date)
Title:
Align Billing FromThe align billing from of the subscription product. -
AmendSourceProductPuid: string
Title:
Amended Subscription Product PUIDMaximum Length:255Amend Source Product Puid -
AttachToSubscriptionNumber: string
Maximum Length:
255The subscription number to which the product will be attached to. -
BalanceFirstPartialPeriodOption: string
Title:
Balance First Partial Period OptionMaximum Length:30Option to follow for balance management for first partial period. -
BalanceLastPartialPeriodOption: string
Title:
Balance Last Partial Period OptionMaximum Length:30Option to follow for balance management for last partial period. -
BalanceManagementError: string
Title:
Balance Management ErrorMaximum Length:2000The balance management error of the subscription product. -
BalanceProfileName: string
Title:
Profile NameThe name of the balance profile associated with the product. -
BalanceRegisterId: integer
(int64)
Title:
Balance Register IDThe balance register ID of the subscription product. -
BalanceTerminatedPartialPeriodOption: string
Title:
Balance Terminated Partial Period OptionMaximum Length:30Option to follow for balance management for terminated partial period. -
BatchTag: string
Title:
Batch TagMaximum Length:30The batch tag of the subscription product. -
BillingDateCode: string
Title:
Billing DateMaximum Length:30The billing date code of the subscription product. -
BillingFrequency: string
Title:
Billing FrequencyMaximum Length:30The billing frequency of the subscription product. -
BillingOffsetDays: integer
(int64)
Title:
Billing Offset DaysThe billing offset days of the subscription product. -
BillOnDay: number
Title:
Bill on DayThe bill on day of the subscription product. -
BillToAccountDescription: string
The bill-to account description of the subscription product.
-
BillToAccountId: integer
(int64)
Title:
Account IdThe bill-to account ID of the subscription product. -
BillToAccountNumber: string
Title:
Billing AccountMaximum Length:30The bill-to account number of the subscription product. -
BillToContactId: integer
(int64)
Title:
Bill-to Contact IDThe bill-to contact ID of the subscription product. -
BillToContactNumber: string
Title:
Bill-to Contact NumberThe bill-to contact number of the subscription product. -
BillToPartyId: integer
(int64)
Title:
Bill-to Party IDThe bill-to party ID of the subscription product. -
BillToSite: string
Title:
Bill-to SiteThe bill-to site of the subscription product. -
BillToSiteName: string
Title:
Bill-to SiteMaximum Length:255The bill-to site name of the subscription product. -
BillToSiteNumber: string
Title:
Bill-to Site NumberThe bill-to site number of the subscription product. -
BillToSiteUseId: integer
(int64)
Title:
Site Use IdThe bill-to site use ID of the subscription product. -
CalculatedCreditAmount: number
Title:
Calculated Credit AmountThe calculated credit amount of the subscription product. -
CalculateEstimatedTaxFlag: boolean
Indicates whether estimated tax for the subscription product should be calculated or not.
-
CancelDescription: string
Title:
Cancellation DescriptionMaximum Length:2000The cancel description of the subscription product. -
CanceledAmount: number
Title:
Canceled AmountThe canceled amount of the subscription product. -
CanceledDate: string
(date)
Title:
Product Canceled DateThe canceled date of the subscription product. -
CancelReason: string
Title:
Cancellation ReasonMaximum Length:30The cancel reason of the subscription product. -
ChargeRulesFlag: string
Title:
Charge RulesIndicates whether volume pricing rule is associated with the subscription product. -
CheckActiveExpiredAssetsExists: string
Indicates whether active or expired assets exist for the subscription product.
-
CheckHoldAssetsExists: string
Indicates whether assets on hold exist for the subscription product.
-
ChurnPredictionTrend: integer
(int32)
Title:
Churn Prediction TrendThe churn prediction trend of the subscription product. -
ChurnProbability: number
Title:
Churn ProbabilityThe churn probability of the subscription product. -
CloseCreditMethod: string
Title:
Close Credit MethodMaximum Length:30The close credit method of the subscription product. -
ClosedAmount: number
Title:
Closed AmountThe close amount of the subscription product. -
ClosedDate: string
(date)
Title:
Product Close DateThe closed date of the subscription product. -
CloseDescription: string
Title:
Close DescriptionMaximum Length:2000The close description of the subscription product. -
CloseReason: string
Title:
Product Close ReasonMaximum Length:30The close reason of the subscription product. -
CommitmentFlag: string
Indicates whether commitment type of plan associated with the product.
-
CorpCurrencyCode: string
Title:
Currency CodeMaximum Length:15The corporate currency code of the subscription product. -
CoverageName: string
Title:
Template NameThe coverage name of the subscription product. -
CoverageScheduleId: integer
(int64)
Title:
Coverage Schedule IDThe coverage schedule ID of the subscription product. -
CreditedAmount: number
Title:
Credited AmountThe credited amount of the subscription product. -
CreditType: string
Title:
Credit TypeMaximum Length:30The credit type of the subscription product. -
CurcyConvRateType: string
Title:
Conversion Rate TypeMaximum Length:30The currency conversion rate type of the subscription product. -
Currency: string
Maximum Length:
15The currency of the subscription product. -
CustomerPONumber: string
Title:
Customer PO NumberMaximum Length:50The customer PO number of the subscription product. -
CustomerTrxTypeSequenceId: integer
(int64)
Title:
SequenceThe customer transaction type sequence ID of the subscription product. -
DefaultRevenueAction: string
Maximum Length:
30The default revenue action of the subscription product. -
DefinitionOrganizationId: integer
(int64)
Title:
Inventory OrganizationThe inventory organization ID of the subscription product. -
Description: string
Title:
Product DescriptionThe description of the subscription product. -
DisplaySequence: number
Title:
Display SequenceThe display sequence of the subscription product. -
DocumentTypeId: integer
(int64)
Title:
Document TypeDefault Value:10The document type ID of the subscription product. -
DropAllowanceFlag: string
Title:
No AllowanceMaximum Length:1Indicates whether allowances should be dropped for the subscription product or not. -
DropOneTimeChargeFlag: boolean
Title:
Don't copy one-time chargesMaximum Length:1Indicates whether one time charges should be dropped for the subscription product or not. -
Duration: integer
Title:
DurationThe duration of the subscription product. -
EarlyTerminationFee: number
Title:
Early Termination FeeThe early termination fee of the subscription product. -
EarlyTerminationPenalty: string
Title:
Early Termination PenaltyMaximum Length:30The early termination penalty of the subscription product. -
EarlyTerminationPenaltyName: string
The early termination penalty name of the subscription product.
-
EnableAdvBipTemplateFlag: boolean
Title:
Enable Advanced ConfigurationMaximum Length:1Default Value:falseEnable Adv Bip Template Flag -
EnablePricingTermsFlag: boolean
Title:
Enable pricing termMaximum Length:1Indicates whether pricing terms should be enabled for the subscription product or not. -
EnableProrateByDay: boolean
Title:
Prorate by dayMaximum Length:1Indicates whether prorate by day should be enabled for the subscription product or not. -
EnableUpfrontBillingFlag: boolean
Title:
Bill immediatelyMaximum Length:1Indicates whether upfront billing should be enabled for the subscription product or not. -
EndDate: string
(date)
Title:
Product End DateThe end date of the subscription product. -
EntitlementPlanDescription: string
Title:
DescriptionThe description of the entitlement plan associated with the product. -
EntitlementPlanId: integer
(int64)
Title:
Entitlement Plan IDThe entitlement plan ID of the subscription product. -
EntitlementPlanName: string
Title:
NameThe name of the entitlement plan associated with the product. -
EntitlementPlanNumber: string
Title:
NumberThe entitlement plan number of the subscription product. -
EntitlementType: string
Title:
Entitlement TypeMaximum Length:30The entitlement type of the subscription product. -
EstimatedTax: number
Title:
Estimated TaxThe estimated tax of the subscription product. -
EstimateFlag: string
Indicates whether estimate type of plan associated with the product.
-
ExemptCertificateNumber: string
Title:
Tax Exemption Certificate NumberMaximum Length:80The exempt certificate number of the subscription product. -
ExemptReason: string
Title:
Exemption ReasonMaximum Length:30The exempt reason of the subscription product. -
ExternalAssetKey: string
Title:
External Asset KeyMaximum Length:120The external asset key of the subscription product. -
ExternalParentAssetKey: string
Title:
External Parent Asset KeyMaximum Length:120The external parent asset key of the subscription product. -
ExternalPriceListId: string
Title:
External Price List IDMaximum Length:120The external price list ID of the subscription product. -
ExternalRootAssetKey: string
Title:
External Root Asset KeyMaximum Length:120The external root asset key of the subscription product. -
GenBillSchReqdFlag: boolean
Title:
Billing schedule update requiredMaximum Length:1Indicates whether generate billing schedule is requested for the subscription product or not. -
GenerateBillFullPeriodFlag: boolean
Title:
Generate billing schedule for full periodMaximum Length:1Indicates whether billing for full period is generated for the subscription product or not. -
GracePeriod: integer
(int64)
Title:
Grace Period in DaysThe grace period of the subscription product. -
GroupingRuleNumberUsed: string
Title:
Grouping Rule NumberMaximum Length:120The grouping rule number used for the subscription product. -
InflightFlag: boolean
Title:
Subscription In-ProcessMaximum Length:1Indicates whether subscription product is inflight or not. -
InstrAssignmentId: integer
(int64)
Title:
Payment Instrument Assignment IDInstr Assignment Id -
InterfaceOffsetDays: integer
(int32)
Title:
Billing Interface Offset DaysThe interface offset days of the subscription product. -
InventoryItemId: integer
(int64)
Title:
Item IDThe inventory item ID of the subscription product. -
InvoiceBipReportCode: string
Title:
BIP Data SourceMaximum Length:30The invoice BIP report code of the subscription product. -
InvoicedAmount: number
Title:
Invoiced AmountThe invoiced amount of the subscription product. -
InvoiceText: string
Title:
Invoice TextMaximum Length:4000The invoice text of the subscription product. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule IdThe invoicing rule ID of the subscription product. -
IsProductCreatedFromAmendFlag: boolean
Indicates whether this subscription product is created from an amendment or not.
-
ItemUnitOfMeasure: string
Title:
Pricing UOM CodeMaximum Length:15The item unit of measure of the subscription product. -
ItemUnitOfMeasureMeaning: string
Title:
Pricing UOMThe item unit of measure meaning of the subscription product. -
LastLifecycleUpdateDate: string
(date-time)
Title:
Last Lifecycle Update DateThe last lifecycle update date of the subscription product. -
LegacyRetrospectiveFlag: string
Maximum Length:
1Indicates whether the subscription product follows legacy retrospective accounting or not. -
LineNumber: string
Title:
Product Line NumberMaximum Length:300The line number of the subscription product. -
MilestoneBasedChargeFlag: boolean
Indicates whether the charges for the subscription product are milestone based or not.
-
MonthlyRecurringRevenue: number
Title:
MRRThe monthly recurring revenue of the subscription product. -
NextBillStartDate: string
(date)
Title:
Next Bill Start DateThe next bill start date of the subscription product. -
NextPricingDate: string
(date)
Title:
Next Pricing DateThe next pricing date of the subscription product. -
OrderFulfillLineId: integer
(int64)
Title:
Order Fulfillment Line IDThe order fulfillment line ID of the subscription product. -
OrderFulfillLineNumber: integer
(int32)
Title:
Order Fulfillment Line NumberThe order fulfillment line number of the subscription product. -
OutputTaxClassification: string
Title:
Output Tax ClassMaximum Length:50The output tax classification of the subscription product. -
OverrideCreditAmount: number
Title:
Override Credit AmountThe override credit amount of the subscription product. -
PaymentMethod: string
Title:
Payment MethodMaximum Length:30The payment method of the subscription product. -
PaymentTermsId: integer
(int64)
Title:
Payment Terms IDThe payment terms ID of the subscription product. -
PaymentTermsName: string
Title:
Payment TermsThe payment terms name of the subscription product. -
PenaltyChargeName: string
The penalty charge name of the subscription product.
-
PenaltyValue: number
Title:
Penalty ValueThe penalty value of the subscription product. -
PendingActivationFlag: boolean
Title:
Pending activationMaximum Length:1Indicates whether activation is pending for the subscription product. -
Period: string
Title:
PeriodThe period of the subscription product. -
PONumber: string
Title:
PO NumberMaximum Length:50The PO number of the subscription product. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment NumberThe prepayment number of the subscription product. -
PriceAdjustmentBasis: string
Title:
Price Adjustment BasisMaximum Length:30The price adjustment basis of the subscription product. -
PriceAdjustmentPercent: number
Title:
Price Adjustment ValueThe price adjustment percentage of the subscription product. -
PriceAdjustmentType: string
Title:
Price Adjustment TypeMaximum Length:30The price adjustment type of the subscription product. -
PriceAsOf: string
(date)
Title:
Price as of DateThe price as of date of the subscription product. -
PriceListId: integer
(int64)
Title:
Price ListThe price list ID of the subscription product. -
PriceListName: string
Title:
Price List NameMaximum Length:120The price list name of the subscription product. -
PriceTransactionOn: string
(date)
Title:
Price Transaction on DateThe price transaction on date of the subscription product. -
PricingError: string
Maximum Length:
2000The pricing error of the subscription product. -
PricingTermsAdjustmentPCT: number
Title:
Pricing Term Adjustment PercentageThe pricing terms adjustment percentage of the subscription product. -
PricingTermsDuration: number
Title:
Pricing Term DurationThe pricing terms duration of the subscription product. -
PricingTermsPeriod: string
Title:
Pricing TermMaximum Length:15The pricing terms period of the subscription product. -
PricingTermsPricingMethod: string
Title:
Pricing MethodMaximum Length:30The pricing terms pricing method of the subscription product. -
PricingTermsStartDate: string
(date)
Title:
Starting OnThe pricing terms start date of the subscription product. -
PrimaryPartyId: integer
(int64)
The primary party ID of the subscription product.
-
ProductChangeReason: string
Title:
Change ReasonMaximum Length:300The product change reason of the subscription product. -
ProductChangeSchedule: string
Title:
Apply ChangeMaximum Length:30The product change schedule of the subscription product. -
ProductChangeScheduleFrom: string
(date)
Title:
Product Change Schedule Effective DateThe product change schedule from of the subscription product. -
ProductFiscClassification: string
Title:
Product Fiscal ClassificationMaximum Length:30The product fiscal classification of the subscription product. -
ProductName: string
Title:
Product NameMaximum Length:300The product name of the subscription product. -
Quantity: number
Title:
QuantityThe quantity of the subscription product. -
QuoteId: integer
(int64)
Title:
Quote IdThe quote ID of the subscription product. -
QuoteLineId: integer
(int64)
Title:
Quote Line IDThe quote line ID of the subscription product. -
RatePlanDocumentId: integer
(int64)
The rate plan document ID of the subscription product.
-
RatePlanId: integer
(int64)
Title:
Rate Plan IDThe rate plan ID of the subscription product. -
RatePlanName: string
Title:
Rate PlanThe rate plan name of the subscription product. -
RatePlanNumber: string
Title:
Rate Plan NumberThe rate plan number of the subscription product. -
RatePlanYn: string
Indicates whether rate plan is applicable for the subscription product or not.
-
RelatedInventoryItemId: integer
(int64)
Title:
Related Inventory Item IDThe related inventory item ID of the subscription product. -
RelatedProductDescription: string
Title:
DescriptionThe related product description of the subscription product. -
RelatedProductName: string
Title:
Product NameMaximum Length:300The related product name of the subscription product. -
RelationShipExistFlag: string
Indicates whether relationships exist for the subscription product.
-
RenewalDuration: integer
(int64)
Title:
Renewal DurationThe renewal duration of the subscription product. -
RenewalDurationPeriod: string
Title:
Renewal PeriodMaximum Length:30The renewal duration period of the subscription product. -
RenewalDurationPeriodName: string
Title:
Renewal PeriodThe renewal duration period name of the subscription product. -
RenewalPaymentMethod: string
Title:
Renewal Payment MethodMaximum Length:30The renewal payment method of the subscription product. -
RenewalPoNumber: string
Title:
Product Renewal PO NumberMaximum Length:50The renewal PO number of the subscription product. -
RenewalPriceListId: integer
(int64)
The renewal price list ID of the subscription product.
-
RenewalPriceListName: string
Title:
Renewal Price ListMaximum Length:255The renewal price list name of the subscription product. -
RenewalRatePlanId: integer
(int64)
The renewal rate plan ID of the subscription product.
-
RenewalRatePlanNumber: string
The renewal rate plan number of the subscription product.
-
RenewalType: string
Title:
Product Renewal TypeMaximum Length:30The renewal type of the subscription product. -
RenewalWireNumber: string
Title:
Product Renewal Wire NumberMaximum Length:30The renewal wire number of the subscription product. -
RenewedDate: string
(date)
Title:
Renewed OnThe renewed date of the subscription product. -
RenewPerpetuallyFlag: boolean
Title:
Renew foreverMaximum Length:1Indicates whether the subscription product should be renewed perpetually or not. -
RenewSourceProductPuid: string
Title:
Renewed Subscription Product PUIDMaximum Length:255Renew Source Product Puid -
RequestedAlignBillingDate: string
(date)
Title:
Requested Align Billing FromThe requested align billing date of the subscription product. -
RequestedEntitlementPlanId: integer
(int64)
Title:
Requested Entitlement Plan IDThe requested entitlement plan ID of the subscription product. -
RequestedEntitlementPlanNumber: string
Title:
Entitlement Plan NumberThe requested entitlement plan number of the subscription product. -
RequestedPriceListId: integer
(int64)
Title:
Override Price ListThe requested price list ID of the subscription product. -
RequestedRatePlanId: integer
(int64)
Title:
Requested Rate Plan IDThe requested rate plan ID of the subscription product. -
RequestedRatePlanNumber: string
The requested rate plan number of the subscription product.
-
RetainSubsOnRenewFlag: boolean
Title:
Don't create new renewal subscriptionMaximum Length:1Indicates whether the subscription product should be retained on renewal or not. -
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30The revenue option of the subscription product. -
SalesOrderId: integer
(int64)
Title:
Sales Order IDThe sales order ID of the subscription product. -
SalesOrderLineId: integer
(int64)
Title:
Sales Order Line IDThe sales order line ID of the subscription product. -
SalesOrderLineNumber: string
Title:
Sales Order Line NumberMaximum Length:100The sales order line number of the subscription product. -
SalesOrderNumber: string
Title:
Sales Order NumberMaximum Length:200The sales order number of the subscription product. -
SalesProductType: string
Title:
TypeMaximum Length:30The sales product type of the subscription product. -
ShipToAccountDescription: string
The ship-to account description of the subscription product.
-
ShipToAccountId: integer
(int64)
Title:
Ship-to Account IDThe ship-to account ID of the subscription product. -
ShipToAccountNumber: string
Title:
Ship-to AccountThe ship-to account number of the subscription product. -
ShipToContactId: integer
(int64)
Title:
Ship-to Contact IDThe ship-to contact ID of the subscription product. -
ShipToContactName: string
Title:
Ship-to ContactThe ship-to contact name of the subscription product. -
ShipToContactNumber: string
Title:
Ship-to Contact NumberThe ship-to contact number of the subscription product. -
ShipToPartyId: integer
(int64)
Title:
Ship-to Party IDThe ship-to party ID of the subscription product. -
ShipToPartyName: string
Title:
Ship-to PartyThe ship-to party name of the subscription product. -
ShipToPartySiteId: integer
(int64)
Title:
Ship-to Party Site IDThe ship-to party site ID of the subscription product. -
ShipToPartySiteNumber: string
Title:
Ship-to Site NumberThe ship-to party site number of the subscription product. -
SourceKey: string
Title:
Source KeyMaximum Length:120The source key of the subscription product. -
SourceLineKey: string
Title:
Source Line KeyMaximum Length:120The source line key of the subscription product. -
SourceLineNumber: string
Title:
External Source Line NumberMaximum Length:120The source line number of the subscription product. -
SourceNumber: string
Title:
External Source NumberMaximum Length:120The source number of the subscription product. -
SourceSystem: string
Title:
Source SystemMaximum Length:30The source system of the subscription product. -
StartDate: string
(date)
Title:
Product Start DateThe start date of the subscription product. -
Status: string
Title:
StatusMaximum Length:30Default Value:DRAFTThe status of the subscription product. -
SubscriptionId: integer
(int64)
The subscription ID of the subscription product.
-
SubscriptionProductId: integer
(int64)
The ID of the subscription product.
-
SubscriptionProductPuid: string
Title:
Subscription Product NumberMaximum Length:120The PUID of the subscription product. -
SubscriptionsEOAccountingRuleId: integer
(int64)
Title:
Accounting RuleThe accounting rule identifier of the subscription. -
SubscriptionsEOApprovalNote: string
Maximum Length:
240The approval note of the subscription. -
SubscriptionsEOApprovedDate: string
(date)
The approved date of the subscription.
-
SubscriptionsEOAssigneeId: integer
(int64)
The assignee ID of the subscription.
-
SubscriptionsEOAssigneeType: string
Maximum Length:
30The assignee type of the subscription. -
SubscriptionsEOBillingDateCode: string
Maximum Length:
30The billing date code of the subscription. -
SubscriptionsEOBillingFrequency: string
Maximum Length:
30The billing frequency of the subscription. -
SubscriptionsEOBillingOffsetDays: integer
(int64)
The billing offset days of the subscription.
-
SubscriptionsEOBillingSystem: string
Maximum Length:
120The billing system of the subscription. -
SubscriptionsEOBillOnDay: number
The bill on day of the subscription.
-
SubscriptionsEOBillService: string
Title:
Bill Service NameMaximum Length:30The bill service of the subscription. -
SubscriptionsEOBillToAccountId: integer
(int64)
Title:
Billing AccountThe unique identifier of the bill-to account of the subscription. -
SubscriptionsEOBillToAccountNumber: string
The bill-to account number of the subscription.
-
SubscriptionsEOBillToContactId: integer
(int64)
The unique identifier of the bill-to contact of the subscription.
-
SubscriptionsEOBillToContactNumber: string
The bill-to contact number of the subscription.
-
SubscriptionsEOBillToPartyId: integer
(int64)
The unique identifier of the bill-to party of the subscription.
-
SubscriptionsEOBillToPartyNumber: string
The bill-to party number of the subscription.
-
SubscriptionsEOBillToSiteNumber: string
The alternate unique identifier of the bill-to site number of the subscription.
-
SubscriptionsEOBillToSiteUseId: integer
(int64)
Title:
Bill-to SiteThe unique identifier bill-to site use of the subscription. -
SubscriptionsEOBusinessUnitId: integer
(int64)
The business unit identifier of the subscription.
-
SubscriptionsEOCalculatedCreditAmount: number
The calculated credit amount of the subscription.
-
SubscriptionsEOCancelDescription: string
Title:
Cancellation DescriptionMaximum Length:2000The cancel description of the subscription. -
SubscriptionsEOCanceledAmount: number
The canceled amount of the subscription.
-
SubscriptionsEOCanceledDate: string
(date)
The date when the subscription was canceled.
-
SubscriptionsEOCancelReason: string
Maximum Length:
30The cancel reason of the subscription. -
SubscriptionsEOCloseCreditMethod: string
Maximum Length:
30The close credit method of the subscription. -
SubscriptionsEOClosedAmount: number
The closed amount of the subscription.
-
SubscriptionsEOClosedDate: string
(date)
The date when the subscription was closed.
-
SubscriptionsEOCloseDescription: string
Title:
Close DescriptionMaximum Length:2000The close description of the subscription. -
SubscriptionsEOCloseReason: string
Maximum Length:
30The reason the subscription was closed. -
SubscriptionsEOCommunicationChannel: string
Title:
Communication ChannelMaximum Length:30The communication channel of the subscription. -
SubscriptionsEOCorpCurrencyCode: string
Maximum Length:
15The corporate currency code of the subscription. -
SubscriptionsEOCoverageInvoiceText: string
Maximum Length:
4000The coverage invoice text of the subscription. -
SubscriptionsEOCreditedAmount: number
The credited amount of the subscription.
-
SubscriptionsEOCurcyConvRateType: string
Maximum Length:
30The currency conversion rate type of the subscription. -
SubscriptionsEOCurrency: string
Maximum Length:
15The currency of the subscription. -
SubscriptionsEOCurrencyConversionRate: string
Maximum Length:
30The currency conversion rate of the subscription. -
SubscriptionsEOCurrencyConversionRateDate: string
(date)
The currency conversion rate date of the subscription.
-
SubscriptionsEOCurrencyConversionRateType: string
Maximum Length:
30The currency conversion rate type of the subscription. -
SubscriptionsEOCustomerAcceptance: string
Title:
Customer AcceptanceMaximum Length:30The customer acceptance of the subscription. -
SubscriptionsEOCustomerTrxTypeSequenceId: integer
(int64)
The customer transaction type sequence identifier of the subscription.
-
SubscriptionsEODaysBeforeExpiry: integer
(int64)
The number of days before expiry of the subscription.
-
SubscriptionsEODaysBeforeExpiryUsed: string
Maximum Length:
18The number of used days before expiry of the subscription. -
SubscriptionsEODefinitionOrganizationCode: string
The inventory organization code of the subscription.
-
SubscriptionsEODefinitionOrganizationId: integer
(int64)
The inventory organization identifier of the subscription.
-
SubscriptionsEODescription: string
Maximum Length:
1995The description of the subscription. -
SubscriptionsEODocumentFiscalClassification: string
Maximum Length:
30The document fiscal classification of the subscription. -
SubscriptionsEOEnableRenewalRemindersFlag: boolean
Title:
Enable renewal remindersMaximum Length:1Indicates whether renewal reminders are enabled for the subscription. -
SubscriptionsEOEndDate: string
(date)
The end date of the subscription.
-
SubscriptionsEOEstimatedTax: number
The estimated tax of the subscription.
-
SubscriptionsEOExemptCertificateNumber: string
Maximum Length:
80The exempt certificate number of the subscription. -
SubscriptionsEOExemptReason: string
Maximum Length:
30The exempt reason of the subscription. -
SubscriptionsEOFreezePriceFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether price is frozen for the subscription. -
SubscriptionsEOInternalApproval: string
Title:
Internal ApprovalMaximum Length:30The internal approver indicator of the subscription. -
SubscriptionsEOInvoicedAmount: number
The invoiced amount of the subscription.
-
SubscriptionsEOInvoicingRuleId: integer
(int64)
The invoicing rule ID of the subscription.
-
SubscriptionsEOLayoutTemplate: string
Title:
Contract Layout TemplateMaximum Length:200The layout template of the subscription. -
SubscriptionsEOLegalEntityId: integer
(int64)
The legal entity ID of the subscription.
-
SubscriptionsEOLineAutonumberEnabledYnFlag: boolean
Maximum Length:
1Indicates whether automatic numbering is enabled for lines of the subscription. -
SubscriptionsEONegotiationLanguage: string
Title:
LanguageMaximum Length:4The negotiation language of the subscription. -
SubscriptionsEONotificationTemplateId: integer
The notification template ID of the subscription.
-
SubscriptionsEOOrderLineOperationCode: string
Title:
Action CodeMaximum Length:80Order Line Operation Code -
SubscriptionsEOOverrideCreditAmount: number
The override credit amount of the subscription.
-
SubscriptionsEOPartialPeriodStart: string
Maximum Length:
30The partial period start of the subscription. -
SubscriptionsEOPartialPeriodType: string
Maximum Length:
30The partial period type of the subscription. -
SubscriptionsEOPaymentMethod: string
Maximum Length:
30The payment method of the subscription. -
SubscriptionsEOPaymentTermsId: integer
(int64)
The payment terms ID of the subscription.
-
SubscriptionsEOPONumber: string
Maximum Length:
50The PO number of the subscription. -
SubscriptionsEOPriceAdjustmentPercentUsed: number
The price adjustment percentage used for the subscription.
-
SubscriptionsEOPricedOnDate: string
(date-time)
Title:
Price as of DateThe priced on date of the subscription. -
SubscriptionsEOPricingError: string
Maximum Length:
2000The pricing error of the subscription. -
SubscriptionsEOPricingSegment: string
Maximum Length:
30The pricing segment of the subscription. -
SubscriptionsEOPricingSegmentExplanation: string
Maximum Length:
1000The pricing segment explanation of the subscription. -
SubscriptionsEOPricingStrategyExplanation: string
Maximum Length:
1000The pricing strategy explanation of the subscription. -
SubscriptionsEOPricingStrategyId: integer
(int64)
The pricing strategy ID of the subscription.
-
SubscriptionsEOPricingSystem: string
Maximum Length:
30The pricing system of the subscription. -
SubscriptionsEOPrimaryPartyId: integer
(int64)
The primary party ID of the subscription.
-
SubscriptionsEOPrimaryPartyNumber: string
The primary party number of the subscription.
-
SubscriptionsEOPrimarySalesPerson: integer
(int64)
The primary sales person of the subscription.
-
SubscriptionsEOPrimarySalesPersonNumber: string
The primary sales person number of the subscription.
-
SubscriptionsEOQuoteId: integer
(int64)
Title:
Quote IdThe quote ID of the subscription. -
SubscriptionsEOQuoteToCcEmail: string
Title:
Copy ToMaximum Length:2000The quote-to CC email of the subscription. -
SubscriptionsEOQuoteToContactId: integer
(int64)
Title:
Contact NameThe quote to contact ID of the subscription. -
SubscriptionsEOQuoteToContactNumber: string
The quote to contact number of the subscription.
-
SubscriptionsEORenewalCustomerAcceptance: string
Title:
Renewal Customer AcceptanceMaximum Length:30The renewal customer acceptance of the subscription. -
SubscriptionsEORenewalDuration: integer
(int64)
Title:
Renewal DurationThe renewal duration of the subscription. -
SubscriptionsEORenewalDurationPeriod: string
Maximum Length:
30The renewal duration period of the subscription. -
SubscriptionsEORenewalInternalApproval: string
Title:
Renewal Internal ApprovalMaximum Length:30The renewal internal approval of the subscription. -
SubscriptionsEORenewalPaymentMethod: string
Maximum Length:
30The renewal payment method of the subscription. -
SubscriptionsEORenewalPONumber: string
Maximum Length:
50The renewal PO number of the subscription. -
SubscriptionsEORenewalPriceAdjustmentBasis: string
Title:
Price Adjustment BasisMaximum Length:30The price adjustment basis of the subscription. -
SubscriptionsEORenewalPriceAdjustmentPercent: number
Title:
Price Adjustment ValueThe price adjustment percentage of the subscription. -
SubscriptionsEORenewalPriceAdjustmentType: string
Title:
Price Adjustment TypeMaximum Length:30The price adjustment type of the subscription. -
SubscriptionsEORenewalPricingMethodUsed: string
Maximum Length:
30The pricing method used for the subscription. -
SubscriptionsEORenewalProcess: string
Title:
Renewal ProcessMaximum Length:30The renewal process of the subscription. -
SubscriptionsEORenewalProcessUsed: string
Maximum Length:
30The renewal process used for the subscription. -
SubscriptionsEORenewalSubscriptionProfileId: integer
The renewal subscription profile ID of the subscription.
-
SubscriptionsEORenewalTemplateId: integer
The renewal template ID of the subscription.
-
SubscriptionsEORenewalWireNumber: string
Maximum Length:
30The renewal wire number of the subscription. -
SubscriptionsEORenewedDate: string
(date)
The renewal date of the subscription.
-
SubscriptionsEORenewPerpetuallyFlag: boolean
Maximum Length:
1Indicates whether the subscription should be renewed perpetually or not. -
SubscriptionsEORetainSubsOnRenewFlag: boolean
Maximum Length:
1Indicates whether the subscription should be retained on renewal or not. -
SubscriptionsEOSalesOrderId: integer
(int64)
The sales order ID of the subscription.
-
SubscriptionsEOSalesOrderNumber: string
Maximum Length:
200The sales order number of the subscription. -
SubscriptionsEOSegmentExplanationMessage: string
Maximum Length:
30The segment explanation message of the subscription. -
SubscriptionsEOShipToAccountId: integer
(int64)
The ship-to account ID of the subscription.
-
SubscriptionsEOShipToAccountNumber: string
Title:
Ship-to AccountThe ship-to account number of the subscription. -
SubscriptionsEOShipToContactId: integer
(int64)
The ship-to contact ID of the subscription.
-
SubscriptionsEOShipToContactNumber: string
The ship-to contact number of the subscription.
-
SubscriptionsEOShipToParty: integer
(int64)
Title:
Ship-to PartyThe ship-to party of the subscription. -
SubscriptionsEOShipToPartyNumber: string
The ship-to party number of the subscription.
-
SubscriptionsEOShipToPartySiteId: integer
(int64)
Title:
Ship-to SiteThe ship-to party site ID of the subscription. -
SubscriptionsEOShipToSiteNumber: string
The ship-to site number of the subscription.
-
SubscriptionsEOShortDescription: string
Maximum Length:
600The short description of the subscription. -
SubscriptionsEOSkipConsolidationFlag: boolean
Maximum Length:
1Indicates whether renewal consolidation should be skipped for the subscription. -
SubscriptionsEOSourceKey: string
Maximum Length:
120The source key of the subscription. -
SubscriptionsEOSourceNumber: string
Maximum Length:
120The source number of the subscription. -
SubscriptionsEOSourceSystem: string
Maximum Length:
30The source system of the subscription. -
SubscriptionsEOStartDate: string
(date)
The start date of the subscription.
-
SubscriptionsEOStatus: string
Maximum Length:
30Default Value:DRAFTThe status of the subscription. -
SubscriptionsEOSubscriptionId: integer
(int64)
The ID of the subscription.
-
SubscriptionsEOSubscriptionInvoiceText: string
Maximum Length:
4000The invoice text of the subscription. -
SubscriptionsEOSubscriptionNumber: string
Maximum Length:
120The subscription number. -
SubscriptionsEOSubscriptionProfileId: integer
(int64)
The profile ID associated with the subscription.
-
SubscriptionsEOSubscriptionProfileName: string
Maximum Length:
255The profile name associated with the subscription. -
SubscriptionsEOSystemAction: string
Maximum Length:
30The system action of the subscription. -
SubscriptionsEOSystemActionDate: string
(date-time)
The system action date of the subscription.
-
SubscriptionsEOSystemActionObject: string
Maximum Length:
30The system action object of the subscription. -
SubscriptionsEOSystemActionObjectKey: string
Maximum Length:
300The system action object key of the subscription. -
SubscriptionsEOSystemActionRequestId: integer
(int64)
The system action request ID of the subscription.
-
SubscriptionsEOSystemActionStatus: string
Maximum Length:
30The system action status of the subscription. -
SubscriptionsEOTaxClassificationCode: string
Maximum Length:
50The tax classification code of the subscription. -
SubscriptionsEOTaxExemptionHandling: string
Maximum Length:
30The tax exemption handling of the subscription. -
SubscriptionsEOTcvWithTotalUsageCharge: number
The total contract value with total usage charges of the subscription.
-
SubscriptionsEOTotalContractValue: number
Title:
Total Contract ValueThe total contract value of the subscription. -
SubscriptionsEOTotalUsageCharge: number
The total usage charge of the subscription.
-
SubscriptionsEOTransactionTypeName: string
Maximum Length:
80The transaction type name of the subscription. -
SubscriptionsEOUsageCapture: string
Maximum Length:
30The usage capture mode of the subscription. -
SubscriptionsEOUsageInvoiceLayoutTemplate: string
Maximum Length:
200The usage invoice layout template of the subscription. -
SubscriptionsEOUserStatus: string
Maximum Length:
30The user status of the subscription. -
SubscriptionsEOWarehouseId: integer
(int64)
The warehouse ID of the subscription.
-
SubscriptionsEOWarrantyYN: string
Maximum Length:
1Indicates whether the subscription is included warranty or not. -
SubscriptionsEOWireNumber: string
Maximum Length:
30The wire number of the subscription. -
SummarizedBillingFlag: boolean
Title:
Summarized billingMaximum Length:1Indicates whether summarized billing is required for the subscription product. -
SuspendCreditMethod: string
Title:
Suspend Credit MethodMaximum Length:30The suspend credit method of the subscription product. -
SuspendedDate: string
(date)
Title:
Suspend DateThe suspended date of the subscription product. -
SuspendReason: string
Title:
Suspend ReasonMaximum Length:30The suspend reason of the subscription product. -
TaxError: string
Title:
Tax ErrorMaximum Length:2000The tax error of the subscription product. -
TaxExemptionHandling: string
Title:
Tax Exemption HandlingMaximum Length:30The tax exemption handling of the subscription product. -
TaxExemptionHandlingName: string
The tax exemption handling of the subscription product.
-
TotalContractValue: number
Title:
Product Contract ValueThe total contract value of the subscription product. -
TransactionTypeName: string
Title:
Transaction TypeMaximum Length:30The transaction type name of the subscription product. -
TrxnExtensionId: integer
(int64)
Title:
Transaction Extension IDTrxn Extension Id -
UnitPrice: number
The unit price of the subscription product.
-
UpdateFlag: boolean
The update indicator of the subscription product.
-
UsageEventAllowanceInvTemplate: string
Title:
AllowanceMaximum Length:200The template to show allowance details of the subscription product usage events. -
UsageEventCommitmentInvTemplate: string
Title:
CommitmentMaximum Length:200The template to show commitment details of the subscription product usage events. -
UsageEventEstimateInvTemplate: string
Title:
EstimateMaximum Length:200The template to show estimate details of the subscription product usage events. -
UsageEventRegularInvTemplate: string
Title:
BasicMaximum Length:200The template to show regular details of the subscription product usage events. -
UsageInvoiceLayoutTemplate: string
Title:
BIP TemplateMaximum Length:200The usage invoice layout template of the subscription product. -
WarehouseId: integer
(int64)
Title:
WarehouseThe warehouse ID of the subscription product. -
WireNumber: string
Title:
Wire NumberMaximum Length:30The wire number of the subscription product.
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 : subscriptionProductsGroupingAssignments-item-response
Type:
Show Source
object-
AccountingRuleId: integer
(int64)
Title:
Accounting Rule IDThe accounting rule ID of the subscription product. -
AlignBillingDay: number
Title:
Align Billing DayThe align billing day of the subscription product. -
AlignBillingFrom: string
(date)
Title:
Align Billing FromThe align billing from of the subscription product. -
AmendSourceProductPuid: string
Title:
Amended Subscription Product PUIDMaximum Length:255Amend Source Product Puid -
AsyncFlag: boolean
Read Only:
trueIndicates whether the subscription product is being processed asynchronously. -
AttachToSubscriptionNumber: string
Maximum Length:
255The subscription number to which the product will be attached to. -
BalanceFirstPartialPeriodOption: string
Title:
Balance First Partial Period OptionMaximum Length:30Option to follow for balance management for first partial period. -
BalanceLastPartialPeriodOption: string
Title:
Balance Last Partial Period OptionMaximum Length:30Option to follow for balance management for last partial period. -
BalanceManagementError: string
Title:
Balance Management ErrorMaximum Length:2000The balance management error of the subscription product. -
BalanceProfileName: string
Title:
Profile NameThe name of the balance profile associated with the product. -
BalanceRegisterId: integer
(int64)
Title:
Balance Register IDThe balance register ID of the subscription product. -
BalanceRegisterNumber: string
Title:
Register NumberRead Only:trueMaximum Length:255The balance register number of the subscription product. -
BalanceTerminatedPartialPeriodOption: string
Title:
Balance Terminated Partial Period OptionMaximum Length:30Option to follow for balance management for terminated partial period. -
BatchTag: string
Title:
Batch TagMaximum Length:30The batch tag of the subscription product. -
BillingDateCode: string
Title:
Billing DateMaximum Length:30The billing date code of the subscription product. -
BillingFrequency: string
Title:
Billing FrequencyMaximum Length:30The billing frequency of the subscription product. -
BillingOffsetDays: integer
(int64)
Title:
Billing Offset DaysThe billing offset days of the subscription product. -
BillOnDay: number
Title:
Bill on DayThe bill on day of the subscription product. -
BillToAccountDescription: string
The bill-to account description of the subscription product.
-
BillToAccountId: integer
(int64)
Title:
Account IdThe bill-to account ID of the subscription product. -
BillToAccountNumber: string
Title:
Billing AccountMaximum Length:30The bill-to account number of the subscription product. -
BillToContactId: integer
(int64)
Title:
Bill-to Contact IDThe bill-to contact ID of the subscription product. -
BillToContactNumber: string
Title:
Bill-to Contact NumberThe bill-to contact number of the subscription product. -
BillToPartyId: integer
(int64)
Title:
Bill-to Party IDThe bill-to party ID of the subscription product. -
BillToPartyName: string
Title:
Bill-to CustomerRead Only:trueMaximum Length:360The bill-to party name of the subscription product. -
BillToPartyNumber: string
Title:
Bill-to Party NumberRead Only:trueMaximum Length:30The bill-to party number of the subscription product. -
BillToSite: string
Title:
Bill-to SiteThe bill-to site of the subscription product. -
BillToSiteName: string
Title:
Bill-to SiteMaximum Length:255The bill-to site name of the subscription product. -
BillToSiteNumber: string
Title:
Bill-to Site NumberThe bill-to site number of the subscription product. -
BillToSiteUseId: integer
(int64)
Title:
Site Use IdThe bill-to site use ID of the subscription product. -
CalculatedCreditAmount: number
Title:
Calculated Credit AmountThe calculated credit amount of the subscription product. -
CalculateEstimatedTaxFlag: boolean
Indicates whether estimated tax for the subscription product should be calculated or not.
-
CancelDescription: string
Title:
Cancellation DescriptionMaximum Length:2000The cancel description of the subscription product. -
CanceledAmount: number
Title:
Canceled AmountThe canceled amount of the subscription product. -
CanceledDate: string
(date)
Title:
Product Canceled DateThe canceled date of the subscription product. -
CancelReason: string
Title:
Cancellation ReasonMaximum Length:30The cancel reason of the subscription product. -
ChargeRulesFlag: string
Title:
Charge RulesIndicates whether volume pricing rule is associated with the subscription product. -
CheckActiveExpiredAssetsExists: string
Indicates whether active or expired assets exist for the subscription product.
-
CheckHoldAssetsExists: string
Indicates whether assets on hold exist for the subscription product.
-
ChurnPredictionTrend: integer
(int32)
Title:
Churn Prediction TrendThe churn prediction trend of the subscription product. -
ChurnProbability: number
Title:
Churn ProbabilityThe churn probability of the subscription product. -
CloseCreditMethod: string
Title:
Close Credit MethodMaximum Length:30The close credit method of the subscription product. -
ClosedAmount: number
Title:
Closed AmountThe close amount of the subscription product. -
ClosedDate: string
(date)
Title:
Product Close DateThe closed date of the subscription product. -
CloseDescription: string
Title:
Close DescriptionMaximum Length:2000The close description of the subscription product. -
CloseReason: string
Title:
Product Close ReasonMaximum Length:30The close reason of the subscription product. -
CommitmentFlag: string
Indicates whether commitment type of plan associated with the product.
-
CorpCurrencyCode: string
Title:
Currency CodeMaximum Length:15The corporate currency code of the subscription product. -
CoverageName: string
Title:
Template NameThe coverage name of the subscription product. -
CoverageScheduleId: integer
(int64)
Title:
Coverage Schedule IDThe coverage schedule ID of the subscription product. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the subscription product. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the subscription product was created. -
CreditedAmount: number
Title:
Credited AmountThe credited amount of the subscription product. -
CreditType: string
Title:
Credit TypeMaximum Length:30The credit type of the subscription product. -
CurcyConvRateType: string
Title:
Conversion Rate TypeMaximum Length:30The currency conversion rate type of the subscription product. -
Currency: string
Maximum Length:
15The currency of the subscription product. -
CustomerPONumber: string
Title:
Customer PO NumberMaximum Length:50The customer PO number of the subscription product. -
CustomerTrxTypeSequenceId: integer
(int64)
Title:
SequenceThe customer transaction type sequence ID of the subscription product. -
DefaultRevenueAction: string
Maximum Length:
30The default revenue action of the subscription product. -
DefinitionOrganizationId: integer
(int64)
Title:
Inventory OrganizationThe inventory organization ID of the subscription product. -
Description: string
Title:
Product DescriptionThe description of the subscription product. -
DisplaySequence: number
Title:
Display SequenceThe display sequence of the subscription product. -
DocumentTypeId: integer
(int64)
Title:
Document TypeDefault Value:10The document type ID of the subscription product. -
DropAllowanceFlag: string
Title:
No AllowanceMaximum Length:1Indicates whether allowances should be dropped for the subscription product or not. -
DropOneTimeChargeFlag: boolean
Title:
Don't copy one-time chargesMaximum Length:1Indicates whether one time charges should be dropped for the subscription product or not. -
Duration: integer
Title:
DurationThe duration of the subscription product. -
EarlyTerminationFee: number
Title:
Early Termination FeeThe early termination fee of the subscription product. -
EarlyTerminationPenalty: string
Title:
Early Termination PenaltyMaximum Length:30The early termination penalty of the subscription product. -
EarlyTerminationPenaltyName: string
The early termination penalty name of the subscription product.
-
EnableAdvBipTemplateFlag: boolean
Title:
Enable Advanced ConfigurationMaximum Length:1Default Value:falseEnable Adv Bip Template Flag -
EnablePricingTermsFlag: boolean
Title:
Enable pricing termMaximum Length:1Indicates whether pricing terms should be enabled for the subscription product or not. -
EnableProrateByDay: boolean
Title:
Prorate by dayMaximum Length:1Indicates whether prorate by day should be enabled for the subscription product or not. -
EnableUpfrontBillingFlag: boolean
Title:
Bill immediatelyMaximum Length:1Indicates whether upfront billing should be enabled for the subscription product or not. -
EndDate: string
(date)
Title:
Product End DateThe end date of the subscription product. -
EntitlementPlanDescription: string
Title:
DescriptionThe description of the entitlement plan associated with the product. -
EntitlementPlanId: integer
(int64)
Title:
Entitlement Plan IDThe entitlement plan ID of the subscription product. -
EntitlementPlanName: string
Title:
NameThe name of the entitlement plan associated with the product. -
EntitlementPlanNumber: string
Title:
NumberThe entitlement plan number of the subscription product. -
EntitlementType: string
Title:
Entitlement TypeMaximum Length:30The entitlement type of the subscription product. -
EstimatedTax: number
Title:
Estimated TaxThe estimated tax of the subscription product. -
EstimateFlag: string
Indicates whether estimate type of plan associated with the product.
-
ExemptCertificateNumber: string
Title:
Tax Exemption Certificate NumberMaximum Length:80The exempt certificate number of the subscription product. -
ExemptReason: string
Title:
Exemption ReasonMaximum Length:30The exempt reason of the subscription product. -
ExternalAssetKey: string
Title:
External Asset KeyMaximum Length:120The external asset key of the subscription product. -
ExternalParentAssetKey: string
Title:
External Parent Asset KeyMaximum Length:120The external parent asset key of the subscription product. -
ExternalPriceListId: string
Title:
External Price List IDMaximum Length:120The external price list ID of the subscription product. -
ExternalRootAssetKey: string
Title:
External Root Asset KeyMaximum Length:120The external root asset key of the subscription product. -
GenBillSchReqdFlag: boolean
Title:
Billing schedule update requiredMaximum Length:1Indicates whether generate billing schedule is requested for the subscription product or not. -
GenerateBillFullPeriodFlag: boolean
Title:
Generate billing schedule for full periodMaximum Length:1Indicates whether billing for full period is generated for the subscription product or not. -
GracePeriod: integer
(int64)
Title:
Grace Period in DaysThe grace period of the subscription product. -
GroupingRuleNumberUsed: string
Title:
Grouping Rule NumberMaximum Length:120The grouping rule number used for the subscription product. -
InflightFlag: boolean
Title:
Subscription In-ProcessMaximum Length:1Indicates whether subscription product is inflight or not. -
InstrAssignmentId: integer
(int64)
Title:
Payment Instrument Assignment IDInstr Assignment Id -
InterfaceOffsetDays: integer
(int32)
Title:
Billing Interface Offset DaysThe interface offset days of the subscription product. -
InventoryItemId: integer
(int64)
Title:
Item IDThe inventory item ID of the subscription product. -
InvoiceBipReportCode: string
Title:
BIP Data SourceMaximum Length:30The invoice BIP report code of the subscription product. -
InvoicedAmount: number
Title:
Invoiced AmountThe invoiced amount of the subscription product. -
InvoiceText: string
Title:
Invoice TextMaximum Length:4000The invoice text of the subscription product. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule IdThe invoicing rule ID of the subscription product. -
IsProductCreatedFromAmendFlag: boolean
Indicates whether this subscription product is created from an amendment or not.
-
ItemUnitOfMeasure: string
Title:
Pricing UOM CodeMaximum Length:15The item unit of measure of the subscription product. -
ItemUnitOfMeasureMeaning: string
Title:
Pricing UOMThe item unit of measure meaning of the subscription product. -
LastLifecycleUpdateDate: string
(date-time)
Title:
Last Lifecycle Update DateThe last lifecycle update date of the subscription product. -
LastUpdateDate: string
(date-time)
Title:
Line Last Update DateRead Only:trueThe last update date of the subscription product. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The last updated by of the subscription product. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The last update login of the subscription product. -
LegacyRetrospectiveFlag: string
Maximum Length:
1Indicates whether the subscription product follows legacy retrospective accounting or not. -
LineNumber: string
Title:
Product Line NumberMaximum Length:300The line number of the subscription product. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MilestoneBasedChargeFlag: boolean
Indicates whether the charges for the subscription product are milestone based or not.
-
MonthlyRecurringRevenue: number
Title:
MRRThe monthly recurring revenue of the subscription product. -
NextBillStartDate: string
(date)
Title:
Next Bill Start DateThe next bill start date of the subscription product. -
NextPricingDate: string
(date)
Title:
Next Pricing DateThe next pricing date of the subscription product. -
OrderFulfillLineId: integer
(int64)
Title:
Order Fulfillment Line IDThe order fulfillment line ID of the subscription product. -
OrderFulfillLineNumber: integer
(int32)
Title:
Order Fulfillment Line NumberThe order fulfillment line number of the subscription product. -
OriginalSubscriptionProductPuid: string
Read Only:
trueMaximum Length:240The original subscription product PUID of the subscription product. -
OutputTaxClassification: string
Title:
Output Tax ClassMaximum Length:50The output tax classification of the subscription product. -
OverrideCreditAmount: number
Title:
Override Credit AmountThe override credit amount of the subscription product. -
PaymentMethod: string
Title:
Payment MethodMaximum Length:30The payment method of the subscription product. -
PaymentTermsId: integer
(int64)
Title:
Payment Terms IDThe payment terms ID of the subscription product. -
PaymentTermsName: string
Title:
Payment TermsThe payment terms name of the subscription product. -
PenaltyChargeName: string
The penalty charge name of the subscription product.
-
PenaltyValue: number
Title:
Penalty ValueThe penalty value of the subscription product. -
PendingActivationFlag: boolean
Title:
Pending activationMaximum Length:1Indicates whether activation is pending for the subscription product. -
Period: string
Title:
PeriodThe period of the subscription product. -
PmProgramId: integer
(int64)
Title:
Preventive Maintenance Program IDRead Only:trueThe preventive maintenance program ID of the subscription product. -
PONumber: string
Title:
PO NumberMaximum Length:50The PO number of the subscription product. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment NumberThe prepayment number of the subscription product. -
PriceAdjustmentBasis: string
Title:
Price Adjustment BasisMaximum Length:30The price adjustment basis of the subscription product. -
PriceAdjustmentPercent: number
Title:
Price Adjustment ValueThe price adjustment percentage of the subscription product. -
PriceAdjustmentType: string
Title:
Price Adjustment TypeMaximum Length:30The price adjustment type of the subscription product. -
PriceAsOf: string
(date)
Title:
Price as of DateThe price as of date of the subscription product. -
PriceListId: integer
(int64)
Title:
Price ListThe price list ID of the subscription product. -
PriceListName: string
Title:
Price List NameMaximum Length:120The price list name of the subscription product. -
PriceTransactionOn: string
(date)
Title:
Price Transaction on DateThe price transaction on date of the subscription product. -
PricingError: string
Maximum Length:
2000The pricing error of the subscription product. -
PricingTermsAdjustmentPCT: number
Title:
Pricing Term Adjustment PercentageThe pricing terms adjustment percentage of the subscription product. -
PricingTermsDuration: number
Title:
Pricing Term DurationThe pricing terms duration of the subscription product. -
PricingTermsPeriod: string
Title:
Pricing TermMaximum Length:15The pricing terms period of the subscription product. -
PricingTermsPricingMethod: string
Title:
Pricing MethodMaximum Length:30The pricing terms pricing method of the subscription product. -
PricingTermsStartDate: string
(date)
Title:
Starting OnThe pricing terms start date of the subscription product. -
PrimaryPartyId: integer
(int64)
The primary party ID of the subscription product.
-
PrimaryPartyName: string
Title:
CustomerRead Only:trueMaximum Length:255The primary party name of the subscription product. -
ProductChangeReason: string
Title:
Change ReasonMaximum Length:300The product change reason of the subscription product. -
ProductChangeSchedule: string
Title:
Apply ChangeMaximum Length:30The product change schedule of the subscription product. -
ProductChangeScheduleFrom: string
(date)
Title:
Product Change Schedule Effective DateThe product change schedule from of the subscription product. -
ProductChangeSequenceNumber: integer
Read Only:
trueProduct Change Sequence Number -
ProductFiscClassification: string
Title:
Product Fiscal ClassificationMaximum Length:30The product fiscal classification of the subscription product. -
ProductName: string
Title:
Product NameMaximum Length:300The product name of the subscription product. -
Quantity: number
Title:
QuantityThe quantity of the subscription product. -
QuoteId: integer
(int64)
Title:
Quote IdThe quote ID of the subscription product. -
QuoteLineId: integer
(int64)
Title:
Quote Line IDThe quote line ID of the subscription product. -
RatePlanDocumentId: integer
(int64)
The rate plan document ID of the subscription product.
-
RatePlanId: integer
(int64)
Title:
Rate Plan IDThe rate plan ID of the subscription product. -
RatePlanName: string
Title:
Rate PlanThe rate plan name of the subscription product. -
RatePlanNumber: string
Title:
Rate Plan NumberThe rate plan number of the subscription product. -
RatePlanYn: string
Indicates whether rate plan is applicable for the subscription product or not.
-
RelatedInventoryItemId: integer
(int64)
Title:
Related Inventory Item IDThe related inventory item ID of the subscription product. -
RelatedProductDescription: string
Title:
DescriptionThe related product description of the subscription product. -
RelatedProductName: string
Title:
Product NameMaximum Length:300The related product name of the subscription product. -
RelationShipExistFlag: string
Indicates whether relationships exist for the subscription product.
-
RenewalDuration: integer
(int64)
Title:
Renewal DurationThe renewal duration of the subscription product. -
RenewalDurationPeriod: string
Title:
Renewal PeriodMaximum Length:30The renewal duration period of the subscription product. -
RenewalDurationPeriodName: string
Title:
Renewal PeriodThe renewal duration period name of the subscription product. -
RenewalPaymentMethod: string
Title:
Renewal Payment MethodMaximum Length:30The renewal payment method of the subscription product. -
RenewalPoNumber: string
Title:
Product Renewal PO NumberMaximum Length:50The renewal PO number of the subscription product. -
RenewalPriceListId: integer
(int64)
The renewal price list ID of the subscription product.
-
RenewalPriceListName: string
Title:
Renewal Price ListMaximum Length:255The renewal price list name of the subscription product. -
RenewalRatePlanId: integer
(int64)
The renewal rate plan ID of the subscription product.
-
RenewalRatePlanNumber: string
The renewal rate plan number of the subscription product.
-
RenewalSequenceNumber: integer
Read Only:
trueThe renewal sequence number of the subscription product. -
RenewalType: string
Title:
Product Renewal TypeMaximum Length:30The renewal type of the subscription product. -
RenewalWireNumber: string
Title:
Product Renewal Wire NumberMaximum Length:30The renewal wire number of the subscription product. -
RenewedDate: string
(date)
Title:
Renewed OnThe renewed date of the subscription product. -
RenewPerpetuallyFlag: boolean
Title:
Renew foreverMaximum Length:1Indicates whether the subscription product should be renewed perpetually or not. -
RenewSourceProductPuid: string
Title:
Renewed Subscription Product PUIDMaximum Length:255Renew Source Product Puid -
RequestedAlignBillingDate: string
(date)
Title:
Requested Align Billing FromThe requested align billing date of the subscription product. -
RequestedEntitlementPlanId: integer
(int64)
Title:
Requested Entitlement Plan IDThe requested entitlement plan ID of the subscription product. -
RequestedEntitlementPlanNumber: string
Title:
Entitlement Plan NumberThe requested entitlement plan number of the subscription product. -
RequestedPriceListId: integer
(int64)
Title:
Override Price ListThe requested price list ID of the subscription product. -
RequestedRatePlanId: integer
(int64)
Title:
Requested Rate Plan IDThe requested rate plan ID of the subscription product. -
RequestedRatePlanNumber: string
The requested rate plan number of the subscription product.
-
RetainSubsOnRenewFlag: boolean
Title:
Don't create new renewal subscriptionMaximum Length:1Indicates whether the subscription product should be retained on renewal or not. -
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30The revenue option of the subscription product. -
RevenueOptionClose: string
Read Only:
trueMaximum Length:30The revenue option selected for the last close operation. -
SalesOrderId: integer
(int64)
Title:
Sales Order IDThe sales order ID of the subscription product. -
SalesOrderLineId: integer
(int64)
Title:
Sales Order Line IDThe sales order line ID of the subscription product. -
SalesOrderLineNumber: string
Title:
Sales Order Line NumberMaximum Length:100The sales order line number of the subscription product. -
SalesOrderNumber: string
Title:
Sales Order NumberMaximum Length:200The sales order number of the subscription product. -
SalesProductType: string
Title:
TypeMaximum Length:30The sales product type of the subscription product. -
ShipToAccountDescription: string
The ship-to account description of the subscription product.
-
ShipToAccountId: integer
(int64)
Title:
Ship-to Account IDThe ship-to account ID of the subscription product. -
ShipToAccountNumber: string
Title:
Ship-to AccountThe ship-to account number of the subscription product. -
ShipToContactId: integer
(int64)
Title:
Ship-to Contact IDThe ship-to contact ID of the subscription product. -
ShipToContactName: string
Title:
Ship-to ContactThe ship-to contact name of the subscription product. -
ShipToContactNumber: string
Title:
Ship-to Contact NumberThe ship-to contact number of the subscription product. -
ShipToContactPartyId: integer
Read Only:
trueThe ship-to contact party ID of the subscription product. -
ShipToPartyId: integer
(int64)
Title:
Ship-to Party IDThe ship-to party ID of the subscription product. -
ShipToPartyName: string
Title:
Ship-to PartyThe ship-to party name of the subscription product. -
ShipToPartyNumber: string
Title:
Ship-to Party NumberRead Only:trueMaximum Length:30The ship-to party number of the subscription product. -
ShipToPartySiteId: integer
(int64)
Title:
Ship-to Party Site IDThe ship-to party site ID of the subscription product. -
ShipToPartySiteNumber: string
Title:
Ship-to Site NumberThe ship-to party site number of the subscription product. -
SourceKey: string
Title:
Source KeyMaximum Length:120The source key of the subscription product. -
SourceLineKey: string
Title:
Source Line KeyMaximum Length:120The source line key of the subscription product. -
SourceLineNumber: string
Title:
External Source Line NumberMaximum Length:120The source line number of the subscription product. -
SourceNumber: string
Title:
External Source NumberMaximum Length:120The source number of the subscription product. -
SourceSystem: string
Title:
Source SystemMaximum Length:30The source system of the subscription product. -
StartDate: string
(date)
Title:
Product Start DateThe start date of the subscription product. -
Status: string
Title:
StatusMaximum Length:30Default Value:DRAFTThe status of the subscription product. -
StatusMeaning: string
Title:
Product StatusRead Only:trueMaximum Length:80The status meaning of the subscription product. -
SubscriptionId: integer
(int64)
The subscription ID of the subscription product.
-
SubscriptionProductId: integer
(int64)
The ID of the subscription product.
-
SubscriptionProductPuid: string
Title:
Subscription Product NumberMaximum Length:120The PUID of the subscription product. -
SubscriptionsEOAccountingRuleId: integer
(int64)
Title:
Accounting RuleThe accounting rule identifier of the subscription. -
SubscriptionsEOApprovalNote: string
Maximum Length:
240The approval note of the subscription. -
SubscriptionsEOApprovedDate: string
(date)
The approved date of the subscription.
-
SubscriptionsEOAssigneeId: integer
(int64)
The assignee ID of the subscription.
-
SubscriptionsEOAssigneeType: string
Maximum Length:
30The assignee type of the subscription. -
SubscriptionsEOBillingDateCode: string
Maximum Length:
30The billing date code of the subscription. -
SubscriptionsEOBillingFrequency: string
Maximum Length:
30The billing frequency of the subscription. -
SubscriptionsEOBillingOffsetDays: integer
(int64)
The billing offset days of the subscription.
-
SubscriptionsEOBillingSystem: string
Maximum Length:
120The billing system of the subscription. -
SubscriptionsEOBillOnDay: number
The bill on day of the subscription.
-
SubscriptionsEOBillService: string
Title:
Bill Service NameMaximum Length:30The bill service of the subscription. -
SubscriptionsEOBillToAccountId: integer
(int64)
Title:
Billing AccountThe unique identifier of the bill-to account of the subscription. -
SubscriptionsEOBillToAccountNumber: string
The bill-to account number of the subscription.
-
SubscriptionsEOBillToContactId: integer
(int64)
The unique identifier of the bill-to contact of the subscription.
-
SubscriptionsEOBillToContactNumber: string
The bill-to contact number of the subscription.
-
SubscriptionsEOBillToPartyId: integer
(int64)
The unique identifier of the bill-to party of the subscription.
-
SubscriptionsEOBillToPartyNumber: string
The bill-to party number of the subscription.
-
SubscriptionsEOBillToSiteNumber: string
The alternate unique identifier of the bill-to site number of the subscription.
-
SubscriptionsEOBillToSiteUseId: integer
(int64)
Title:
Bill-to SiteThe unique identifier bill-to site use of the subscription. -
SubscriptionsEOBusinessUnitId: integer
(int64)
The business unit identifier of the subscription.
-
SubscriptionsEOCalculatedCreditAmount: number
The calculated credit amount of the subscription.
-
SubscriptionsEOCancelDescription: string
Title:
Cancellation DescriptionMaximum Length:2000The cancel description of the subscription. -
SubscriptionsEOCanceledAmount: number
The canceled amount of the subscription.
-
SubscriptionsEOCanceledDate: string
(date)
The date when the subscription was canceled.
-
SubscriptionsEOCancelReason: string
Maximum Length:
30The cancel reason of the subscription. -
SubscriptionsEOCloseCreditMethod: string
Maximum Length:
30The close credit method of the subscription. -
SubscriptionsEOClosedAmount: number
The closed amount of the subscription.
-
SubscriptionsEOClosedDate: string
(date)
The date when the subscription was closed.
-
SubscriptionsEOCloseDescription: string
Title:
Close DescriptionMaximum Length:2000The close description of the subscription. -
SubscriptionsEOCloseReason: string
Maximum Length:
30The reason the subscription was closed. -
SubscriptionsEOCommunicationChannel: string
Title:
Communication ChannelMaximum Length:30The communication channel of the subscription. -
SubscriptionsEOCorpCurrencyCode: string
Maximum Length:
15The corporate currency code of the subscription. -
SubscriptionsEOCoverageInvoiceText: string
Maximum Length:
4000The coverage invoice text of the subscription. -
SubscriptionsEOCreatedBy: string
Read Only:
trueMaximum Length:64The user who created the subscription. -
SubscriptionsEOCreationDate: string
(date-time)
Read Only:
trueThe date when the subscription was created. -
SubscriptionsEOCreditedAmount: number
The credited amount of the subscription.
-
SubscriptionsEOCurcyConvRateType: string
Maximum Length:
30The currency conversion rate type of the subscription. -
SubscriptionsEOCurrency: string
Maximum Length:
15The currency of the subscription. -
SubscriptionsEOCurrencyConversionRate: string
Maximum Length:
30The currency conversion rate of the subscription. -
SubscriptionsEOCurrencyConversionRateDate: string
(date)
The currency conversion rate date of the subscription.
-
SubscriptionsEOCurrencyConversionRateType: string
Maximum Length:
30The currency conversion rate type of the subscription. -
SubscriptionsEOCustomerAcceptance: string
Title:
Customer AcceptanceMaximum Length:30The customer acceptance of the subscription. -
SubscriptionsEOCustomerTrxTypeSequenceId: integer
(int64)
The customer transaction type sequence identifier of the subscription.
-
SubscriptionsEODaysBeforeExpiry: integer
(int64)
The number of days before expiry of the subscription.
-
SubscriptionsEODaysBeforeExpiryUsed: string
Maximum Length:
18The number of used days before expiry of the subscription. -
SubscriptionsEODefinitionOrganizationCode: string
The inventory organization code of the subscription.
-
SubscriptionsEODefinitionOrganizationId: integer
(int64)
The inventory organization identifier of the subscription.
-
SubscriptionsEODescription: string
Maximum Length:
1995The description of the subscription. -
SubscriptionsEODocumentFiscalClassification: string
Maximum Length:
30The document fiscal classification of the subscription. -
SubscriptionsEOEnableRenewalRemindersFlag: boolean
Title:
Enable renewal remindersMaximum Length:1Indicates whether renewal reminders are enabled for the subscription. -
SubscriptionsEOEndDate: string
(date)
The end date of the subscription.
-
SubscriptionsEOEstimatedTax: number
The estimated tax of the subscription.
-
SubscriptionsEOExemptCertificateNumber: string
Maximum Length:
80The exempt certificate number of the subscription. -
SubscriptionsEOExemptReason: string
Maximum Length:
30The exempt reason of the subscription. -
SubscriptionsEOFreezePriceFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether price is frozen for the subscription. -
SubscriptionsEOInternalApproval: string
Title:
Internal ApprovalMaximum Length:30The internal approver indicator of the subscription. -
SubscriptionsEOInvoicedAmount: number
The invoiced amount of the subscription.
-
SubscriptionsEOInvoicingRuleId: integer
(int64)
The invoicing rule ID of the subscription.
-
SubscriptionsEOLastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription was last updated. -
SubscriptionsEOLastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the subscription. -
SubscriptionsEOLastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription. -
SubscriptionsEOLayoutTemplate: string
Title:
Contract Layout TemplateMaximum Length:200The layout template of the subscription. -
SubscriptionsEOLegalEntityId: integer
(int64)
The legal entity ID of the subscription.
-
SubscriptionsEOLineAutonumberEnabledYnFlag: boolean
Maximum Length:
1Indicates whether automatic numbering is enabled for lines of the subscription. -
SubscriptionsEONegotiationLanguage: string
Title:
LanguageMaximum Length:4The negotiation language of the subscription. -
SubscriptionsEONotificationTemplateId: integer
The notification template ID of the subscription.
-
SubscriptionsEOOrderLineOperationCode: string
Title:
Action CodeMaximum Length:80Order Line Operation Code -
SubscriptionsEOOverrideCreditAmount: number
The override credit amount of the subscription.
-
SubscriptionsEOPartialPeriodStart: string
Maximum Length:
30The partial period start of the subscription. -
SubscriptionsEOPartialPeriodType: string
Maximum Length:
30The partial period type of the subscription. -
SubscriptionsEOPaymentMethod: string
Maximum Length:
30The payment method of the subscription. -
SubscriptionsEOPaymentTermsId: integer
(int64)
The payment terms ID of the subscription.
-
SubscriptionsEOPONumber: string
Maximum Length:
50The PO number of the subscription. -
SubscriptionsEOPriceAdjustmentPercentUsed: number
The price adjustment percentage used for the subscription.
-
SubscriptionsEOPricedOnDate: string
(date-time)
Title:
Price as of DateThe priced on date of the subscription. -
SubscriptionsEOPricingError: string
Maximum Length:
2000The pricing error of the subscription. -
SubscriptionsEOPricingSegment: string
Maximum Length:
30The pricing segment of the subscription. -
SubscriptionsEOPricingSegmentExplanation: string
Maximum Length:
1000The pricing segment explanation of the subscription. -
SubscriptionsEOPricingStrategyExplanation: string
Maximum Length:
1000The pricing strategy explanation of the subscription. -
SubscriptionsEOPricingStrategyId: integer
(int64)
The pricing strategy ID of the subscription.
-
SubscriptionsEOPricingSystem: string
Maximum Length:
30The pricing system of the subscription. -
SubscriptionsEOPrimaryPartyId: integer
(int64)
The primary party ID of the subscription.
-
SubscriptionsEOPrimaryPartyNumber: string
The primary party number of the subscription.
-
SubscriptionsEOPrimarySalesPerson: integer
(int64)
The primary sales person of the subscription.
-
SubscriptionsEOPrimarySalesPersonNumber: string
The primary sales person number of the subscription.
-
SubscriptionsEOQuoteId: integer
(int64)
Title:
Quote IdThe quote ID of the subscription. -
SubscriptionsEOQuoteToCcEmail: string
Title:
Copy ToMaximum Length:2000The quote-to CC email of the subscription. -
SubscriptionsEOQuoteToContactId: integer
(int64)
Title:
Contact NameThe quote to contact ID of the subscription. -
SubscriptionsEOQuoteToContactNumber: string
The quote to contact number of the subscription.
-
SubscriptionsEORenewalCustomerAcceptance: string
Title:
Renewal Customer AcceptanceMaximum Length:30The renewal customer acceptance of the subscription. -
SubscriptionsEORenewalDuration: integer
(int64)
Title:
Renewal DurationThe renewal duration of the subscription. -
SubscriptionsEORenewalDurationPeriod: string
Maximum Length:
30The renewal duration period of the subscription. -
SubscriptionsEORenewalInternalApproval: string
Title:
Renewal Internal ApprovalMaximum Length:30The renewal internal approval of the subscription. -
SubscriptionsEORenewalPaymentMethod: string
Maximum Length:
30The renewal payment method of the subscription. -
SubscriptionsEORenewalPONumber: string
Maximum Length:
50The renewal PO number of the subscription. -
SubscriptionsEORenewalPriceAdjustmentBasis: string
Title:
Price Adjustment BasisMaximum Length:30The price adjustment basis of the subscription. -
SubscriptionsEORenewalPriceAdjustmentPercent: number
Title:
Price Adjustment ValueThe price adjustment percentage of the subscription. -
SubscriptionsEORenewalPriceAdjustmentType: string
Title:
Price Adjustment TypeMaximum Length:30The price adjustment type of the subscription. -
SubscriptionsEORenewalPricingMethodUsed: string
Maximum Length:
30The pricing method used for the subscription. -
SubscriptionsEORenewalProcess: string
Title:
Renewal ProcessMaximum Length:30The renewal process of the subscription. -
SubscriptionsEORenewalProcessUsed: string
Maximum Length:
30The renewal process used for the subscription. -
SubscriptionsEORenewalSubscriptionProfileId: integer
The renewal subscription profile ID of the subscription.
-
SubscriptionsEORenewalTemplateId: integer
The renewal template ID of the subscription.
-
SubscriptionsEORenewalWireNumber: string
Maximum Length:
30The renewal wire number of the subscription. -
SubscriptionsEORenewedDate: string
(date)
The renewal date of the subscription.
-
SubscriptionsEORenewPerpetuallyFlag: boolean
Maximum Length:
1Indicates whether the subscription should be renewed perpetually or not. -
SubscriptionsEORetainSubsOnRenewFlag: boolean
Maximum Length:
1Indicates whether the subscription should be retained on renewal or not. -
SubscriptionsEOSalesOrderId: integer
(int64)
The sales order ID of the subscription.
-
SubscriptionsEOSalesOrderNumber: string
Maximum Length:
200The sales order number of the subscription. -
SubscriptionsEOSegmentExplanationMessage: string
Maximum Length:
30The segment explanation message of the subscription. -
SubscriptionsEOShipToAccountId: integer
(int64)
The ship-to account ID of the subscription.
-
SubscriptionsEOShipToAccountNumber: string
Title:
Ship-to AccountThe ship-to account number of the subscription. -
SubscriptionsEOShipToContactId: integer
(int64)
The ship-to contact ID of the subscription.
-
SubscriptionsEOShipToContactNumber: string
The ship-to contact number of the subscription.
-
SubscriptionsEOShipToParty: integer
(int64)
Title:
Ship-to PartyThe ship-to party of the subscription. -
SubscriptionsEOShipToPartyNumber: string
The ship-to party number of the subscription.
-
SubscriptionsEOShipToPartySiteId: integer
(int64)
Title:
Ship-to SiteThe ship-to party site ID of the subscription. -
SubscriptionsEOShipToSiteNumber: string
The ship-to site number of the subscription.
-
SubscriptionsEOShortDescription: string
Maximum Length:
600The short description of the subscription. -
SubscriptionsEOSkipConsolidationFlag: boolean
Maximum Length:
1Indicates whether renewal consolidation should be skipped for the subscription. -
SubscriptionsEOSourceKey: string
Maximum Length:
120The source key of the subscription. -
SubscriptionsEOSourceNumber: string
Maximum Length:
120The source number of the subscription. -
SubscriptionsEOSourceSystem: string
Maximum Length:
30The source system of the subscription. -
SubscriptionsEOStartDate: string
(date)
The start date of the subscription.
-
SubscriptionsEOStatus: string
Maximum Length:
30Default Value:DRAFTThe status of the subscription. -
SubscriptionsEOSubscriptionId: integer
(int64)
The ID of the subscription.
-
SubscriptionsEOSubscriptionInvoiceText: string
Maximum Length:
4000The invoice text of the subscription. -
SubscriptionsEOSubscriptionNumber: string
Maximum Length:
120The subscription number. -
SubscriptionsEOSubscriptionProfileId: integer
(int64)
The profile ID associated with the subscription.
-
SubscriptionsEOSubscriptionProfileName: string
Maximum Length:
255The profile name associated with the subscription. -
SubscriptionsEOSystemAction: string
Maximum Length:
30The system action of the subscription. -
SubscriptionsEOSystemActionDate: string
(date-time)
The system action date of the subscription.
-
SubscriptionsEOSystemActionObject: string
Maximum Length:
30The system action object of the subscription. -
SubscriptionsEOSystemActionObjectKey: string
Maximum Length:
300The system action object key of the subscription. -
SubscriptionsEOSystemActionRequestId: integer
(int64)
The system action request ID of the subscription.
-
SubscriptionsEOSystemActionStatus: string
Maximum Length:
30The system action status of the subscription. -
SubscriptionsEOTaxClassificationCode: string
Maximum Length:
50The tax classification code of the subscription. -
SubscriptionsEOTaxExemptionHandling: string
Maximum Length:
30The tax exemption handling of the subscription. -
SubscriptionsEOTcvWithTotalUsageCharge: number
The total contract value with total usage charges of the subscription.
-
SubscriptionsEOTotalContractValue: number
Title:
Total Contract ValueThe total contract value of the subscription. -
SubscriptionsEOTotalUsageCharge: number
The total usage charge of the subscription.
-
SubscriptionsEOTransactionTypeName: string
Maximum Length:
80The transaction type name of the subscription. -
SubscriptionsEOUsageCapture: string
Maximum Length:
30The usage capture mode of the subscription. -
SubscriptionsEOUsageInvoiceLayoutTemplate: string
Maximum Length:
200The usage invoice layout template of the subscription. -
SubscriptionsEOUserStatus: string
Maximum Length:
30The user status of the subscription. -
SubscriptionsEOWarehouseId: integer
(int64)
The warehouse ID of the subscription.
-
SubscriptionsEOWarrantyYN: string
Maximum Length:
1Indicates whether the subscription is included warranty or not. -
SubscriptionsEOWireNumber: string
Maximum Length:
30The wire number of the subscription. -
SummarizedBillingFlag: boolean
Title:
Summarized billingMaximum Length:1Indicates whether summarized billing is required for the subscription product. -
SuspendCreditMethod: string
Title:
Suspend Credit MethodMaximum Length:30The suspend credit method of the subscription product. -
SuspendedDate: string
(date)
Title:
Suspend DateThe suspended date of the subscription product. -
SuspendReason: string
Title:
Suspend ReasonMaximum Length:30The suspend reason of the subscription product. -
TaxClassificationMeaning: string
Read Only:
trueThe tax classification meaning of the subscription product. -
TaxError: string
Title:
Tax ErrorMaximum Length:2000The tax error of the subscription product. -
TaxExemptionHandling: string
Title:
Tax Exemption HandlingMaximum Length:30The tax exemption handling of the subscription product. -
TaxExemptionHandlingName: string
The tax exemption handling of the subscription product.
-
TcvWithTotalUsageCharge: number
Title:
TCV with Total Usage ChargeRead Only:trueThe total contract value with total usage charges of the subscription product. -
TotalContractValue: number
Title:
Product Contract ValueThe total contract value of the subscription product. -
TotalUsageCharge: number
Title:
Total Usage ChargesRead Only:trueThe total usage charge of the subscription product. -
TransactionTypeName: string
Title:
Transaction TypeMaximum Length:30The transaction type name of the subscription product. -
TrxnExtensionId: integer
(int64)
Title:
Transaction Extension IDTrxn Extension Id -
UnitPrice: number
The unit price of the subscription product.
-
UpdateFlag: boolean
The update indicator of the subscription product.
-
UsageEventAllowanceInvTemplate: string
Title:
AllowanceMaximum Length:200The template to show allowance details of the subscription product usage events. -
UsageEventCommitmentInvTemplate: string
Title:
CommitmentMaximum Length:200The template to show commitment details of the subscription product usage events. -
UsageEventEstimateInvTemplate: string
Title:
EstimateMaximum Length:200The template to show estimate details of the subscription product usage events. -
UsageEventRegularInvTemplate: string
Title:
BasicMaximum Length:200The template to show regular details of the subscription product usage events. -
UsageInvoiceLayoutTemplate: string
Title:
BIP TemplateMaximum Length:200The usage invoice layout template of the subscription product. -
ValidationStatus: string
Title:
Validation StatusRead Only:trueMaximum Length:1The validation status of the subscription product. -
WarehouseId: integer
(int64)
Title:
WarehouseThe warehouse ID of the subscription product. -
WireNumber: string
Title:
Wire NumberMaximum Length:30The wire number of the subscription product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- AmendReasonVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS
The following properties are defined on the LOV link relation:- Source Attribute: SuspendReason; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BalancePartialPeriodOptionVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_PRTL_PRD_BALNC_METHOD
The following properties are defined on the LOV link relation:- Source Attribute: BalanceTerminatedPartialPeriodOption; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BillToAccountVA
-
Parameters:
- finder:
PrimaryPartyIdFinder%3BprimaryPartyId%3D{BillToPartyId}
The following properties are defined on the LOV link relation:- Source Attribute: BillToAccountNumber; Target Attribute: AccountNumber
- Display Attribute: AccountNumber, AccountName
- finder:
- BillToSiteActiveViewAccessor
-
Parameters:
- finder:
BillToSiteFinder%3BBindCustAcctId%3D{BillToAccountId}%2CBindSiteUseCd%3DBILL_TO
The following properties are defined on the LOV link relation:- Source Attribute: BillToSite; Target Attribute: Location
- Display Attribute: Location, Address, StartDate1, EndDate1, Status1
- finder:
- BillingDateCodeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BILLING_DATE
The following properties are defined on the LOV link relation:- Source Attribute: BillingDateCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ChangeReasonVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS
The following properties are defined on the LOV link relation:- Source Attribute: ProductChangeReason; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DefaultRevenueActionPVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RMCS_RULE
The following properties are defined on the LOV link relation:- Source Attribute: DefaultRevenueAction; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EarlyTerminationPenaltyVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_EARLY_TERM_FEE
The following properties are defined on the LOV link relation:- Source Attribute: EarlyTerminationPenalty; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EntitlementTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_ENTITLEMENT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: EntitlementType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ItemVA
-
Operation: /crmRestApi/resources/11.13.18.05/itemNamesParameters:
- finder:
DefinitionOrgAndWarrantyFinder
The following properties are defined on the LOV link relation:- Source Attribute: ProductName; Target Attribute: ItemNumber
- Display Attribute: ItemNumber, Description
- finder:
- NonFusionRatePlanVA
-
Parameters:
- finder:
EligibleRatePlanFinder
The following properties are defined on the LOV link relation:- Source Attribute: RequestedRatePlanNumber; Target Attribute: RatePlanNumber
- Display Attribute: RatePlanNumber, RatePlanId
- finder:
- PaymentMethodVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: RenewalPaymentMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- PaymentSetIdVA
-
Parameters:
- finder:
BuIdAndBillToAccountAndPrepaymentNoFinder%3BbindBillToAccount%3D{BillToAccountId}
The following properties are defined on the LOV link relation:- Source Attribute: PrePaymentNumber; Target Attribute: PaymentSetId
- Display Attribute: PaymentSetId
- finder:
- PaymentTermsLOVVA
-
Parameters:
- finder:
PaymentTermsByEndDateFinder%3BBindEndDate%3D{calculated value}
The following properties are defined on the LOV link relation:- Source Attribute: PaymentTermsName; Target Attribute: Name
- Display Attribute: Name, TermId
- finder:
- PeriodVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: PricingTermsPeriod; Target Attribute: UomCode
- Display Attribute: UnitOfMeasure
- PriceAdjustmentBasisVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RNWL_PRICE_ADJ_BASIS
The following properties are defined on the LOV link relation:- Source Attribute: PriceAdjustmentBasis; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PriceAdjustmentTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RNWL_PRICE_ADJ_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: PriceAdjustmentType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PricingMethodVA
-
Parameters:
- finder:
PricingSystemAndRatePlanIdFinder
The following properties are defined on the LOV link relation:- Source Attribute: PricingTermsPricingMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PrimaryPartyVA
-
Parameters:
- finder:
PrimaryPartyByStatusFinder%3BbindStatus%3DA
The following properties are defined on the LOV link relation:- Source Attribute: BillToPartyName; Target Attribute: PartyName
- Display Attribute: PartyName, PartyNumber
- finder:
- ProductCloseCreditMethodVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_CREDIT_METHOD
The following properties are defined on the LOV link relation:- Source Attribute: CloseCreditMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProductCloseReasonVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS
The following properties are defined on the LOV link relation:- Source Attribute: CloseReason; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProductCreditTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CREDIT_TYPES
The following properties are defined on the LOV link relation:- Source Attribute: CreditType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RelatedItemNameVA
-
Parameters:
- finder:
OrgIdAndSalesProdTypeFinder%3BbindOrgId%3D{DefinitionOrganizationId}%2CbindSalesProdType%3D{SalesProductType}
The following properties are defined on the LOV link relation:- Source Attribute: RelatedProductName; Target Attribute: ItemNumber
- Display Attribute: ItemNumber
- finder:
- RenewalPriceListsVA
-
Parameters:
- finder:
PriceListPickerFinder%3Bline_type_code%3DORA_BUY
The following properties are defined on the LOV link relation:- Source Attribute: RenewalPriceListName; Target Attribute: Name
- Display Attribute: Name
- finder:
- RenewalTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RENEWAL_ACTION
The following properties are defined on the LOV link relation:- Source Attribute: RenewalType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RequestedPriceListsVA
-
Parameters:
- finder:
PriceListFinderByCurrency%3Bline_type_code%3DORA_BUY%2Citem_id%3D{InventoryItemId}%2Ccurrency_code%3D{CorpCurrencyCode}%2Cpricing_uom_code%3D{ItemUnitOfMeasure}
The following properties are defined on the LOV link relation:- Source Attribute: RequestedPriceListId; Target Attribute: PriceListId
- Display Attribute: Name
- finder:
- RevenueOptionVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_REV_OPTIONS
The following properties are defined on the LOV link relation:- Source Attribute: RevenueOption; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesProductTypeLookupVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DQSC_SALES_PRODUCT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: SalesProductType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ShipToAccountVA
-
Parameters:
- finder:
SubscriptionIdAndPrimaryPartyIdFinder%3BbindSubscriptionId%3D{SubscriptionId}%2CprimaryPartyId%3D{ShipToPartyId}
The following properties are defined on the LOV link relation:- Source Attribute: ShipToAccountNumber; Target Attribute: AccountNumber
- Display Attribute: AccountNumber, AccountName
- finder:
- ShipToExternalContactsVA
-
Parameters:
- finder:
ExternalContactsbyPartyIdFinder%3BbindPartyId%3D{ShipToPartyId}
The following properties are defined on the LOV link relation:- Source Attribute: ShipToContactName; Target Attribute: ContactName
- Display Attribute: ContactName, EmailAddress
- finder:
- ShipToPartyVA
-
Parameters:
- finder:
ShipToPartybyStatusFinder%3BBindStatus%3DA
The following properties are defined on the LOV link relation:- Source Attribute: ShipToPartyName; Target Attribute: PartyName
- Display Attribute: PartyName, PartyNumber
- finder:
- SubscriptionCoverageHeaderVA
-
Parameters:
- finder:
coverageHeaderRowFinder
The following properties are defined on the LOV link relation:- Source Attribute: CoverageName; Target Attribute: CoverageName
- Display Attribute: CoverageName
- finder:
- TimeCodeUnitsVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: RenewalDurationPeriodName; Target Attribute: UnitOfMeasure
- Display Attribute: UnitOfMeasure
- UsageInvoiceLayoutTemplateVA
-
Parameters:
- finder:
ReportPathFinder%3BReportPath%3D{UsageInvoiceLayoutReportPath}
The following properties are defined on the LOV link relation:- Source Attribute: UsageInvoiceLayoutTemplate; Target Attribute: TemplateName
- Display Attribute: TemplateName
- finder:
- amend
-
Parameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
- SubscriptionProductPuid:
- close
-
Parameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
- SubscriptionProductPuid:
- getTotalEarlyTerminationFee
-
Parameters:
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
- SubscriptionProductPuid: