org.killbill.billing.usage.api

Interface UsageUserApi

All Superinterfaces:

KillbillApi

public interface UsageUserApi
extends KillbillApi

Method Summary

Methods

Modifier and Type	Method and Description
List<RolledUpUsage>	getAllUsageForSubscription(UUID subscriptionId, List<org.joda.time.LocalDate> transitionDates, TenantContext context) Get usage information for a given subscription.
RolledUpUsage	getUsageForSubscription(UUID subscriptionId, String unitType, org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate, TenantContext context) Get usage information for a given subscription.
void	recordRolledUpUsage(SubscriptionUsageRecord usage, CallContext context) Bulk usage API when the external system (or the meter module) rolls-up usage data.

Method Detail

recordRolledUpUsage

void recordRolledUpUsage(SubscriptionUsageRecord usage,
                       CallContext context)

Bulk usage API when the external system (or the meter module) rolls-up usage data.

Parameters:

usage - the usage for a given period of time associated with a subscription

context - tenant context

getUsageForSubscription

RolledUpUsage getUsageForSubscription(UUID subscriptionId,
                                    String unitType,
                                    org.joda.time.LocalDate startDate,
                                    org.joda.time.LocalDate endDate,
                                    TenantContext context)

Get usage information for a given subscription.

Parameters:

subscriptionId - subscription id

unitType - unit type for this usage

startDate - start date of the usage period (with respect to the account timezone)

endDate - end date of the usage period (with respect to the account timezone)

context - tenant context

Returns:

usage data (rolled-up)

getAllUsageForSubscription

List<RolledUpUsage> getAllUsageForSubscription(UUID subscriptionId,
                                             List<org.joda.time.LocalDate> transitionDates,
                                             TenantContext context)

Get usage information for a given subscription.

Parameters:

subscriptionId - subscription id

context - tenant context

Returns:

usage data (rolled-up)