Serialized Form

  • Package com.broadleafcommerce.billing.common.exception

  • Package com.broadleafcommerce.billing.common.provider.jpa.id

  • Package com.broadleafcommerce.billing.common.web.endpoint.exception

  • Package com.broadleafcommerce.billing.domain

    • Class com.broadleafcommerce.billing.domain.BillingEvent

      class BillingEvent extends Object implements Serializable

      • Serialized Fields

        • additionalAttributes
          Map<@Size(max=255) String,@Size(max=2000) String> additionalAttributes
          Name/Value pairs of additional attributes.
        • alternateUserRef
          String alternateUserRef
          Alternate reference to the user. Useful for third-party authentication system identifiers
        • billDate
          Date billDate
          Date when the BillingEvent is billed
        • billingCycleEndDate
          Date billingCycleEndDate
          Date representing the end of the window which is being billed for
        • billingCycleStartDate
          Date billingCycleStartDate
          Date representing the start of the window which is being billed for
        • billingEventAddressId
          String billingEventAddressId
          Reference to the related BillingEventAddress
        • billTotal
          BigDecimal billTotal
          Total bill amount including tax for this BillingEvent
        • billTotalTax
          BigDecimal billTotalTax
          Total tax created for the billAmount
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • createdDate
          Date createdDate
          The date this billing event was created on
        • currency
          @NotNull javax.money.CurrencyUnit currency
          The currency of charges on this BillingEvent
        • currencyCode
          @NotBlank String currencyCode
          Deprecated.
          use BillingEvent.getCurrency() field instead
          The currency (“USD”, “CAD”, etc.) correlated to charges on this BillingEvent
        • eventNotificationChannel
          String eventNotificationChannel
          Notification channel for this event
        • id
          @Null(groups=Create.class) @Size(max=255) String id
        • isRecurring
          boolean isRecurring
          Indicates whether the billing event is for a recurring subscription
        • orderId
          @Size(max=255) String orderId
          The identifier for the business order for this billing event.
        • orderRef
          @NotBlank @Size(max=255) String orderRef
          Reference for the business order for this billing event. By default, this is set to the order number.
        • orderSrc
          @NotBlank @Size(max=255) String orderSrc
          The source system for the business order.
        • siteIdentifier
          String siteIdentifier
          Multi-tenancy support
        • source
          String source
          The type of the process that created this event
        • sourceId
          String sourceId
          The id of the process that created this event
        • subscriptionPeriod
          Integer subscriptionPeriod
          Describes the Subscription's period that correlates to this BillingEvent. This value is especially relevant when processing a subscription's recurring billing. If this BillingEvent does not correlate to a Subscription, then we expect this value to be null.
        • subscriptionRef
          String subscriptionRef
          The Subscription used for this BillingEvent
        • userRef
          @NotBlank @Size(max=255) String userRef
          The id of the user billed for this event

    • Class com.broadleafcommerce.billing.domain.BillingRetrySchedule

      class BillingRetrySchedule extends Object implements Serializable

      • Serialized Fields

        • code
          @NotBlank @Size(max=255) String code
          Deprecated.
          Use BillingRetrySchedule.getId() field instead
          The unique identifier for a retry schedule
        • id
          @NotBlank @Size(max=255) String id
          The unique identifier for a retry schedule
        • retries
          @NotNull List<IntervalBillingRetrySpecs> retries
          The retry details associated with this schedule. This details when the next retry should occur. Each subsequent retry uses a next entry, starting from index 0.
        • retryAttemptCount
          @NotNull Integer retryAttemptCount
          How many times the payment should be retried.
        • tryAccountsFromWallet
          boolean tryAccountsFromWallet
          Set to true if we should try additional payment methods from the user's wallet if payment fails on the preferred payment method. This is not applicable for refunds.

    • Class com.broadleafcommerce.billing.domain.IntervalBillingRetrySpecs

      class IntervalBillingRetrySpecs extends Object implements Serializable

      • Serialized Fields

        • retryAfterDays
          @NotNull Integer retryAfterDays
          The number of days in the future to schedule the next retry.

  • Package com.broadleafcommerce.billing.exception

  • Package com.broadleafcommerce.billing.job.domain

  • Package com.broadleafcommerce.billing.job.provider.jpa.domain

  • Package com.broadleafcommerce.billing.job.service.exception

  • Package com.broadleafcommerce.billing.provider.jpa.domain

  • Package com.broadleafcommerce.billing.provider.jpa.tracking

  • Package com.broadleafcommerce.billing.service.provider.domain

    • Class com.broadleafcommerce.billing.service.provider.domain.Address

      class Address extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Map holding any additional attributes passed in the request not matching any defined properties.
        • addressLine1
          String addressLine1
          Primary address information, typically street name and building number.
        • addressLine2
          String addressLine2
          Secondary address information, like apartment, suite, or unit number.
        • addressLine3
          String addressLine3
          Tertiary address information, typically for international addresses.
        • city
          String city
          The city, town or village of this address.
        • companyName
          String companyName
          The name of the company at this address.
        • country
          String country
          The country for this address.
        • county
          String county
          The county of this address.
        • emailAddress
          String emailAddress
          The email address of the individual at this physical address.
        • firstName
          String firstName
          The first name of the individual at this address.
        • fullName
          String fullName
          The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.
        • isActive
          boolean isActive
          Whether this address is an active address of the owner.
        • isDefault
          boolean isDefault
          Whether this address is the default address of the owner.
        • lastName
          String lastName
          The last name of the individual at this address.
        • phoneFax
          Phone phoneFax
          The fax number for this address.
        • phonePrimary
          Phone phonePrimary
          The primary phone number for this address.
        • phoneSecondary
          Phone phoneSecondary
          The secondary phone number for this address.
        • postalCode
          String postalCode
          Postal code or ZIP code for this address.
        • stateProvinceRegion
          String stateProvinceRegion
          The state, province or region of this address.

    • Class com.broadleafcommerce.billing.service.provider.domain.PaymentSummary

      class PaymentSummary extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • addressByType
          Map<String,Address> addressByType
          The collection of related addresses that may include billing or shipping addresses
        • adjustmentsTotal
          javax.money.MonetaryAmount adjustmentsTotal
          The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
        • amount
          javax.money.MonetaryAmount amount
          The amount for which this payment is allotted. The summation of all of the payments for a particular cart should equal the cart's total. If specified, the amount details (PaymentSummary.subtotal, PaymentSummary.adjustmentsTotal, PaymentSummary.fulfillmentTotal, & PaymentSummary.taxTotal) should sum together to equal this amount.
        • amountAuthorized
          javax.money.MonetaryAmount amountAuthorized
          The total authorized amount for capture. This value is calculated as "total authorized - total reverse-authed".
        • amountAvailableForAuthorize
          javax.money.MonetaryAmount amountAvailableForAuthorize
          Determines the amount that can be authorized for this payment summary
        • amountAvailableForAuthorizeAndCapture
          javax.money.MonetaryAmount amountAvailableForAuthorizeAndCapture
          Determines the amount that can be authorized and captured for this payment summary
        • amountAvailableForCapture
          javax.money.MonetaryAmount amountAvailableForCapture
          Determines the amount that can be captured for this payment summary
        • amountAvailableForRefund
          javax.money.MonetaryAmount amountAvailableForRefund
          Determines the amount that can be refunded for this payment summary
        • amountAvailableForReverseAuthorization
          javax.money.MonetaryAmount amountAvailableForReverseAuthorization
          Determines the amount that can be reverse-authorized for this payment summary
        • amountCaptured
          javax.money.MonetaryAmount amountCaptured
          The total amount that is currently captured. This value is calculated as "total captured - total refunded".
        • amountCredited
          javax.money.MonetaryAmount amountCredited
          The total detached credit amount.
        • amountRefunded
          javax.money.MonetaryAmount amountRefunded
          The total refunded amount.
        • attributes
          Map<String,String> attributes
          General use map to capture any additional attributes needed for this Payment
        • captureAmountAwaitingResult
          javax.money.MonetaryAmount captureAmountAwaitingResult
          The total amount sent to the payment gateway for capture, and is waiting for a response about the transaction result.

          This value should only be present for payment gateways that support asynchronous transaction executions.

        • displayAttributes
          Map<String,String> displayAttributes
          General use map to capture any display properties for this Payment
        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The payment's total fulfillment cost
        • fullyAuthorized
          boolean fullyAuthorized
          Determines if the payment summary is fully authorized
        • fullyCaptured
          boolean fullyCaptured
          Determines if the payment summary is fully captured
        • gatewayType
          String gatewayType
          The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.
        • hasTransactionFlaggedForManualReview
          boolean hasTransactionFlaggedForManualReview
          Indicates that the payment transaction has been flagged for manual review by fraud checks.
        • isSingleUsePaymentMethod
          boolean isSingleUsePaymentMethod
          Whether or not the underlying payment method can only be used once. In most cases, we're managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment's amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token. Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you'll need to seek an alternative form of payment.
        • name
          String name
          The name of this payment. This name is typically something like "Visa ending in 1234".
        • owningEntityId
          String owningEntityId
          The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.
        • owningEntityType
          String owningEntityType
          Describes the owning entity of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.
        • partiallyCaptured
          boolean partiallyCaptured
          Determines if the payment summary is partially captured
        • partialReverseAuthSupported
          boolean partialReverseAuthSupported
          Whether a portion of an authorization transaction can be reversed, or if the full authorization transaction must be reversed.
        • paymentId
          String paymentId
          The id of this payment.
        • refundAmountAwaitingResult
          javax.money.MonetaryAmount refundAmountAwaitingResult
          The total amount sent to the payment gateway for refund, and is waiting for a response about the transaction result.

          This value should only be present for payment gateways that support asynchronous transaction executions.

        • reverseAuthorizeAmountAwaitingResult
          javax.money.MonetaryAmount reverseAuthorizeAmountAwaitingResult
          The total amount sent to the payment gateway for reverse authorize, and is waiting for a response about the transaction result.

          This value should only be present for payment gateways that support asynchronous transaction executions.

        • reverseAuthRemainder
          boolean reverseAuthRemainder
          Declares if the reverse authorize for this functionality only allows reversing the full non-captured amount.
        • subtotal
          javax.money.MonetaryAmount subtotal
          The payment's total usually excluding adjustments, tax, and shipping.
        • taxTotal
          javax.money.MonetaryAmount taxTotal
          The payment's total tax cost
        • totalEverCaptured
          javax.money.MonetaryAmount totalEverCaptured
          The total amount ever captured, as opposed to the current snapshot of the captured amount represented in PaymentSummary.getAmountCaptured().
        • type
          String type
          The type of this payment like Credit Card or Gift Card.
        • version
          Integer version
          The version of this payment. Used for checking that the requested version of the payment is up-to-date before saving changes. Required for any request which results in an update being made to the payment. This should never be manually incremented/decremented.

    • Class com.broadleafcommerce.billing.service.provider.domain.Phone

      class Phone extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • countryCode
          String countryCode
          The country calling code that acts as a prefix to the main telephone number.
        • extension
          String extension
          The internal extension for this phone.
        • phoneNumber
          String phoneNumber
          The telephone number, including the area code.

    • Class com.broadleafcommerce.billing.service.provider.domain.SavedPaymentMethod

      class SavedPaymentMethod extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • attributes
          Map<String,String> attributes
          General use map to capture any additional attributes needed for this saved payment method.
        • billingAddress
          Address billingAddress
          The billing address of this saved payment method.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • defaultForOwner
          boolean defaultForOwner
          Whether this saved payment is the default payment method for the owning user.
        • displayAttributes
          Map<String,String> displayAttributes
          General use map to capture any display properties for this saved payment method.
        • gatewayReferenceId
          String gatewayReferenceId
          Returns the saved payment method ID known by the payment gateway. This value should be unique within a single tenant and can't be updated after creation. Note: if you can't guarantee uniqueness of the gateway's ID for the payment method, then we recommend generating your own unique ID to link the Broadleaf saved payment method & the gateway's payment method.

          This is an ID that is used to fetch the saved payment method that should be updated by the webhook handler.

          For example, to create the saved payment method for the ACH payments in Stripe, you have to create the SetupIntent object and after that create the saved payment method entity in the PaymentTransactionServices. It is possible that this payment method cannot be verified instantly by the customer's bank. In this case, Stripe will send the webhook event "setup_intent.succeeded" or "setup_intent.setup_failed" when it is confirmed by the customer. And to have an ability to update the correct payment method in PaymentTransactionServices we have to fetch it by this reference ID. For Stripe this value should be the SetupIntent ID.

        • gatewayType
          String gatewayType
          The gateway used to process this saved payment method. Only a SINGLE payment gateway can be used for a payment.
        • id
          String id
          The id of this saved payment method.
        • lastTransactionDateTime
          Instant lastTransactionDateTime
          The timestamp of the last transaction made by this saved payment method.
        • lastTransactionResultCode
          String lastTransactionResultCode
          The result code returned from the gateway on the last transaction.
        • name
          String name
          The name of this saved payment method. This name is typically something like "Visa ending in 1234".
        • owningUserId
          String owningUserId
          The id of the entity that owns this saved payment method. For example, this may be a customer id, or an account id.
        • owningUserType
          String owningUserType
          Describes the owning user of the saved payment method. For example, the saved payment could belong to a Broadleaf customer or an account, therefore this value might be BLC_CUSTOMER, or BLC_ACCOUNT.
        • type
          String type
          The type of this saved payment method like Credit Card or Gift Card.
        • version
          Integer version
          The version of this saved payment. Used for checking that the requested version of the saved payment is up-to-date before saving changes. Required for any request which results in an update being made to the saved payment. This should never be manually incremented/decremented.

    • Class com.broadleafcommerce.billing.service.provider.domain.SavedPaymentMethodTransactionExecutionRequest

      class SavedPaymentMethodTransactionExecutionRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • paymentAttributes
          Map<String,String> paymentAttributes
          Map to capture any additional information about the payment
        • paymentOwningEntityId
          String paymentOwningEntityId
          The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.
        • paymentOwningEntityType
          String paymentOwningEntityType
          Describes the owning entity of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.
        • paymentOwningUserId
          String paymentOwningUserId
          The id of the user that owns this payment.
        • paymentOwningUserType
          String paymentOwningUserType
          Describes the owning user of the payment.
        • transactionExecutionRequest
          TransactionExecutionRequest transactionExecutionRequest

    • Class com.broadleafcommerce.billing.service.provider.domain.TransactionExecutionDetail

      class TransactionExecutionDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustmentsTotal
          javax.money.MonetaryAmount adjustmentsTotal
          The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
        • attributes
          Map<String,String> attributes
          Map of specific attributes that have been gathered from the raw response. This should be used for data points that are to be used programmatically. For example, a gateway-specific transaction id that can be used to capture or refund the transaction.
        • dateRecorded
          Instant dateRecorded
          The timestamp when this transaction response was recorded
        • declineType
          String declineType
          The type of transaction failure (hard vs soft failure)
        • failureType
          String failureType
          The type of transaction failure
        • feesTotal
          javax.money.MonetaryAmount feesTotal
          The total fees related to the TransactionExecutionDetail.transactionAmount
        • flaggedForManualReview
          boolean flaggedForManualReview
          Indicates that the payment transaction has been flagged for manual review via fraud checks.
        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The payment's total fulfillment cost.
        • gatewayResponseCode
          String gatewayResponseCode
          The response code provided by the payment gateway which may represent a success or failure
        • includedTaxTotal
          javax.money.MonetaryAmount includedTaxTotal
          The amount of taxes that are included in the subtotal (VAT).
        • indeterminateResult
          boolean indeterminateResult
          Tells if this transaction has an indeterminate result.

          Having an indeterminate result means that the true outcome of the transaction is not known. For example, if a transaction is sent to the payment processor but a network error occurred, it is not known to us whether the user was actually charged or not (thus, the result is indeterminate).

          Transactions should be marked as indeterminate when sending to the payment processor, and then unmarked once a response is received, understood, and recorded. This means that a transaction in an indeterminate result state is expected during the sending to processor phase. However, if the transaction remains in that state for an excessive amount of time, something likely went wrong and the transaction will need to be reconciled. If the transaction changes from the sending to processor status but remains indeterminate, the transaction will also require reconciliation in that scenario.

          Some situations which may lead to an indeterminate result:

          • A transaction is sent to the processor, but a network error prevents us from receiving the response
          • A transaction is sent to the processor, but the processor returns an unexpected error (e.g. 500 internal server error)
          • A transaction is sent to the processor and a response is received, but cannot be recorded because Cart Services is down
          • A transaction is sent to the processor and a response is received, but cannot be recorded because the database is down
        • message
          String message
          Message describing the result of the transaction
        • parentTransactionId
          String parentTransactionId
          The id of the parent payment transaction. Necessary for operations on a payment that require something to have happened beforehand. For instance, an authorize transaction would not have a parent but a capture must have an authorize parent transaction and a refund must have a capture parent transaction. The full set of expected parent-child transaction relationships are as follows:
          • Child Transaction -> Parent Transaction
          • Reverse Authorize -> Authorize
          • Capture -> Authorize
          • Refund -> Capture
          • Refund -> AuthorizeAndCapture
        • rawResponse
          String rawResponse
          The string representation of the serialized response from the gateway. This is usually the complete response parameter map serialized in string form.
        • subtotal
          javax.money.MonetaryAmount subtotal
          The payment's total usually excluding adjustments, tax, fees, and shipping.
        • taxTotal
          javax.money.MonetaryAmount taxTotal
          The payment's total tax cost.
        • threeDSecureVerificationUrl
          String threeDSecureVerificationUrl
          The gateway-provided url where the customer must verify that they are in fact the owner of the payment method. The customer is typically redirected to this location, but the page can also be rendered within an iframe if this is supported by the gateway.
        • transactionAmount
          javax.money.MonetaryAmount transactionAmount
          The transaction amount that we're expecting to execute against the PaymentSummary. This amount must be valid according to what's available for the PaymentSummary. If specified, the amount details should be equal to this amount using the following equation: transactionAmount = TransactionExecutionDetail.subtotal + TransactionExecutionDetail.fulfillmentTotal + TransactionExecutionDetail.feesTotal - TransactionExecutionDetail.adjustmentsTotal + TransactionExecutionDetail.taxTotal - TransactionExecutionDetail.includedTaxTotal.
        • transactionId
          String transactionId
          The id of the executed transaction.
        • transactionReferenceId
          String transactionReferenceId
          The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
        • transactionStatus
          String transactionStatus
          The status of the transaction.
          See Also:

    • Class com.broadleafcommerce.billing.service.provider.domain.TransactionExecutionRequest

      class TransactionExecutionRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustmentsTotal
          javax.money.MonetaryAmount adjustmentsTotal
          The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts. Note: Only the TransactionExecutionRequest.transactionAmount is required, but if this value is included, then the TransactionExecutionRequest.subtotal, TransactionExecutionRequest.fulfillmentTotal, TransactionExecutionRequest.feesTotal, TransactionExecutionRequest.taxTotal, & TransactionExecutionRequest.includedTaxTotal should be included also.
        • feesTotal
          javax.money.MonetaryAmount feesTotal
          The total fees related to the TransactionExecutionRequest.transactionAmount Note: Only the TransactionExecutionRequest.transactionAmount is required, but if this value is included, then the TransactionExecutionRequest.subtotal, TransactionExecutionRequest.fulfillmentTotal, TransactionExecutionRequest.adjustmentsTotal, TransactionExecutionRequest.taxTotal, & TransactionExecutionRequest.includedTaxTotal should be included also.
        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The payment's total fulfillment cost. Note: Only the TransactionExecutionRequest.transactionAmount is required, but if this value is included, then the TransactionExecutionRequest.subtotal, TransactionExecutionRequest.feesTotal, TransactionExecutionRequest.adjustmentsTotal, TransactionExecutionRequest.taxTotal, & TransactionExecutionRequest.includedTaxTotal should be included also.
        • includedTaxTotal
          javax.money.MonetaryAmount includedTaxTotal
          The amount of taxes that are included in the subtotal (VAT). Note: Only the TransactionExecutionRequest.transactionAmount is required, but if this value is included, then the TransactionExecutionRequest.subtotal, TransactionExecutionRequest.fulfillmentTotal, TransactionExecutionRequest.feesTotal, TransactionExecutionRequest.adjustmentsTotal, & TransactionExecutionRequest.taxTotal should be included also.
        • requestId
          String requestId
          The id representing the customer's request to execute one or more transactions.
        • source
          String source
          A simple description of the system that initiated this transaction execution request.
        • sourceEntityId
          String sourceEntityId
          The ID of the source entity associated with the transaction.

          For example, if TransactionExecutionRequest.getSourceEntityType() is ORDER_FULFILLMENT, this would be the ID of the OrderFulfillment.

          See Also:
        • sourceEntityType
          String sourceEntityType
          The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST" or "ORDER_FULFILLMENT".
        • subtotal
          javax.money.MonetaryAmount subtotal
          The payment's total usually excluding adjustments, tax, fees, and shipping. Note: Only the TransactionExecutionRequest.transactionAmount is required, but if this value is included, then the TransactionExecutionRequest.fulfillmentTotal, TransactionExecutionRequest.feesTotal, TransactionExecutionRequest.adjustmentsTotal, TransactionExecutionRequest.taxTotal, & TransactionExecutionRequest.includedTaxTotal should be included also.
        • taxTotal
          javax.money.MonetaryAmount taxTotal
          The payment's total tax cost. Note: Only the TransactionExecutionRequest.transactionAmount is required, but if this value is included, then the TransactionExecutionRequest.subtotal, TransactionExecutionRequest.fulfillmentTotal, TransactionExecutionRequest.feesTotal, TransactionExecutionRequest.adjustmentsTotal, & TransactionExecutionRequest.includedTaxTotal should be included also.
        • transactionAmount
          javax.money.MonetaryAmount transactionAmount
          The transaction amount that we're expecting to execute against the payment. This amount must be valid according to what's available for the payment. If specified, the amount details should be equal to this amount using the following equation: transactionAmount = TransactionExecutionRequest.subtotal + TransactionExecutionRequest.fulfillmentTotal + TransactionExecutionRequest.feesTotal - TransactionExecutionRequest.adjustmentsTotal + TransactionExecutionRequest.taxTotal - TransactionExecutionRequest.includedTaxTotal.

    • Class com.broadleafcommerce.billing.service.provider.domain.TransactionExecutionResponse

      class TransactionExecutionResponse extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustmentsTotal
          javax.money.MonetaryAmount adjustmentsTotal
          The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
        • expectedTotalAmount
          javax.money.MonetaryAmount expectedTotalAmount
          The total amount that we're expecting to be executed against the TransactionExecutionResponse.paymentSummary, spread across the TransactionExecutionResponse.transactionExecutionDetails. This amount must be valid according to what's available for the TransactionExecutionResponse.paymentSummary. If specified, the amount details (TransactionExecutionResponse.subtotal, TransactionExecutionResponse.adjustmentsTotal, TransactionExecutionResponse.fulfillmentTotal, & TransactionExecutionResponse.taxTotal) should sum together to equal this amount.
        • feesTotal
          javax.money.MonetaryAmount feesTotal
          The total fees related to the TransactionExecutionResponse.expectedTotalAmount
        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The payment's total fulfillment cost.
        • includedTaxTotal
          javax.money.MonetaryAmount includedTaxTotal
          The amount of taxes that are included in the subtotal (VAT).
        • paymentSummary
          PaymentSummary paymentSummary
          The payment's updated PaymentSummary representation.

          This can be null if the payment is archived as a result of a failed transaction.

        • requestId
          String requestId
          The id representing the customer's request to execute one or more transactions.
        • subtotal
          javax.money.MonetaryAmount subtotal
          The payment's total usually excluding adjustments, tax, fees, and shipping.
        • taxTotal
          javax.money.MonetaryAmount taxTotal
          The payment's total tax cost.
        • transactionExecutionDetails
          List<TransactionExecutionDetail> transactionExecutionDetails
          A list of TransactionExecutionDetails describing the transactions executed.

          Typically there will only be multiple transactions being executed if there're multiple parent transactions being executed against. This scenario is very unlikely and not expected out of box for non-refund type transactions, however it is supported.

        • transactionType
          String transactionType
          The type of transactions that were executed.

  • Package com.broadleafcommerce.billing.service.provider.external.exception

  • Package com.broadleafcommerce.billing.web.endpoint.domain

  • Package com.broadleafcommerce.deadletter.provider.jpa.domain

  • Package com.broadleafcommerce.messaging

  • Package com.broadleafcommerce.subscription.domain

    • Class com.broadleafcommerce.subscription.domain.CancellationPolicy

      class CancellationPolicy extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • attributes
          Map<String,Object> attributes
          Contains any additional properties of a permission that do not fit in the above fields.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • description
          String description
          The description of the CancellationPolicy.
        • id
          String id
          The Id of the CancellationPolicy.
        • name
          String name
          The name of the CancellationPolicy.
        • policyRules
          String policyRules
          Policy applicability rules to identify the policy that should be used for the subscription. Utilizes a RuleBuilder.
        • postpaidPolicyDetail
          CancellationPolicyDetail postpaidPolicyDetail
          The CancellationPolicyDetail with details for targets using a postpaid payment strategy.
        • prepaidPolicyDetail
          CancellationPolicyDetail prepaidPolicyDetail
          The CancellationPolicyDetail with details for targets using a prepaid payment strategy.
        • priority
          Integer priority
          The priority of this cancellation policy. This is to enforce ordering when a subscription may match with multiple policies. A lower value indicates higher priority.
        • requiresDirectReference
          boolean requiresDirectReference
          Whether the policy is only eligible to be used via Product or PriceData references.

    • Class com.broadleafcommerce.subscription.domain.CancellationPolicyDetail

      class CancellationPolicyDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • allowCancellation
          boolean allowCancellation
          Whether the customer can cancel their service before the end of the agreement.
        • attributes
          Map<String,Object> attributes
          Contains any additional properties of a permission that do not fit in the above fields.
        • cancellationFeeProductId
          String cancellationFeeProductId
          Reference to a product that holds an additional cancellation fee.
        • cancellationStrategy
          String cancellationStrategy
          The ways in which a subscription can be cancelled.
          See Also:
        • chargeForPreviouslyReceivedDiscountAmounts
          boolean chargeForPreviouslyReceivedDiscountAmounts
          Whether the customer should be charged for any discounts he/she received before cancelling the subscription.
        • chargeForRemainderOfTerms
          boolean chargeForRemainderOfTerms
          Whether the customer should be charged for the remainder of the term despite cancelling the subscription.
        • chargeFullPriceForRemainderOfTerms
          boolean chargeFullPriceForRemainderOfTerms
          Whether the customer should be charged the full, unadjusted (un-discounted) price when cancelling.
        • chargeStrategy
          String chargeStrategy
          The ways in which a subscription's cancellation charge can be collected.
          See Also:
        • gracePeriodCancellationFeeProductId
          String gracePeriodCancellationFeeProductId
          The CancellationPolicyDetail.getCancellationFeeProductId() in the grace period context.
        • gracePeriodCancellationStrategy
          String gracePeriodCancellationStrategy
          The CancellationStrategy in grace period context.
        • gracePeriodChargeStrategy
          String gracePeriodChargeStrategy
          The ChargeStrategy in grace period context.
        • gracePeriodDurationInDays
          Integer gracePeriodDurationInDays
          Duration of the initial grace period in days.
        • gracePeriodRecursEachBillingPeriod
          boolean gracePeriodRecursEachBillingPeriod
          Whether the grace period resets after each billing period. If "true", the grace period may be applicable at the beginning of the subscription and if "false" it may recur with each billing cycle.

          For “terms”, this would typically be false.

        • gracePeriodSupported
          boolean gracePeriodSupported
          Whether grace period properties are enabled.

          The grace period is a time-window (typically ~7 days) in which the cancellation policy can differ from the normal cancellation policy. This period occurs just after the subscription’s Auto Renewal. For products without a contract, the grace period opens at the beginning of each period. For products with a contract, the grace period opens at the beginning of the contract & each contract renewal.

    • Class com.broadleafcommerce.subscription.domain.DelayedSubscriptionAction

      class DelayedSubscriptionAction extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.subscription.domain.PriceDataChange

      class PriceDataChange extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalProperties
          Map<String,Object> additionalProperties
          Any additional information related to the price change.
        • afterRecurringPrice
          BigDecimal afterRecurringPrice
          The price after the change
        • beforeRecurringPrice
          BigDecimal beforeRecurringPrice
          The price before the change
        • id
          String id
          An identifying label for this change. Generally relates back to an idempotent reference for the source of the change. This is a measure to allow repeat execution of the source flow without introducing duplicate price data change records on the subscription, since the equals and hashcode will be influenced by this field.
        • priceChangeEffectiveType
          String priceChangeEffectiveType
          The descriptor of when the price change should take effect.
          See Also:
        • priceDataId
          String priceDataId
          The ID of the price data that is changed

    • Class com.broadleafcommerce.subscription.domain.PriceDataChangeRequest

      class PriceDataChangeRequest extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.subscription.domain.Subscription

      class Subscription extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • allowAutoRenewalModification
          boolean allowAutoRenewalModification
          This flag indicates whether this subscription's auto-renewability can be modified after declaration on the subscription.
        • alternateUserRef
          String alternateUserRef
          Alternate reference to the user. Useful for third-party authentication system identifiers
        • alternateUserRefType
          String alternateUserRefType
          Type of alternative reference to the subscription owner
        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this subscription.
        • autoRenewalEnabled
          boolean autoRenewalEnabled
          Whether this subscription automatically renews at the end of the current subscription term.
        • billingFrequency
          String billingFrequency
          Deprecated.
          in favor of Subscription.periodType & Subscription.periodFrequency
          Frequency of billing for this subscription
          See Also:
        • cancellationPolicyRef
          String cancellationPolicyRef
          A reference (typically the Id) of the CancellationPolicy for this subscription that governs how this subscription would be cancelled.
        • chargeback
          Boolean chargeback
          Whether this subscription is being cancelled due to a chargeback
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • createdDate
          Date createdDate
          Date this subscription was created. This field should not be updated or set by a request.
        • currency
          @NotNull javax.money.CurrencyUnit currency
          Currency of this subscription
        • currencyCode
          @NotBlank String currencyCode
          Deprecated.
          use Subscription.getCurrency() field instead
        • customerTimezone
          String customerTimezone
          The customer's timezone. It's an optional field used to truncate the dates to the beginning of the day in customer's timezone. If null, UTC time is used.
        • delayedActions
          List<DelayedSubscriptionAction> delayedActions
          List of delayed actions for this subscription.

          Often, these delayed actions are related to requested actions against a subscription with a DefaultSubscriptionPaymentStrategy.PREPAID Subscription.getPaymentStrategy() where instead of refunding the customer, the action is delayed until the end of the period, causing the next period to naturally identify the updated price.

        • endOfTermDate
          Instant endOfTermDate
          The end of term date for this subscription.
        • fulfillmentWorkflow
          String fulfillmentWorkflow
          A reference to the workflow used to fulfill the creation of, & modifications to, this subscription.
        • id
          String id
        • internalAttributes
          Map<String,Object> internalAttributes
          Miscellaneous internal attributes for this subscription. Distinguished from Subscription.getAttributes() in that this map is used for attributes that assist in the internal working of Broadleaf.
        • lastBillingBatchId
          String lastBillingBatchId
          The batch id of the last billing job run for this subscription
        • lastBillingOperationStatus
          String lastBillingOperationStatus
          The most current status of the last BillingEvent for this subscription
          See Also:
        • lastBillingSuccessDate
          Date lastBillingSuccessDate
          Last date this that the Billing Job succeeded billing this subscription
        • name
          String name
          Name of this subscription
        • needGrantEntitlements
          boolean needGrantEntitlements
          Whether the system has outstanding entitlements to grant on this subscription

          Note that this field does not have any effects if Entitlements are disabled in {@link BillingJobProperties#getEntitlements()#isEnabled()}

        • nextBillDate
          Date nextBillDate
          Next date this subscription will be billed
        • nextPeriod
          Integer nextPeriod
          The next period this subscription will cover. This value is related to 'beginPeriod' and 'endPeriod' fields of SubscriptionAdjustment and SubscriptionItemAdjustment
        • nextStatusChangeDate
          Date nextStatusChangeDate
          Date when the next status should begin
          See Also:
          • Subscription.subscriptionNextStatus
        • nextStatusChangeReason
          String nextStatusChangeReason
          Reason for the update to the next status
          See Also:
          • Subscription.subscriptionNextStatus
        • nextSubscription
          String nextSubscription
          If this subscription was upgraded or downgraded, holds the reference to the subscription replacing this one
        • paymentStrategy
          String paymentStrategy
          Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.
          See Also:
        • periodFrequency
          Integer periodFrequency
          The frequency with which the recurring price should be charged., e.g., a value of 1 combined with Subscription.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.
          See Also:
          • Subscription.periodType
        • periods
          List<SubscriptionPeriod> periods
          List tracking the Subscription's periods. Typically, this correlates to the set of periods for which a BillingEvent has been created.
        • periodType
          String periodType
          The period type for the price, e.g. MONTHLY, QUARTERLY, ANNUALLY
          See Also:
        • preferredPaymentAccountId
          String preferredPaymentAccountId
          References an identifier of a PaymentAccount that is considered preferred for this subscription. Overrides the ordering of accounts as provided by SavedPaymentMethodProvider
        • priceDataChanges
          List<PriceDataChange> priceDataChanges
          List of price data changes for this subscription
        • priorBillDate
          Date priorBillDate
          The bill date for the previous period
        • resumeDate
          Date resumeDate
          Date this subscription will or did continue. This is likely to be used only after a subscription was paused or stopped.
        • rootItemRef
          String rootItemRef
          Reference to the item id for which this subscription was provision
        • rootItemRefType
          String rootItemRefType
          Type of the item for which this subscription was provisioned.
          See Also:
        • secondarySourceRef
          String secondarySourceRef
          The secondary source to reference, e.g, an Order Item on an Order. Optional.
          See Also:
          • Subscription.secondarySourceType
        • secondarySourceType
          String secondarySourceType
          The type of the secondary source to reference, e.g, an Order Item on an Order. Optional.
          See Also:
        • siteIdentifier
          String siteIdentifier
          Multi-tenancy support
        • startOfTermDate
          Instant startOfTermDate
          The start of term date for this subscription.
        • subscriptionAdjustments
          List<SubscriptionAdjustment> subscriptionAdjustments
          Adjustments for this subscription. This may be present on incoming API requests such as when creating a subscription with its items, but otherwise is only populated in responses when part of a SubscriptionWithItems.
        • subscriptionId
          @Size(max=255) String subscriptionId
          Deprecated.
          Use Subscription.getId() field instead
        • subscriptionNextStatus
          String subscriptionNextStatus
          Next status for this subscription
          See Also:
        • subscriptionSource
          @NotBlank String subscriptionSource
          This field shows from which process or user action this subscription originated.
          See Also:
        • subscriptionSourceRef
          String subscriptionSourceRef
          This field shows the identifier of the process or user action this subscription originated.
          See Also:
          • Subscription.subscriptionSource
        • subscriptionStatus
          String subscriptionStatus
          Current status of this subscription
          See Also:
        • termDurationLength
          Integer termDurationLength
          The length of the terms, e.g., if this is 36 and Subscription.termDurationType is MONTHS, then the user should be billed for 36 months.
          See Also:
          • Subscription.termDurationType
        • termDurationType
          String termDurationType
          The term duration type, e.g. DAYS, WEEKS, MONTHS, YEARS.
          See Also:
          • Subscription.termDurationLength
        • updatedBy
          String updatedBy
          Deprecated.
          Use ContextInfo.setAuthor(String) instead
        • userRef
          @NotBlank String userRef
          Reference to the user to whom this subscription belongs
        • userRefType
          String userRefType
          Type of user owning this subscription
          See Also:
        • version
          Integer version
          The version of this subscription. Used for checking if the requested version of the subscription is up-to-date before saving changes. This should never be manually decremented/incremented.

    • Class com.broadleafcommerce.subscription.domain.SubscriptionItem

      class SubscriptionItem extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • addOnKey
          String addOnKey
          If this item was the result of an add-on, then this stores the key of the add-on in the context of its parent. This is important when editing a subscription in order to recreate the original cart item.
        • archived
          boolean archived
          Whether this item is archived
        • archiveReason
          String archiveReason
          Why this item was archived
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • id
          @Size(max=255) String id
        • internalAttributes
          Map<String,Object> internalAttributes
          Miscellaneous internal attributes for this subscription item.
        • itemDetails
          Map<String,String> itemDetails
          Additional details about the item
        • itemName
          String itemName
          Item name
        • itemRef
          String itemRef
          Reference to the id of the item represented by this object
        • itemRefType
          String itemRefType
          Type of item that this object represents
        • itemSku
          String itemSku
          SKU of the item represented by this object.
        • itemSourceRef
          String itemSourceRef
          This field shows the identifier of the process or user action this subscription item originated.
          See Also:
          • SubscriptionItem.itemSourceType
        • itemSourceType
          String itemSourceType
          This field shows from which process or user action this subscription item originated.
          See Also:
        • itemUnitPrice
          BigDecimal itemUnitPrice
          Unit price of the item (price of a single unit)
        • parentItemRef
          String parentItemRef
          Reference of the parent subscription item's backing item if this is a child subscription item
        • parentItemRefType
          String parentItemRefType
          Type of the parent subscription item's backing item if this is a child subscription item
        • priceDataId
          String priceDataId
          The id of the price data associated with this item.
        • priceListId
          String priceListId
          The id of the price list associated with this item.
        • quantity
          Integer quantity
          Quantity purchased. Note: this value is scaled by parent item quantity.
        • secondarySourceRef
          String secondarySourceRef
          The secondary source to reference, e.g, an Order Item on an Order. Optional.
          See Also:
          • SubscriptionItem.secondarySourceType
        • secondarySourceType
          String secondarySourceType
          The type of the secondary source to reference, e.g, an Order Item on an Order. Optional.
          See Also:
        • subscriptionId
          @Size(max=255) @NotBlank String subscriptionId
          Reference the subscription for this item
        • subscriptionItemAdjustments
          List<SubscriptionItemAdjustment> subscriptionItemAdjustments
          Adjustments for this subscription. This may be present on incoming API requests such as when creating a subscription with its items, but otherwise is only populated in responses when part of a SubscriptionWithItems.
        • taxable
          Boolean taxable
          Whether this item is taxable
        • taxCategory
          String taxCategory
          Tax category of the item
        • taxNexus
          String taxNexus
          Comma-separated nexus codes

    • Class com.broadleafcommerce.subscription.domain.SubscriptionOwnerInfo

      class SubscriptionOwnerInfo extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • applicationId
          String applicationId
          The application associated with the subscription
        • subscriptionId
          String subscriptionId
          Identifier for the subscription
        • userRef
          String userRef
          Reference to the user to whom this subscription belongs. Generally, this is an account reference.
        • userRefType
          String userRefType
          Type of user owning this subscription

    • Class com.broadleafcommerce.subscription.domain.SubscriptionPeriod

      class SubscriptionPeriod extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • attributes
          Map<String,Object> attributes
          Any additional attributes used to describe the period
        • billDate
          Date billDate
          The bill date of the period
        • isFreeTrial
          boolean isFreeTrial
          Whether this period represents a free trial period.

          When this is true, the periodStartDate and periodEndDate represents the start and end dates of the free trial, and the period number will be 0.

        • numberOfDaysInFullPeriod
          Long numberOfDaysInFullPeriod
          If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the full period - i.e. the length of the period if it had not been shortened. Otherwise, this value will be null. If the period is shortened, this value should be used in combination with SubscriptionPeriod.getNumberOfDaysInShortenedPeriod() to prorate subscription pricing for the subscription period. SubscriptionPeriod.numberOfDaysInShortenedPeriod divided by SubscriptionPeriod.getNumberOfDaysInFullPeriod() gives the proration rate.
        • numberOfDaysInShortenedPeriod
          Long numberOfDaysInShortenedPeriod
          If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the shortened period. Otherwise, this value will be null. If the period is shortened, this value should be used in combination with SubscriptionPeriod.getNumberOfDaysInFullPeriod() to prorate subscription pricing for the subscription period. SubscriptionPeriod.numberOfDaysInShortenedPeriod divided by SubscriptionPeriod.getNumberOfDaysInFullPeriod() gives the proration rate.
        • period
          Integer period
          The period number
        • periodEndDate
          Date periodEndDate
          The end date of the period
        • periodStartDate
          Date periodStartDate
          The start date of the period
        • shortenedPeriodReason
          String shortenedPeriodReason
          Describes the reason that the period was shortened.
          See Also:

    • Class com.broadleafcommerce.subscription.domain.SubscriptionWithItems

      class SubscriptionWithItems extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.subscription.domain.SubscriptionWithItemsAndAdjustments

      class SubscriptionWithItemsAndAdjustments extends SubscriptionWithItems implements Serializable

  • Package com.broadleafcommerce.subscription.domain.adjustment

    • Class com.broadleafcommerce.subscription.domain.adjustment.CurrencyConversionDetail

      class CurrencyConversionDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • rate
          BigDecimal rate
          The conversion factor to convert CurrencyConversionDetail.sourceCurrencyCode to the CurrencyConversionDetail.targetCurrencyCode.
        • sourceCurrencyCode
          String sourceCurrencyCode
          The CurrencyUnit.getCurrencyCode() of the base (source) from which to convert.
        • targetCurrencyCode
          String targetCurrencyCode
          The CurrencyUnit.getCurrencyCode() of the converted (target) to which to convert.

    • Class com.broadleafcommerce.subscription.domain.adjustment.OfferItemDetail

      class OfferItemDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • fulfillmentItemDetail
          boolean fulfillmentItemDetail
          Indicates if this detail is for a fulfillment item.
        • itemAdjustmentQuantity
          int itemAdjustmentQuantity
          The quantity of the qualifier or target item that this offer was applied to.
        • itemId
          String itemId
          The id of the item that is a qualifier or target.
        • offerId
          String offerId
          The offer id where this item is a qualifier or target of.
        • offerUses
          int offerUses
          The number of times the offer is applied.
        • quantityPerUsage
          int quantityPerUsage
          The quantity per offer usage of the item that is a qualifier or target.

    • Class com.broadleafcommerce.subscription.domain.adjustment.SubscriptionAdjustment

      class SubscriptionAdjustment extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustmentAmount
          BigDecimal adjustmentAmount
          Amount of this adjustment
        • adjustmentCartLabel
          String adjustmentCartLabel
          Friendly label to display in the cart or to a customer in general instead of the SubscriptionAdjustment.adjustmentName.
        • adjustmentCodeRef
          String adjustmentCodeRef
          A reference to the Offer Code (if any).
        • adjustmentDescription
          String adjustmentDescription
          A description of what benefits the adjustment provides to a customer.
        • adjustmentDiscountFactor
          BigDecimal adjustmentDiscountFactor
          The discount factor by which to discount a target. If the amount is 10, then whether it is calculated as a percentage (10%) or a currency amount ($10) is determined by SubscriptionAdjustment.getAdjustmentDiscountMethodType(). This does not represent that actual amount discounted from the target.
        • adjustmentDiscountMethodType
          String adjustmentDiscountMethodType
          Determines the method used to apply the discount. Typically in Broadleaf, the SubscriptionAdjustment.getSubscriptionAdjustmentType() ends up as DefaultSubscriptionAdjustmentType.AMOUNT_OFF since the offer system calculates the actual amount to discount even if the base offer was a percentage off or fixed price. This field then is distinguished as the actual method specified on the offer before it was applied.
        • adjustmentId
          @Size(max=255) String adjustmentId
          Deprecated.
          Use SubscriptionAdjustment.getId() field instead
        • adjustmentName
          String adjustmentName
          Name of the adjustment applied.
        • adjustmentProrationType
          String adjustmentProrationType
          Determines how an adjustment's discount amount is distributed across the adjustment's related item types. This can either be set to prorate across target items or target and qualifier items.
        • adjustmentRef
          @NotBlank String adjustmentRef
          Reference to the promotion or offer that drives this adjustment
        • adjustmentType
          SubscriptionAdjustmentType adjustmentType
          Deprecated.
          in favor of SubscriptionAdjustment.getSubscriptionAdjustmentType()
        • beginPeriod
          @PositiveOrZero Integer beginPeriod
          Number of the billing period this adjustment starts being active
        • campaignTrackingId
          String campaignTrackingId
          The campaign tracking id (if any) for this adjustment.
        • codeUsed
          String codeUsed
          The code used (if any) that triggered the application of the adjustment for this adjustment.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • discountType
          String discountType
          Defines the type of the discount, e.g., free trial, order discount, future credit, etc. This primarily determines when it should be applied to the order or items. This helps distinguish whether the adjustment applies at checkout or later such as for a subscription.
        • endPeriod
          Integer endPeriod
          Number of the billing period this adjustment stops. If this field is null, the adjustment is considered indefinite
        • freeTrialLength
          Integer freeTrialLength
          If SubscriptionAdjustment.discountType is FREE_TRIAL, then this defines the free trial's length.
          See Also:
          • SubscriptionAdjustment.freeTrialLengthUnits
        • freeTrialLengthUnits
          String freeTrialLengthUnits
          If SubscriptionAdjustment.discountType is FREE_TRIAL, then this defines the units for SubscriptionAdjustment.freeTrialLength.
          See Also:
          • SubscriptionAdjustment.freeTrialLength
        • id
          String id
        • subscriptionAdjustmentType
          String subscriptionAdjustmentType
          Type of this adjustment
          See Also:
        • subscriptionId
          @NotBlank String subscriptionId
          Reference to the Subscription whose price this adjusts

    • Class com.broadleafcommerce.subscription.domain.adjustment.SubscriptionAdjustmentType

      class SubscriptionAdjustmentType extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • friendlyType
          String friendlyType
          Deprecated.
        • type
          String type
          Deprecated.

  • Package com.broadleafcommerce.subscription.domain.exception

  • Package com.broadleafcommerce.subscription.event

  • Package com.broadleafcommerce.subscription.job.domain

  • Package com.broadleafcommerce.subscription.job.exception

  • Package com.broadleafcommerce.subscription.provider.jpa.domain

  • Package com.broadleafcommerce.subscription.provider.jpa.nontrackable.repository

  • Package com.broadleafcommerce.subscription.service

    • Class com.broadleafcommerce.subscription.service.SubscriptionLockRequest

      class SubscriptionLockRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • duration
          Long duration
          The duration of the lock
        • reservationCount
          Integer reservationCount
          The number of additional child locks that should be applied on the subscription with a randomly-generated a child lock identifier
        • reservationList
          List<String> reservationList
          A list of child lock identifiers that should be used to generate additional child locks on the subscription
        • subscriptionId
          String subscriptionId
          Id of the targeted Subscription

  • Package com.broadleafcommerce.subscription.web.domain

  • Package com.broadleafcommerce.subscription.web.endpoint.exception