All Classes and Interfaces
Class
Description
Common parent for
InitiateUpgradeSubscriptionHandler and
InitiateDowngradeSubscriptionHandler.Handles common operations and logic for concrete
handlers.The default handler that validates if the
Subscription status can be changed to
SubscriptionStatuses.ACTIVEA DTO that represents a request to add an offer / offer code onto a
Subscription.A request DTO for adding an item to a cart.
Represents a price adjustment (discount) applied from an offer added to a
Subscription or
SubscriptionItem.Enumerates the types of dates that dictate when an added
SubscriptionItemAdjustment is
applied onto a SubscriptionItemA DTO used to engage bulk update of pricing on all subscriptions identified as in-scope.
The default handler that validates if the
Subscription status can be changed to
SubscriptionStatuses.CANCELLEDRepresents the cancellation policy for subscriptions.
Represents the details of a
CancellationPolicy.Endpoint related to
CancellationPoliciesProvider interfacing with a service or datastore providing catalog entity details for the
CancellationPolicy.Service to perform business logic related to
CancellationPolicies.CartOperationProvider<C extends com.broadleafcommerce.cart.client.domain.Cart>
Component responsible for interacting with a Cart Operations provider to act against user carts.
Provider interfacing with a service or datastore providing catalog entity details for the
Subscription.Categories provide a way to group related
Products for merchandising, marketing,
and search results.Handles change whether auto-renewal is enabled for a
Subscription.A request DTO used to create a new
Cart.Represents a request to create one or more
Subscriptions based on a given
Order and its Fulfillments.Provider interfacing with a service or datastore providing customer entity details for the
Subscription.Represents the default values for owning entity types of
Subscription
Adjustments.The strategy for charging a cancellation fee when a customer cancels a subscription.
Default implementation of
CancellationPolicyService.The strategy using which a subscription can be cancelled.
Describes how the effective date of a delayed subscription action should be determined.
Describes the type of delayed subscription action that will be applied in the future.
Describes restrictions placed on the customer's ability to select items from the targeted set.
The possible types of targets a
ItemChoice can have.Describes how the effective date of a subscription price change should be determined.
Represents the default types of account scope for which subscription bulk price changes can be
applied.
Out of the box forms that a
ProductOption can take.Enum values describing the reason for a subscription's period to be shortened.
Supported types for
SpecificItemChoice.getType()Default implementation of
SubscriptionAccessValidationServiceDescribes the potential actions that can be taken against a subscription.
The default types of actions that can be taken against a
Subscription by the user.The default reasons on why an action is unavailable for a
Subscription.Enumerates the types of subscription item references.
The default reasons for the
Subscription.getNextStatusChangeReason().DefaultSubscriptionOrderHistoryService<O extends com.broadleafcommerce.order.client.domain.Order>
Default implementation of
SubscriptionOrderHistoryServiceDeclares that payments made against a subscription are going towards the goods/services rendered
in the previous vs current period.
Enumerates the types of subscription period types.
Defines the default supported types of prices on a
SubscriptionItemPriceDetail or
SubscriptionPriceResponse.Enumerates the types of subscription sources.
Defines the default term duration types possible for
recurring
prices.DefaultUserSubscriptionSummaryService<U extends UserSubscriptionSummary,SWI extends SubscriptionWithItems>
Default implementation of
UserSubscriptionSummaryServiceDefines names of workflows used in SubscriptionOperationServices.
Simple object describing a subscription action that should be applied in the future.
The strategies by which a subscription's end of term can be configured.
Describes the timing & amount of future subscription payments.
Contains details describing an existing adjustment when entering a modify-subscription flow such
as for edit, upgrade, or downgrade.
Contains details describing an existing
SubscriptionAdjustment when entering a
modify-subscription flow such as for edit, upgrade, or downgrade.Contains details describing an existing
Subscription when entering a modify-subscription
flow such as for edit, upgrade, or downgrade.Contains details describing an existing
SubscriptionItemAdjustment when entering a
modify-subscription flow such as for edit, upgrade, or downgrade.Contains details describing an existing
SubscriptionItem when entering a
modify-subscription flow such as for edit, upgrade, or downgrade.Configuration properties for the
ExternalCancellationPolicyProvider.ExternalCartOperationProvider<C extends com.broadleafcommerce.cart.client.domain.Cart>
Default implementation of
CartOperationProvider for interacting with an external service.ExternalOrderProvider<O extends com.broadleafcommerce.order.client.domain.Order>
Default implementation of
OrderProvider.Configuration properties for the
ExternalOrderProvider.ExternalSubscriptionProvider<SWI extends SubscriptionWithItems,S extends Subscription,SO extends SubscriptionOwnerInfo>
Filtered, valid accounts based on a list of candidate accounts narrowed by inclusion and
exclusion customer segments.
The default handler that validates if the
Subscription status can be changed to
SubscriptionStatuses.FULFILLMENT_IN_PROCESSRequest DTO containing the
CartItems to identify the cancellation policies for.Response DTO describing the result of identifying the cancellation policies for the
CartItemsException thrown when an API call received an invalid response.
Thrown when the system state is not valid for a subscription pricing request.
Handles initiating a
Subscription cancellation flow.Handles downgrading a
Subscription.Handles initiating the edit-
Subscription flow.Handles upgrading a
Subscription.Exception denoting that the user does not have sufficient access to the subscription.
Exception denoting that the request to create a subscription was invalid
Exception denoting that the request to modify a subscription was invalid
Exception denoting that the request to change a subscription's status was invalid
Configuration state for
DefaultProductOptionType.ITEM_CHOICE.Informative DTO about the lock status.
Represents a component responsible for handling business logic related to some type of
modification performed upon a
Subscription such as upgrade, downgrade, cancel, etc.Represents a request to modify a user's subscription.
A DTO for specifying the details for a non-catalog item in a cart.
Deprecated, for removal: This API element is subject to removal in a future version.
OrderProvider<O extends com.broadleafcommerce.order.client.domain.Order>
Provider interfacing with a service or datastore providing
Order entity details.The default handler that validates if the
Subscription status can be changed to
SubscriptionStatuses.PAUSEDThe default handler that validates if the
Subscription status can be changed to
SubscriptionStatuses.PENDING_CANCELLATIONRepresents details of a subscription item adjustment that will be removed from the subscription
item, typically due to the cancellation of a subscription that is a qualifier of that offer.
Describes subscription billing period, including the start date, end date, & when the customer
will be billed.
A DTO used to provide context on a request to price a cart.
A DTO to represent changeable price fields and other price data info.
Enumerates the types of dates that dictate when a
PriceChangeRequest is applied.Enumerates the types of users a
PriceChangeRequest applies to.Structure representing a change to the pricing of the subscription.
Represents a request to change the price data for a batch of subscriptions.
The product containing the details related to subscriptions.
A "product option" encapsulates additional, variable information about a
Product
explicitly designed for customer-facing input.Defines a generic error that can be thrown in response to receiving an error from an API that one
of the providers (e.g.,
SubscriptionProvider) received.Represents an
Adjustment that will be lost given proposed changes to a current
Subscription.Generates a Page representing the data and page data received as a response from another service.
When a
ItemChoice is determined to be a
DefaultItemChoiceTargetType#SPECIFIC_PRODUCTS or
DefaultItemChoiceTargetType#SPECIFIC_VARIANTS, this holds the relationship that the
customer should select fromDeprecated, for removal: This API element is subject to removal in a future version.
Use
CommonInternalServiceSSLVerificationProperties insteadThis service is responsible for starting the "*ChangeAutoRenewalWorkflow" workflow.
This is a domain representing a user's subscription to a service or a good.
Performs validation to check the accessibility of the subscriptions for the user.
Represents an action that can be taken against a
Subscription.Describes the amount being charged for this item.
A request DTO to see what actions are available for a
Subscription.A response DTO containing the available
SubscriptionActions and
unavailable SubscriptionActions along with the unavailable reasons.This is a representation of a price adjustment for a
SubscriptionContains all the constants for
Subscription.getAttributes() and
Subscription.getInternalAttributes().Configuration properties for
Subscription cancellation.A request DTO that stores fields necessary for creating a
Subscription and its
items.An util class for time related calculations.
Service used to generate
Subscription records based on an Order and its items.This represents a line item for a
SubscriptionThis represents a line item price adjustment for a
SubscriptionRepresent the details of the price adjustment for a subscription item.
Request DTO stored on
SubscriptionCreationRequest that holds fields necessary for
building and creating a subscriptionDescribes the amount being charged for this item.
Thrown if the subscription can't be locked.
Provides utility methods for shared logic for
ModifySubscriptionHandlers that doesn't make sense in an abstract class.Spring Boot default property overrides for this service
General exception handler registry for handlers not exclusive to a single controller.
Provides a programmatic way to access the property that defines whether a database provider is
present, and if so, which framework is used.
Service for operations on subscriptions and their items
Configurable properties for the Subscription Operation Service.
SubscriptionOrderHistoryService<O extends com.broadleafcommerce.order.client.domain.Order>
Service that is used to read the
Orders for the specified subscription ID.DTO that contains information about the owner of a subscription, e.g.
Simple object describing the start, end, & bill dates of a subscription period.
Contains all the constants for
SubscriptionPeriod.getAttributes().For a subscription cart item, this object describes the amount that the customer should be
charged now vs their future payments.
Context object that's used throughout the subscription pricing ecosystem to communicate details
about the subscription, action, & subscription periods.
Service for pricing subscriptions.
SubscriptionProvider<SWI extends SubscriptionWithItems,S extends Subscription,SO extends SubscriptionOwnerInfo>
Provider interfacing with Broadleaf's BillingServices to gather, update, or create
Subscription and related entities.Identifies an entity that can be referenced by a
SubscriptionItem.Enumerates the statuses for a subscription
A handler that handles a
Subscription's status change, e.g.Service for validating actions against subscriptions.
This is a container for a
Subscription and a list of SubscriptionItemDeprecated, for removal: This API element is subject to removal in a future version.
Use
CommonInternalServiceSynchronizedOAuth2AuthorizedClientManager insteadThrown when a request is made to modify a
Subscription that has no matching
ModifySubscriptionHandler.Represents a request to modify a subscription's status.
Holds summary of the former and current subscriptions purchased by a user.
Service for operations on
UserSubscriptionSummary
Variants can help further identify the specifics of a Product by narrowing down the Sku via
additional user data.
CommonOAuth2ClientCredentialsAccessTokenResponseClientinstead