The Class SubscriptionDto.
| name | data type | type | namespace | min/max occurs | constraints | wrapped by | description |
|---|---|---|---|---|---|---|---|
| code | string | attribute | 1/1 | The code | |||
| description | string | attribute | 0/1 | The description | |||
| id | long | attribute | 0/1 | The id. | |||
| accesses | accessesDto | element | 0/1 | The accesses. | |||
| auditable | auditableDto | element | 0/1 | ||||
| auditableField | auditableFieldDto | element | 0/unbounded | auditableFields | |||
| autoEndOfEngagement | boolean | element | 0/1 | The auto end of engagement. | |||
| billingCycle | string | element | 1/1 | required | The billing cycle. | ||
| ccedEmails | string | element | 0/1 | A list of emails separated by comma | |||
| customFields | customFieldsDto | element | 0/1 | The custom fields. | |||
| discountPlanForInstantiation | discountPlanDto | element | 0/unbounded | discountPlansForInstantiation | List of discount plans. Use in instantiating DiscountPlanInstance. | ||
| discountPlanForTermination | string | element | 0/unbounded | discountPlansForTermination | List of discount plans to be disassociated from subscription | ||
| discountPlanInstance | discountPlanInstanceDto | element | 0/unbounded | discountPlanInstances | Use to return the active discount plans for this entity. | ||
| electronicBilling | boolean | element | 0/1 | The electronic billing. | |||
| string | element | 0/1 | The email. | ||||
| emailTemplate | string | element | 0/1 | Email Template code | |||
| endAgreementDate | dateTime | element | 0/1 | The end agreement date. | |||
| mailingType | string | element | 0/1 | Mailing type | |||
| minimumAmountEl | string | element | 0/1 | Expression to determine minimum amount value | |||
| minimumAmountElSpark | string | element | 0/1 | Expression to determine minimum amount value - for Spark | |||
| minimumLabelEl | string | element | 0/1 | Expression to determine rated transaction description to reach minimum amount value | |||
| minimumLabelElSpark | string | element | 0/1 | Expression to determine rated transaction description to reach minimum amount value - for Spark | |||
| offerTemplate | string | element | 1/1 | required | The offer template. | ||
| orderNumber | string | element | 0/1 | The order number. | |||
| productInstance | productInstanceDto | element | 0/unbounded | productInstances | Use in find. | ||
| products | productsDto | element | 0/1 | Use in creation and update. | |||
| ratingGroup | string | element | 0/1 | String value matched in the usageRatingJob to group the EDRs for rating. | |||
| renewalNotifiedDate | dateTime | element | 0/1 | Was/when "endOfTerm" notification fired for soon to expire subscription. | |||
| renewalRule | subscriptionRenewalDto | element | 0/1 | The renewal rule. | |||
| renewed | boolean | element | 1/1 | Was subscription renewed. | |||
| seller | string | element | 0/1 | The seller. | |||
| services | serviceInstancesDto | element | 0/1 | The services. | |||
| status | subscriptionStatusEnum | element | 0/1 | The status. | |||
| statusDate | dateTime | element | 0/1 | The status date. | |||
| subscribedTillDate | dateTime | element | 0/1 | A date till which subscription is subscribed. After this date it will either be extended or terminated | |||
| subscriptionDate | dateTime | element | 1/1 | required | The subscription date. | ||
| terminationDate | dateTime | element | 0/1 | The termination date. | |||
| terminationReason | string | element | 0/1 | The termination reason. | |||
| updatedCode | string | element | 0/1 | The updated code. | |||
| userAccount | string | element | 1/1 | required | The user account. |
Example
<subscriptionDto code="..." description="..." id="...">
<auditable created="..." creator="..." updated="..." updater="..."/>
<auditableFields>
<auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
<auditable created="..." creator="..." updated="..." updater="..."/>
<auditableFields>
<auditableField/>
</auditableFields>
<updatedCode>...</updatedCode>
</auditableField>
</auditableFields>
<updatedCode>...</updatedCode>
<userAccount>...</userAccount>
<offerTemplate>...</offerTemplate>
<subscriptionDate>...</subscriptionDate>
<terminationDate>...</terminationDate>
<endAgreementDate>...</endAgreementDate>
<status>...</status>
<statusDate>...</statusDate>
<customFields>
<customField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
<fieldType>...</fieldType>
<languageDescriptions/>
<stringValue>...</stringValue>
<dateValue>...</dateValue>
<longValue>...</longValue>
<doubleValue>...</doubleValue>
<booleanValue>...</booleanValue>
<listValue>
<value/>
</listValue>
<mapValue>...</mapValue>
<entityReferenceValue/>
<indexType>...</indexType>
<fileValue>...</fileValue>
<formattedValue/>
<guiPosition>...</guiPosition>
</customField>
<inheritedCustomField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
<fieldType>...</fieldType>
<languageDescriptions/>
<stringValue>...</stringValue>
<dateValue>...</dateValue>
<longValue>...</longValue>
<doubleValue>...</doubleValue>
<booleanValue>...</booleanValue>
<listValue>
<value/>
</listValue>
<mapValue>...</mapValue>
<entityReferenceValue/>
<indexType>...</indexType>
<fileValue>...</fileValue>
<formattedValue/>
<guiPosition>...</guiPosition>
</inheritedCustomField>
</customFields>
<accesses>
<access code="...">
<subscription>...</subscription>
<startDate>...</startDate>
<endDate>...</endDate>
<customFields/>
<disabled>...</disabled>
</access>
</accesses>
<services>
<serviceInstance code="..." description="..." id="...">
<auditable/>
<auditableFields>
<auditableField/>
</auditableFields>
<updatedCode>...</updatedCode>
<status>...</status>
<statusDate>...</statusDate>
<subscriptionDate>...</subscriptionDate>
<terminationDate>...</terminationDate>
<quantity>...</quantity>
<terminationReason>...</terminationReason>
<endAgreementDate>...</endAgreementDate>
<customFields/>
<recurringChargeInstances>
<recurringChargeInstance/>
</recurringChargeInstances>
<subscriptionChargeInstances>
<subscriptionChargeInstance/>
</subscriptionChargeInstances>
<terminationChargeInstances>
<terminationChargeInstance/>
</terminationChargeInstances>
<usageChargeInstances>
<usageChargeInstance/>
</usageChargeInstances>
<orderNumber>...</orderNumber>
<rateUntilDate>...</rateUntilDate>
<amountPS>...</amountPS>
<calendarPSCode>...</calendarPSCode>
<paymentDayInMonthPS>...</paymentDayInMonthPS>
<minimumAmountEl>...</minimumAmountEl>
<minimumAmountElSpark>...</minimumAmountElSpark>
<minimumLabelEl>...</minimumLabelEl>
<minimumLabelElSpark>...</minimumLabelElSpark>
<dueDateDaysPS>...</dueDateDaysPS>
<autoEndOfEngagement>...</autoEndOfEngagement>
<subscribedTillDate>...</subscribedTillDate>
<serviceRenewal/>
</serviceInstance>
</services>
<products>
<products code="..." description="...">
<chargeDate>...</chargeDate>
<quantity>...</quantity>
<amountWithoutTax>...</amountWithoutTax>
<amountWithTax>...</amountWithTax>
<criteria1>...</criteria1>
<criteria2>...</criteria2>
<criteria3>...</criteria3>
<customFields/>
</products>
</products>
<productInstances>
<productInstance code="..." description="..." id="...">
<applicationDate>...</applicationDate>
<auditable created="..." creator="..." updated="..." updater="..."/>
<quantity>...</quantity>
<auditableFields>
<auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
<auditable/>
<auditableFields>
<auditableField/>
</auditableFields>
<updatedCode>...</updatedCode>
</auditableField>
</auditableFields>
<orderNumber>...</orderNumber>
<updatedCode>...</updatedCode>
<productChargeInstance>
<quantity>...</quantity>
</productChargeInstance>
<customFields>
<customField/>
<inheritedCustomField/>
</customFields>
</productInstance>
</productInstances>
<terminationReason>...</terminationReason>
<orderNumber>...</orderNumber>
<minimumAmountEl>...</minimumAmountEl>
<minimumAmountElSpark>...</minimumAmountElSpark>
<minimumLabelEl>...</minimumLabelEl>
<minimumLabelElSpark>...</minimumLabelElSpark>
<subscribedTillDate>...</subscribedTillDate>
<renewed>...</renewed>
<renewalNotifiedDate>...</renewalNotifiedDate>
<renewalRule>
<initialyActiveFor>...</initialyActiveFor>
<initialyActiveForUnit>...</initialyActiveForUnit>
<autoRenew>...</autoRenew>
<daysNotifyRenewal>...</daysNotifyRenewal>
<endOfTermAction>...</endOfTermAction>
<terminationReasonCode>...</terminationReasonCode>
<renewFor>...</renewFor>
<renewForUnit>...</renewForUnit>
<extendAgreementPeriodToSubscribedTillDate>...</extendAgreementPeriodToSubscribedTillDate>
</renewalRule>
<billingCycle>...</billingCycle>
<seller>...</seller>
<autoEndOfEngagement>...</autoEndOfEngagement>
<ratingGroup>...</ratingGroup>
<electronicBilling>...</electronicBilling>
<email>...</email>
<mailingType>...</mailingType>
<emailTemplate>...</emailTemplate>
<ccedEmails>...</ccedEmails>
<discountPlansForInstantiation>
<discountPlanForInstantiation code="..." description="..." id="...">
<startDate>...</startDate>
<endDate>...</endDate>
<defaultDuration>...</defaultDuration>
<durationUnit>...</durationUnit>
<customFields>
<customField/>
<inheritedCustomField/>
</customFields>
<discountPlanItems>
<discountPlanItem code="...">
<discountPlanCode>...</discountPlanCode>
<invoiceCategoryCode>...</invoiceCategoryCode>
<invoiceSubCategoryCode>...</invoiceSubCategoryCode>
<expressionEl>...</expressionEl>
<expressionElSpark>...</expressionElSpark>
<disabled>...</disabled>
<discountPlanItemType>...</discountPlanItemType>
<discountValue>...</discountValue>
<discountValueEL>...</discountValueEL>
<discountValueElSpark>...</discountValueElSpark>
<customFields/>
</discountPlanItem>
</discountPlanItems>
<disabled>...</disabled>
<auditable/>
<auditableFields>
<auditableField/>
</auditableFields>
<updatedCode>...</updatedCode>
</discountPlanForInstantiation>
</discountPlansForInstantiation>
<discountPlansForTermination>
<discountPlanForTermination>...</discountPlanForTermination>
</discountPlansForTermination>
<discountPlanInstances>
<discountPlanInstance>
<discountPlan>...</discountPlan>
<billingAccount>...</billingAccount>
<subscription>...</subscription>
<startDate>...</startDate>
<endDate>...</endDate>
<customFields>
<customField/>
<inheritedCustomField/>
</customFields>
</discountPlanInstance>
</discountPlanInstances>
</subscriptionDto>