Class CartItemAttributeConstants.Subscription.Internal

java.lang.Object
com.broadleafcommerce.cartoperation.domain.CartItemAttributeConstants.Subscription.Internal
Enclosing class:
CartItemAttributeConstants.Subscription

public static final class CartItemAttributeConstants.Subscription.Internal extends Object
  • Field Details

    • IS_SEPARATE_FROM_PRIMARY_ITEM

      public static final String IS_SEPARATE_FROM_PRIMARY_ITEM
      Describes if a given subscription item should be split into its own subscription
      See Also:
    • EXISTING_SUBSCRIPTION_ID

      public static final String EXISTING_SUBSCRIPTION_ID
      The id of an existing subscription. This is most relevant for subscription action flows that are modifying an existing subscription.
      See Also:
    • EXISTING_SUBSCRIPTION_ITEM_ID

      public static final String EXISTING_SUBSCRIPTION_ITEM_ID
      The id of an existing subscription item. This is most relevant for subscription action flows that are modifying an existing subscription.
      See Also:
    • DUE_NOW_REFUND_AMOUNT

      public static final String DUE_NOW_REFUND_AMOUNT
      Records a refund amount that the customer will be issued, generally due to cancelling their subscription during the grace period and having prepaid for the current billing period.
      See Also:
    • DUE_NOW_PRORATED_AMOUNT

      public static final String DUE_NOW_PRORATED_AMOUNT
      The due now price, prorated relative to the next invoice date. For a new purchase, this reflects the full date range. For edits, upgrades, & downgrades, this reflects the prorated price between the action & the end of the billing period.
      See Also:
    • DUE_NOW_CREDITED_AMOUNT

      public static final String DUE_NOW_CREDITED_AMOUNT
      For edits, upgrades, and downgrades on a subscription that’s using an DefaultPaymentStrategy.PREPAID payment strategy, the customer has already paid the full amount for this billing cycle at the previous rate.

      For example, consider a customer who is upgrading from 10 to 20 licenses at $1 each half-way through a 30-day month. The user prorated amount would be $10 for 20 licenses. This user has already partially paid for 10 of the licenses, so they will be due a credit of $5 toward the second-half-of-the-month amount.

      See Also:
    • DUE_NOW_PRIOR_UNBILLED_AMOUNT

      public static final String DUE_NOW_PRIOR_UNBILLED_AMOUNT
      Prior to an edit, upgrade, or downgrade on a subscription that’s using a Postpaid payment strategy, the system will have prior unbilled charges that will be part of the next invoice. In this case, the user will owe this in addition to the prorated charges for the changes being made.

      For example, consider a customer who is upgrading from 10 to 20 licenses at $1 each half-way through a 30-day month. The user prorated amount would be $10 for 20 licenses. This user also owes $5 for access to the 10 licenses in the first half of the month.

      See Also:
    • DUE_NOW_ITEM_DETAILS

      public static final String DUE_NOW_ITEM_DETAILS
      A collection of SubscriptionItemPriceDetail objects describing the subscription's due now pricing
      See Also:
    • ESTIMATED_FUTURE_PAYMENTS

      public static final String ESTIMATED_FUTURE_PAYMENTS
      A collection of EstimatedFuturePayment objects describing the timing & amount of future subscription payments. Note: this collection is meant to be held by the root subscription cart item.
      See Also:
    • REMOVED_SUBSCRIPTION_ADJUSTMENTS

      public static final String REMOVED_SUBSCRIPTION_ADJUSTMENTS
      A collection of all the Adjustments lost due to modification in the current Cart to an existing subscription.
      See Also:
    • SUBSCRIPTION_PRE_ACTION_SUBTOTAL

      public static final String SUBSCRIPTION_PRE_ACTION_SUBTOTAL
      The subscription subtotal prior to the action being taken, reflecting the typical recurring price for the subscription. For a DefaultSubscriptionActionFlow.CREATE action, this value will be null since there was no prior subscription.
      See Also:
    • SUBSCRIPTION_POST_ACTION_SUBTOTAL

      public static final String SUBSCRIPTION_POST_ACTION_SUBTOTAL
      The subscription subtotal after to the action being taken, reflecting the typical recurring price for the subscription.
      See Also:
    • ITEM_PRE_ACTION_SUBTOTAL

      public static final String ITEM_PRE_ACTION_SUBTOTAL
      The subscription item subtotal prior to the action being taken, reflecting the typical recurring price for the subscription. For a DefaultSubscriptionActionFlow.CREATE action, this value will be null since there was no prior subscription.
      See Also:
    • ITEM_POST_ACTION_SUBTOTAL

      public static final String ITEM_POST_ACTION_SUBTOTAL
      The subscription item subtotal after to the action being taken, reflecting the typical recurring price for the subscription.
      See Also:
    • REMOVED_SUBSCRIPTION_ITEM_ACTION_DETAILS

      public static final String REMOVED_SUBSCRIPTION_ITEM_ACTION_DETAILS
      A collection of SubscriptionActionPriceDetail records for removed subscription items.
      See Also:
    • ALLOW_ADDON_REMOVAL_AFTER_PURCHASE

      public static final String ALLOW_ADDON_REMOVAL_AFTER_PURCHASE
      Whether removal of the add-on subscription item is allowed after the initial purchase.
      See Also:
    • ADDON_REMOVAL_DEADLINE

      public static final String ADDON_REMOVAL_DEADLINE
      The deadline of when an add-on subscription item can be removed.
      See Also:
    • ADDON_QUANTITY_DECREASE_DEADLINE

      public static final String ADDON_QUANTITY_DECREASE_DEADLINE
      The deadline of when an add-on subscription item quantity can be decreased.
      See Also: