Uses of Interface
org.killbill.billing.entitlement.api.Entitlement

Packages that use Entitlement

Package	Description
org.killbill.billing.entitlement.api

Uses of Entitlement in org.killbill.billing.entitlement.api

Subinterfaces of Entitlement in org.killbill.billing.entitlement.api

Modifier and Type	Interface and Description
interface	Subscription An Subscription is created using the SubscriptionApi It contains its Entitlement and additional billing related information.

Methods in org.killbill.billing.entitlement.api that return Entitlement

Modifier and Type	Method and Description
Entitlement	EntitlementApi.addEntitlement(UUID bundleId, PlanPhaseSpecifier spec, List<PlanPhasePriceOverride> overrides, org.joda.time.LocalDate entitlementEffectiveDate, org.joda.time.LocalDate billingEffectiveDate, boolean isMigrated, Iterable<PluginProperty> properties, CallContext context) Adds an ADD_ON entitlement to previously created entitlement.
Entitlement	Entitlement.cancelEntitlementWithDate(org.joda.time.LocalDate effectiveDate, boolean overrideBillingEffectiveDate, Iterable<PluginProperty> properties, CallContext context) Cancels the Entitlement at the specified date.
Entitlement	Entitlement.cancelEntitlementWithDateOverrideBillingPolicy(org.joda.time.LocalDate effectiveDate, BillingActionPolicy billingPolicy, Iterable<PluginProperty> properties, CallContext context) Cancels the Entitlement at the specified date After this operation, the existing object becomes stale.
Entitlement	Entitlement.cancelEntitlementWithPolicy(Entitlement.EntitlementActionPolicy policy, Iterable<PluginProperty> properties, CallContext context) Cancel the Entitlement with a policy.
Entitlement	Entitlement.cancelEntitlementWithPolicyOverrideBillingPolicy(Entitlement.EntitlementActionPolicy policy, BillingActionPolicy billingPolicy, Iterable<PluginProperty> properties, CallContext context) Cancels the Entitlement at the specified date and overrides the default billing policy.
Entitlement	Entitlement.changePlan(String productName, BillingPeriod billingPeriod, String priceList, List<PlanPhasePriceOverride> overrides, Iterable<PluginProperty> properties, CallContext context) Change Entitlement plan using default policy.
Entitlement	Entitlement.changePlanOverrideBillingPolicy(String productName, BillingPeriod billingPeriod, String priceList, List<PlanPhasePriceOverride> overrides, org.joda.time.LocalDate effectiveDate, BillingActionPolicy billingPolicy, Iterable<PluginProperty> properties, CallContext context) Change Entitlement plan at the specified date and overrides the billing policy.
Entitlement	Entitlement.changePlanWithDate(String productName, BillingPeriod billingPeriod, String priceList, List<PlanPhasePriceOverride> overrides, org.joda.time.LocalDate effectiveDate, Iterable<PluginProperty> properties, CallContext context) Change Entitlement plan at the specified date.
Entitlement	EntitlementApi.createBaseEntitlement(UUID accountId, PlanPhaseSpecifier spec, String externalKey, List<PlanPhasePriceOverride> overrides, org.joda.time.LocalDate entitlementEffectiveDate, org.joda.time.LocalDate billingEffectiveDate, boolean isMigrated, Iterable<PluginProperty> properties, CallContext context) Create a new entitlement for that account.
Entitlement	EntitlementApi.createBaseEntitlementWithAddOns(UUID accountId, String externalKey, Iterable<EntitlementSpecifier> entitlementSpecifier, org.joda.time.LocalDate entitlementEffectiveDate, org.joda.time.LocalDate billingEffectiveDate, boolean isMigrated, Iterable<PluginProperty> properties, CallContext context) Create a new base entitlement and addOn entitlements for that account.
Entitlement	EntitlementApi.getEntitlementForId(UUID id, TenantContext context) Retrieves an Entitlement using its id.

Methods in org.killbill.billing.entitlement.api that return types with arguments of type Entitlement

Modifier and Type	Method and Description
List<Entitlement>	EntitlementApi.getAllEntitlementsForAccountId(UUID accountId, TenantContext context) Retrieves all the Entitlement for a given account.
List<Entitlement>	EntitlementApi.getAllEntitlementsForAccountIdAndExternalKey(UUID accountId, String externalKey, TenantContext context) Retrieves all the Entitlement for a given account and matching an external key.
List<Entitlement>	EntitlementApi.getAllEntitlementsForBundle(UUID bundleId, TenantContext context) Retrieves all the Entitlement attached to the base entitlement.