Package de.hybris.platform.sap.saprevenuecloudorder.clients

Interface SapRevenueCloudSubscriptionClient

@Deprecated(since="1905.12",
            forRemoval=true)
public interface SapRevenueCloudSubscriptionClient

Deprecated, for removal: This API element is subject to removal in a future version.

charon is no longer supported, migrated to API registry

Method Summary

Modifier and Type	Method	Description
CancellationReversalResponse	cancellationReversal(String id, CancellationReversal cancellationReversal)	Deprecated, for removal: This API element is subject to removal in a future version.
void	cancelSubscription(String id, CancelSubscription subscription)	Deprecated, for removal: This API element is subject to removal in a future version.
void	changePaymentDetails(String id, ChangePaymentData changePaymentData)	Deprecated, for removal: This API element is subject to removal in a future version.
Subscription	createSubscription(Subscription subscription)	Deprecated, for removal: This API element is subject to removal in a future version.
void	extendSubscription(String id, ExtendSubscription subscription)	Deprecated, for removal: This API element is subject to removal in a future version.
Subscription	extendSubscription(String id, ExtendSubscription subscription, boolean simulation)	Deprecated, for removal: This API element is subject to removal in a future version.
SubscriptionExtensionResponse	extendSubscription(String id, SubscriptionExtensionForm subscription, boolean simulation)	Deprecated, for removal: This API element is subject to removal in a future version.
Subscription	getCancellationDate(String subscriptionsId, String reqCancellationDate)	Deprecated, for removal: This API element is subject to removal in a future version.
BillsList	getSubscriptionBillByBillId(String billId)	Deprecated, for removal: This API element is subject to removal in a future version.
Bills	getSubscriptionBillById(String billId)	Deprecated, for removal: This API element is subject to removal in a future version.
List<Bills>	getSubscriptionBills(String customerId, String fromDate, String toDate)	Deprecated, for removal: This API element is subject to removal in a future version. instead use getSubscriptionBills(String, String, String, Integer, Integer)
com.hybris.charon.RawResponse<List<BillsList>>	getSubscriptionBills(String customerId, String fromDate, String toDate, Integer pageNumber, Integer pageSize)	Deprecated, for removal: This API element is subject to removal in a future version.
Subscription	getSubscriptionById(String subscriptionsId)	Deprecated, for removal: This API element is subject to removal in a future version.
List<Bills>	getSubscriptionCurrentUsage(String subscriptionId, String fromDate)	Deprecated, for removal: This API element is subject to removal in a future version.
List<Subscription>	getSubscriptionsByClientId(String clientId)	Deprecated, for removal: This API element is subject to removal in a future version.
com.hybris.charon.RawResponse<List<Subscription>>	getSubscriptionsWithPagination(String clientId, Integer pageNumber, Integer pageSize, String sort)	Deprecated, for removal: This API element is subject to removal in a future version.
void	withdrawSubscription(String id, WithdrawSubscription subscription)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getSubscriptionsByClientId

@GET
@Path("/subscription/v1/subscriptions?customer.id={clientId}&sort=documentNumber,desc")
@Produces("application/json")
@Consumes("application/json")
List<Subscription> getSubscriptionsByClientId(@PathParam("clientId")
 String clientId)

Deprecated, for removal: This API element is subject to removal in a future version.

getSubscriptionsWithPagination

@GET
@Path("/subscription/v1/subscriptions")
@Produces("application/json")
@Consumes("application/json")
com.hybris.charon.RawResponse<List<Subscription>> getSubscriptionsWithPagination(@QueryParam("customer.id")
 String clientId,
 @QueryParam("pageNumber")
 Integer pageNumber,
 @QueryParam("pageSize")
 Integer pageSize,
 @QueryParam("sort")
 String sort)

Deprecated, for removal: This API element is subject to removal in a future version.

getSubscriptionById

@GET
@Path("/subscription/v1/subscriptions/{subscriptionsId}")
@Produces("application/json")
@Consumes("application/json")
Subscription getSubscriptionById(@PathParam("subscriptionsId")
 String subscriptionsId)

Deprecated, for removal: This API element is subject to removal in a future version.

createSubscription

@POST
@Path("/subscription/v1/subscriptions")
@Consumes("application/json")
@Produces("application/json")
Subscription createSubscription(Subscription subscription)

Deprecated, for removal: This API element is subject to removal in a future version.

cancelSubscription

@POST
@Path("/subscription/v1/subscriptions/{id}/cancellation")
@Consumes("application/json")
@Produces("application/json")
void cancelSubscription(@PathParam("id")
 String id,
 CancelSubscription subscription)

Deprecated, for removal: This API element is subject to removal in a future version.

withdrawSubscription

@POST
@Path("/subscription/v1/subscriptions/{id}/withdrawal")
@Consumes("application/json")
@Produces("application/json")
void withdrawSubscription(@PathParam("id")
 String id,
 WithdrawSubscription subscription)

Deprecated, for removal: This API element is subject to removal in a future version.

extendSubscription

@POST
@Path("/subscription/v1/subscriptions/{id}/extension")
@Consumes("application/json")
@Produces("application/json")
void extendSubscription(@PathParam("id")
 String id,
 ExtendSubscription subscription)

Deprecated, for removal: This API element is subject to removal in a future version.

changePaymentDetails

@POST
@Path("/subscription/v1/subscriptions/{id}/payment")
@Consumes("application/json")
@Produces("application/json")
void changePaymentDetails(@PathParam("id")
 String id,
 ChangePaymentData changePaymentData)

Deprecated, for removal: This API element is subject to removal in a future version.

getCancellationDate

@GET
@Path("/subscription/v1/subscriptions/{id}/computedcancellationdate?requestedCancellationDate={reqCancellationDate}")
@Produces("application/json")
@Consumes("application/json")
Subscription getCancellationDate(@PathParam("id")
 String subscriptionsId,
 @PathParam("reqCancellationDate")
 String reqCancellationDate)

Deprecated, for removal: This API element is subject to removal in a future version.

extendSubscription

@POST
@Path("/subscription/v1/subscriptions/{id}/extension")
@Consumes("application/json")
@Produces("application/json")
Subscription extendSubscription(@PathParam("id")
 String id,
 ExtendSubscription subscription,
 @QueryParam("simulation")
 boolean simulation)

Deprecated, for removal: This API element is subject to removal in a future version.

extendSubscription

@POST
@Path("/subscription/v1/subscriptions/{id}/extension")
@Consumes("application/json")
@Produces("application/json")
SubscriptionExtensionResponse extendSubscription(@PathParam("id")
 String id,
 SubscriptionExtensionForm subscription,
 @QueryParam("simulation")
 boolean simulation)

Deprecated, for removal: This API element is subject to removal in a future version.

getSubscriptionBills

@GET
@Path("/bill/v1/bills?customerId={customerId}&from={fromDate}&to={toDate}")
@Produces("application/json")
@Consumes("application/json")
@Deprecated(since="1905.10",
            forRemoval=true)
List<Bills> getSubscriptionBills(@PathParam("customerId")
 String customerId,
 @PathParam("fromDate")
 String fromDate,
 @PathParam("toDate")
 String toDate)

Deprecated, for removal: This API element is subject to removal in a future version.

instead use getSubscriptionBills(String, String, String, Integer, Integer)

Parameters:

customerId - subscription billing customer id

fromDate - from date of bills

toDate - to date of bill

Returns:

list of Bills

getSubscriptionCurrentUsage

@GET
@Path("/bill/v1/bills?subscriptionId={subscriptionId}&from={fromDate}")
@Produces("application/json")
@Consumes("application/json")
List<Bills> getSubscriptionCurrentUsage(@PathParam("subscriptionId")
 String subscriptionId,
 @PathParam("fromDate")
 String fromDate)

Deprecated, for removal: This API element is subject to removal in a future version.

getSubscriptionBillById

@GET
@Path("/bill/v1/bills/{billId}")
@Produces("application/json")
@Consumes("application/json")
Bills getSubscriptionBillById(@PathParam("billId")
 String billId)

Deprecated, for removal: This API element is subject to removal in a future version.

cancellationReversal

@POST
@Path("/subscription/v1/subscriptions/{id}/cancellationreversal")
@Consumes("application/json")
@Produces("application/json")
CancellationReversalResponse cancellationReversal(@PathParam("id")
 String id,
 CancellationReversal cancellationReversal)

Deprecated, for removal: This API element is subject to removal in a future version.

getSubscriptionBills

@GET
@Path("/bill/v2/bills")
@Produces("application/json")
@Consumes("application/json")
com.hybris.charon.RawResponse<List<BillsList>> getSubscriptionBills(@QueryParam("customer.id")
 String customerId,
 @QueryParam("from")
 String fromDate,
 @QueryParam("to")
 String toDate,
 @QueryParam("pageNumber")
 Integer pageNumber,
 @QueryParam("pageSize")
 Integer pageSize)

Deprecated, for removal: This API element is subject to removal in a future version.

getSubscriptionBillByBillId

@GET
@Path("/bill/v2/bills/{billId}")
@Produces("application/json")
@Consumes("application/json")
BillsList getSubscriptionBillByBillId(@PathParam("billId")
 String billId)

Deprecated, for removal: This API element is subject to removal in a future version.