Package de.hybris.platform.sap.saprevenuecloudorder.service

Interface SapRevenueCloudSubscriptionService

All Known Implementing Classes:
DefaultSapRevenueCloudSubscriptionService
@Deprecated(since="1905.10", forRemoval=true) public interface SapRevenueCloudSubscriptionService
Deprecated, for removal: This API element is subject to removal in a future version.
instead use BillService and SubscriptionService
Service API that provides methods for SAP RevenueCloud Subscription Orders

  • Method Details

    • getSubscriptionsByClientId

      List<Subscription> getSubscriptionsByClientId(String clientId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      fetch subscription details using customerId
      Parameters:
      clientId - customerId
      Returns:
      List list of subscriptions

    • getSubscriptionsWithPagination

      com.hybris.charon.RawResponse<List<Subscription>> getSubscriptionsWithPagination(String clientId, int pageNumber, int pageSize)
      Deprecated, for removal: This API element is subject to removal in a future version.
      fetch subscription details with Pagination
      Parameters:
      clientId - customerId
      pageNumber - pageNumber
      pageSize - pageSize
      Returns:
      Response

    • getSubscriptionById

      Subscription getSubscriptionById(String subscriptionsId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      fetch subscription details using subscriptionId
      Parameters:
      subscriptionsId - subscription code
      Returns:
      Subscription Subscription details

    • cancelSubscription

      void cancelSubscription(String code, CancelSubscription subscription)
      Deprecated, for removal: This API element is subject to removal in a future version.
      cancel a subscription based on subscription code
      Parameters:
      code - subscription code
      subscription - subscription data required for cancellation

    • withdrawSubscription

      void withdrawSubscription(String code, WithdrawSubscription subscription)
      Deprecated, for removal: This API element is subject to removal in a future version.
      withdraw a subscription based on subscription code
      Parameters:
      code - subscription code
      subscription - subscription data required for Withdrawal

    • extendSubscription

      @Deprecated(since="1905.09", forRemoval=true) void extendSubscription(String subscriptionCode, ExtendSubscription subscription)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Instead use extendSubscription( String, SubscriptionExtensionForm, boolean )
      extend a subscription based on subscription code
      Parameters:
      subscriptionCode - subscriptionId
      subscription - subscription data required for extending subscription

    • extendSubscription

      @Deprecated(since="1905.09", forRemoval=true) Subscription extendSubscription(String subscriptionCode, ExtendSubscription subscription, boolean simulate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Instead use extendSubscription( String, SubscriptionExtensionForm, boolean )
      extend a subscription based on subscription code
      Parameters:
      subscriptionCode - subscriptionId
      subscription - subscription data required for extending subscription
      simulate - simulation flag
      Returns:
      extension status

    • extendSubscription

      SubscriptionExtensionResponse extendSubscription(String subscriptionCode, SubscriptionExtensionForm subscription, boolean simulate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      extend a subscription based on subscription code
      Parameters:
      subscriptionCode - subscriptionId
      subscription - subscription data required for extending subscription
      simulate - simulation flag
      Returns:
      extension status

    • getBillingFrequency

      BillingFrequencyModel getBillingFrequency(ProductModel productModel)
      Deprecated, for removal: This API element is subject to removal in a future version.
      get billingFrequency for specific product
      Parameters:
      productModel - - product model
      Returns:
      BillingFrequencyModel

    • computeCancellationDate

      String computeCancellationDate(String subscriptionsId, String reqCancellationDate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      get effective end date for subscription
      Parameters:
      subscriptionsId - - subscription code
      reqCancellationDate - - requested cancellation date
      Returns:
      effective end date for subscription

    • getBillsBySubscriptionsId

      @Deprecated(since="1905.10", forRemoval=true) List<Bills> getBillsBySubscriptionsId(String subscriptionsId, String fromDate, String toDate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      instead use getBillsBySubscriptionsId(String, String, String, int, int, String)
      fetch bills using subscriptionId and dates
      Parameters:
      subscriptionsId - subscriptionId
      fromDate - the date from which bills should be displayed
      toDate - the date till which bills should be displayed
      Returns:
      List<Bills> list of bills based on the filter applied

    • getSubscriptionBillsById

      Bills getSubscriptionBillsById(String billId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      fetch bill using billId
      Parameters:
      billId - subscription billId
      Returns:
      Bills bill for the given id

    • getBillsBySubscriptionsId

      com.hybris.charon.RawResponse<List<BillsList>> getBillsBySubscriptionsId(String subscriptionsId, String fromDate, String toDate, int pageNumber, int pageSize, String sort)
      Deprecated, for removal: This API element is subject to removal in a future version.
      fetch bills using subscriptionId and dates
      Parameters:
      subscriptionsId - subscriptionId
      fromDate - the date from which bills should be displayed
      toDate - the date till which bills should be displayed
      pageNumber - pageNumber
      pageSize - pageSize
      sort - sort
      Returns:
      Response

    • getSubscriptionBillsByBillId

      BillsList getSubscriptionBillsByBillId(String billId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      fetch bill using billId
      Parameters:
      billId - subscription billId
      Returns:
      Bills bill for the given id

    • getSubscriptionCurrentUsage

      List<Bills> getSubscriptionCurrentUsage(String subscriptionId, String currentDate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      fetch usage of subscription in current billing cycle
      Parameters:
      subscriptionId - - id of subscription for which current usage is needed
      currentDate - - current date to fetch usage till current date in present billing cycle
      Returns:
      List<Bills> returns bills which contains current usage for given subscription

    • changePaymentDetails

      void changePaymentDetails(String code, ChangePaymentData changePaymentData)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Makes service call to change payment details of provided subscription code
      Parameters:
      code - - Subscription Id for which payment details needs to be changed
      changePaymentData - Payment details that is to be updated

    • reverseCancellation

      CancellationReversalResponse reverseCancellation(String code, CancellationReversal cancellationReversal)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reverses the cancellation of subscription
      Parameters:
      code - subscription id
      cancellationReversal - Cancellation Reversal
      Returns:
      Cancellation Reversal Response