org.killbill.billing.entitlement.api

Interface Subscription

All Superinterfaces:

Entitlement, Entity

public interface Subscription
extends Entitlement

An Subscription is created using the SubscriptionApi

It contains its Entitlement and additional billing related information.

See Also:

SubscriptionApi

Nested Class Summary

Nested classes/interfaces inherited from interface org.killbill.billing.entitlement.api.Entitlement

Entitlement.EntitlementActionPolicy, Entitlement.EntitlementSourceType, Entitlement.EntitlementState

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.LocalDate	getBillingEndDate()
org.joda.time.LocalDate	getBillingStartDate()
org.joda.time.LocalDate	getChargedThroughDate()
String	getCurrentStateForService(String serviceName)
List<SubscriptionEvent>	getSubscriptionEvents()

Methods inherited from interface org.killbill.billing.entitlement.api.Entitlement

cancelEntitlementWithDate, cancelEntitlementWithDateOverrideBillingPolicy, cancelEntitlementWithPolicy, cancelEntitlementWithPolicyOverrideBillingPolicy, changePlan, changePlanOverrideBillingPolicy, changePlanWithDate, getAccountId, getBaseEntitlementId, getBundleId, getEffectiveEndDate, getEffectiveStartDate, getExternalKey, getLastActivePhase, getLastActivePlan, getLastActivePriceList, getLastActiveProduct, getLastActiveProductCategory, getSourceType, getState, uncancelEntitlement

Methods inherited from interface org.killbill.billing.util.entity.Entity

getCreatedDate, getId, getUpdatedDate

Method Detail

getBillingStartDate

org.joda.time.LocalDate getBillingStartDate()

Returns:

the date at which the billing started for that subscription

getBillingEndDate

org.joda.time.LocalDate getBillingEndDate()

Returns:

the date at which the billing stopped for that subscription

getChargedThroughDate

org.joda.time.LocalDate getChargedThroughDate()

Returns:

the date up to which that Subscription got invoiced

getCurrentStateForService

String getCurrentStateForService(String serviceName)

Returns:

for each service, the current state

getSubscriptionEvents

List<SubscriptionEvent> getSubscriptionEvents()

Returns:

the ordered list of transitions that occurred for that subscription