ISubscriptionCollection Interface

Package:
com.microsoft.store.partnercenter.subscriptions
Maven Artifact:
com.microsoft.store:partnercenter:1.15.3

Implements

IPartnerComponentString IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>>

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 and Description
abstract ISubscription byId(String subscriptionId)

Retrieves a specific customer subscription behavior.
abstract IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>> byOrder(String orderId)

Groups customer subscriptions by an order.
abstract IEntireEntityCollectionRetrievalOperations<Subscription,ResourceCollection<Subscription>> byPartner(String partnerId)

Groups customer subscriptions by a partner.
abstract ResourceCollection<Subscription> get()

Retrieves all subscriptions.
abstract ISubscriptionMonthlyUsageRecordCollection getUsageRecords()

Obtains the subscription usage records behavior for the customer.

Method Details

byId

public abstract ISubscription byId(String subscriptionId)

Retrieves a specific customer subscription behavior.

Parameters:

subscriptionId - The subscription identifier

Returns:

The customer subscription.

byOrder

public abstract IEntireEntityCollectionRetrievalOperations> byOrder(String orderId)

Groups customer subscriptions by an order.

Parameters:

orderId - The order id.

Returns:

The order subscriptions operations.

byPartner

public abstract IEntireEntityCollectionRetrievalOperations> byPartner(String partnerId)

Groups customer subscriptions by a partner.

Parameters:

partnerId - The partner id.

Returns:

The partner subscriptions operations.

get

public abstract ResourceCollection get()

Retrieves all subscriptions.

Returns:

The subscriptions.

getUsageRecords

public abstract ISubscriptionMonthlyUsageRecordCollection getUsageRecords()

Obtains the subscription usage records behavior for the customer.

Returns:

The customer subscription usage record.

Applies to