SubscriptionHelperGetSubscriptionsForRenewalNotification Method (String, String, String, NullableDateTime, DateTime, String, TupleString, Int32, TupleString, Int32, String, String, Int32, Boolean, Boolean, Boolean, Guid, Guid, Boolean) |
Gets subscriptions for renewal notification for specified time period.
Namespace:
Atomia.Billing.Core.Sdk.BusinessLogic
Assembly:
Atomia.Billing.Core.Sdk (in Atomia.Billing.Core.Sdk.dll) Version: 18.10.7096.28998
Syntax public static List<Subscription> GetSubscriptionsForRenewalNotification(
string notificationType,
string[] allowedStates,
string[] notAllowedStates,
Nullable<DateTime> minimumRenewalDate,
DateTime maximumRenewalDate,
string[] itemCategories,
Tuple<string, int>[] allowedRenewalPeriods,
Tuple<string, int>[] notAllowedRenewalPeriods,
string taskItemType,
string taskType,
int maxItemsCount,
bool groupByAccount,
bool recurring,
bool includeSubscriptionsToTheEndOfTheMonth,
Guid[] resellerIds,
Guid[] excludedResellerIds,
bool onlyCustomersWithIsInvoicedMonthly = false
)
Public Shared Function GetSubscriptionsForRenewalNotification (
notificationType As String,
allowedStates As String(),
notAllowedStates As String(),
minimumRenewalDate As Nullable(Of DateTime),
maximumRenewalDate As DateTime,
itemCategories As String(),
allowedRenewalPeriods As Tuple(Of String, Integer)(),
notAllowedRenewalPeriods As Tuple(Of String, Integer)(),
taskItemType As String,
taskType As String,
maxItemsCount As Integer,
groupByAccount As Boolean,
recurring As Boolean,
includeSubscriptionsToTheEndOfTheMonth As Boolean,
resellerIds As Guid(),
excludedResellerIds As Guid(),
Optional onlyCustomersWithIsInvoicedMonthly As Boolean = false
) As List(Of Subscription)
public:
static List<Subscription^>^ GetSubscriptionsForRenewalNotification(
String^ notificationType,
array<String^>^ allowedStates,
array<String^>^ notAllowedStates,
Nullable<DateTime> minimumRenewalDate,
DateTime maximumRenewalDate,
array<String^>^ itemCategories,
array<Tuple<String^, int>^>^ allowedRenewalPeriods,
array<Tuple<String^, int>^>^ notAllowedRenewalPeriods,
String^ taskItemType,
String^ taskType,
int maxItemsCount,
bool groupByAccount,
bool recurring,
bool includeSubscriptionsToTheEndOfTheMonth,
array<Guid>^ resellerIds,
array<Guid>^ excludedResellerIds,
bool onlyCustomersWithIsInvoicedMonthly = false
)
static member GetSubscriptionsForRenewalNotification :
notificationType : string *
allowedStates : string[] *
notAllowedStates : string[] *
minimumRenewalDate : Nullable<DateTime> *
maximumRenewalDate : DateTime *
itemCategories : string[] *
allowedRenewalPeriods : Tuple<string, int>[] *
notAllowedRenewalPeriods : Tuple<string, int>[] *
taskItemType : string *
taskType : string *
maxItemsCount : int *
groupByAccount : bool *
recurring : bool *
includeSubscriptionsToTheEndOfTheMonth : bool *
resellerIds : Guid[] *
excludedResellerIds : Guid[] *
?onlyCustomersWithIsInvoicedMonthly : bool
(* Defaults:
let _onlyCustomersWithIsInvoicedMonthly = defaultArg onlyCustomersWithIsInvoicedMonthly false
*)
-> List<Subscription>
Parameters
- notificationType
- Type: SystemString
The notification type. - allowedStates
- Type: SystemString
The allowed states. - notAllowedStates
- Type: SystemString
The not allowed states. - minimumRenewalDate
- Type: SystemNullableDateTime
The minimum renewal date. - maximumRenewalDate
- Type: SystemDateTime
The maximum renewal date. - itemCategories
- Type: SystemString
The item categories. - allowedRenewalPeriods
- Type: Atomia.Billing.Core.Sdk.Utils.ContainersTupleString, Int32
The allowed renewal periods. - notAllowedRenewalPeriods
- Type: Atomia.Billing.Core.Sdk.Utils.ContainersTupleString, Int32
The not allowed renewal periods. - taskItemType
- Type: SystemString
Type of the task item. - taskType
- Type: SystemString
Type of the task. - maxItemsCount
- Type: SystemInt32
The max items count. - groupByAccount
- Type: SystemBoolean
if set to true group subscriptions by account. - recurring
- Type: SystemBoolean
if set to true only subscriptions with recurring property set to true will be fetched,
otherwise non-recurring subscriptions will be returned.. - includeSubscriptionsToTheEndOfTheMonth
- Type: SystemBoolean
if set to true [include subscriptions to the end of the month]. - resellerIds
- Type: SystemGuid
The reseller ids. - excludedResellerIds
- Type: SystemGuid
The excluded reseller ids. - onlyCustomersWithIsInvoicedMonthly (Optional)
- Type: SystemBoolean
Only include subscriptions where the customer has IsInvoicedMonthly set tu true.
Return Value
Type:
ListSubscription
Filtered subscriptions.
See Also