Package com.microsoft.store.partnercenter.subscriptions

Interface ISubscriptionCollection

All Superinterfaces:

IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>, IPartnerComponent<String>, IPartnerComponentString

All Known Implementing Classes:

SubscriptionCollectionOperations

public interface ISubscriptionCollection
extends IPartnerComponentString, IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>

Represents the behavior of the customer subscriptions as a whole.

Method Summary

Modifier and Type	Method	Description
ISubscription	byId(String subscriptionId)	Retrieves a specific customer subscription behavior.
IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>	byOrder(String orderId)	Groups customer subscriptions by an order.
IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>	byPartner(String partnerId)	Groups customer subscriptions by a partner.
ResourceCollection<Subscription>	get()	Retrieves all subscriptions.
ISubscriptionMonthlyUsageRecordCollection	getUsageRecords()	Obtains the subscription usage records behavior for the customer.

Methods inherited from interface com.microsoft.store.partnercenter.IPartnerComponent

getContext, getPartner

Method Details

getUsageRecords

ISubscriptionMonthlyUsageRecordCollection getUsageRecords()

Obtains the subscription usage records behavior for the customer.

Returns:

The customer subscription usage record.

byId

ISubscription byId(String subscriptionId)

Retrieves a specific customer subscription behavior.

Parameters:

subscriptionId - The subscription identifier

Returns:

The customer subscription.

get

ResourceCollection<Subscription> get()

Retrieves all subscriptions.

Specified by:

get in interface IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>

Returns:

The subscriptions.

byOrder

IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>> byOrder(String orderId)

Groups customer subscriptions by an order.

Parameters:

orderId - The order id.

Returns:

The order subscriptions operations.

byPartner

IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>> byPartner(String partnerId)

Groups customer subscriptions by a partner.

Parameters:

partnerId - The partner id.

Returns:

The partner subscriptions operations.