SubscriptionApi (Kill Bill apis 0.13.0 API)

All Superinterfaces:

KillbillApi
```
public interface SubscriptionApi
extends KillbillApi
```
API to manage the retrieval of Subscription information.

Method Summary

Methods
Modifier and Type	Method and Description
`SubscriptionBundle`	`getActiveSubscriptionBundleForExternalKey(String externalKey, TenantContext context)` Retrieves all the `SubscriptionBundle` for the given external key.
`SubscriptionBundle`	`getSubscriptionBundle(UUID bundleId, TenantContext context)` Retrieves all the `Subscription` attached to the base entitlement.
`Pagination<SubscriptionBundle>`	`getSubscriptionBundles(Long offset, Long limit, TenantContext context)`
`List<SubscriptionBundle>`	`getSubscriptionBundlesForAccountId(UUID accountId, TenantContext context)` Retrieves all the `SubscriptionBundle` for a given account.
`List<SubscriptionBundle>`	`getSubscriptionBundlesForAccountIdAndExternalKey(UUID accountId, String externalKey, TenantContext context)` Retrieves all the `SubscriptionBundle` for a given account and matching an external key.
`List<SubscriptionBundle>`	`getSubscriptionBundlesForExternalKey(String externalKey, TenantContext context)` Returns an ordered list of all `SubscriptionBundle` for a given external key.
`Subscription`	`getSubscriptionForEntitlementId(UUID entitlementId, TenantContext context)` Retrieves a `Subscription` For the entitlementId
`Pagination<SubscriptionBundle>`	`searchSubscriptionBundles(String searchKey, Long offset, Long limit, TenantContext context)` Find all `SubscriptionBundle` having their id, account id or external key matching the search key
`void`	`updateExternalKey(UUID bundleId, String newExternalKey, CallContext context)` Update the externalKey for a given bundle

Method Detail

getSubscriptionForEntitlementId

Subscription getSubscriptionForEntitlementId(UUID entitlementId,
                                           TenantContext context)
                                             throws SubscriptionApiException

Retrieves a Subscription For the entitlementId

Parameters:: entitlementId - the id of the entitlement associated with the subscription; context - the context
Returns:: the subscription
Throws:: SubscriptionApiException - if it odes not exist

getSubscriptionBundle
```
SubscriptionBundle getSubscriptionBundle(UUID bundleId,
                                       TenantContext context)
                                         throws SubscriptionApiException
```
Retrieves all the Subscription attached to the base entitlement.

Parameters:
bundleId - the id of the bundle
context - the context

Returns:
a list of subscriptions

Throws:

SubscriptionApiException - if the baseEntitlementId does not exist.

updateExternalKey

void updateExternalKey(UUID bundleId,
                     String newExternalKey,
                     CallContext context)

Update the externalKey for a given bundle

Parameters:: bundleId - ; bundle id; newExternalKey - : the new value for the externalKey; context - : the call context

getSubscriptionBundlesForAccountIdAndExternalKey

List<SubscriptionBundle> getSubscriptionBundlesForAccountIdAndExternalKey(UUID accountId,
                                                                        String externalKey,
                                                                        TenantContext context)
                                                                          throws SubscriptionApiException

Retrieves all the SubscriptionBundle for a given account and matching an external key.

Parameters:: accountId - the account id; externalKey - the external key; context - the context
Returns:: a SubscriptionBundle
Throws:: SubscriptionApiException - if there is n o such object matching the account and external key

getActiveSubscriptionBundleForExternalKey
```
SubscriptionBundle getActiveSubscriptionBundleForExternalKey(String externalKey,
                                                           TenantContext context)
                                                             throws SubscriptionApiException
```
Retrieves all the SubscriptionBundle for the given external key.
It is possible to have multiple SubscriptionBundle for a given external key in the system but only one will be active -- i.e. will contain Subscription in the active state.

Parameters:
externalKey - the external key
context - the context

Returns:
a SubscriptionBundle

Throws:

SubscriptionApiException - if there is no such object

getSubscriptionBundlesForExternalKey

List<SubscriptionBundle> getSubscriptionBundlesForExternalKey(String externalKey,
                                                            TenantContext context)
                                                              throws SubscriptionApiException

Returns an ordered list of all SubscriptionBundle for a given external key.

Returns:
Throws:: SubscriptionApiException

getSubscriptionBundlesForAccountId

List<SubscriptionBundle> getSubscriptionBundlesForAccountId(UUID accountId,
                                                          TenantContext context)
                                                            throws SubscriptionApiException

Retrieves all the SubscriptionBundle for a given account.

Parameters:: accountId - the account id; context - the context
Returns:: list of SubscriptionBundle
Throws:: SubscriptionApiException - if the account does not exist

getSubscriptionBundles

Pagination<SubscriptionBundle> getSubscriptionBundles(Long offset,
                                                    Long limit,
                                                    TenantContext context)

Parameters:: context - the user context; offset - the offset of the first result; limit - the maximum number of results to retrieve
Returns:: the list of SubscriptionBundle for that tenant

searchSubscriptionBundles

Pagination<SubscriptionBundle> searchSubscriptionBundles(String searchKey,
                                                       Long offset,
                                                       Long limit,
                                                       TenantContext context)

Find all SubscriptionBundle having their id, account id or external key matching the search key

Parameters:: searchKey - the search key; offset - the offset of the first result; limit - the maximum number of results to retrieve; context - the user context
Returns:: the list of SubscriptionBundle matching this search key for that tenant

Interface SubscriptionApi