Atomia Billing Server

Subscription Expiration

12 views 0

Configuration description

Namespace:Atomia.Billing.Plugins.GenericWorkflowPlugin.ScheduledTasks.SubscriptionExpirationScheduledEventHandler

This handler is used to control the actions for a subscription when it either expires or is terminated. When a subscription is terminated it can be configured to automatically downgrade to the cheapest package available. For expired subscriptions a set of different actions can be taken. The configuration option should be set on the item.

Expire actions:

  • ExpireActionType.NoAction: Do nothing.
  • ExpireActionType.Suspend: Suspend the subscription.
  • ExpireActionType.Terminate: Terminate the subscription.
  • ExpireActionType.Downgrade: Downgrade the subscription to the cheapest package available.

Example configuration:

            {
              "ApprovedItemsCount": 50,
              "ScheduleItemsCount": 50,
              "ApplyToSubresellers":true,
              "AutoApprove": true,
              "Downgrade": false,
              "ExpirationActionAllowedStates": null,
              "ExpirationActionOffsets": [
                {
                  "Key": "Domain",
                  "Value": 8
                }
              ],
              "TerminationActionAllowedStates": null,
              "TerminationActionOffsets": [

              ]
            }
  • ApprovedItemsCount Limit the number of transfer out tasks to be auto-approved during one run. Zero means no limit.
  • ScheduleItemsCount Limit the number of subscriptions to be checked for the transfer out during one run. Zero means no limit.
  • ApplyToSubresellers If set to true and this configuration is reseller specific then it also applies reseller’s sub-resellers.
  • AutoApprove Should the action be auto-approved.
  • Downgrade If set to true the subscription will be downgraded when the termination occurs.
  • ExpirationActionAllowedStates List of states that should be used to filter which subscriptions to expire.
  • ExpirationActionOffsets[].Key The name of the product category to be used. “Default” can be used to specify the options that apply to all categories with no specific options in the Offsets section.
  • ExpirationActionOffsets[].Value Expiration date offset.
  • TerminationActionAllowedStates List of states that should be used to filter which subscriptions to terminate.
  • TerminationActionOffsets[].Key The name of the product category to be used. “Default” can be used to specify the options that apply to all categories with no specific options in the Offsets section.
  • TerminationActionOffsets[].Value Termination date offset.

Was this helpful?