Aggregation Setup

Aggregation is a powerful tool which can be used to perform grouping of multiple subscriptions and thus rate-plans. In this section we are going to walk through a typical configuration.

The aggregating subscription uses a rate-plan to determine behaviors such as how often to invoice. Often an organization will only have a single aggregating plan which is applied to all their accounts.

Configure an aggregating rate-plan


  1. Create a new product, for example called Aggregating Plans. Choose the defaults as they are all ignored.


  1. Add a new rate-plan to the product with the following options:
    1. Name:
      1. This can be whatever you like and is never shown to the customer.
      2. For example: Aggregating Plan
    2. Currency:
      1. Set this to the currency your aggregation will be in, for example USD
      2. Further discussion: Multiple currencies
    3. Bill Cycle:
      1. The duration and durationPeriod should be set to the frequency you want the subscriptions invoiced.
      2. Generally this would be monthly. i.e. 1 Month.
      3. Further discussion: Mixed periods
    4. Trial:
      1. Set value to None
      2. Trials do not apply to the aggregating subscription and are set on the aggregated child subscriptions explicitly
    5. Terms:
      1. Inferred from child subscription
    6. Pricing:
      1. Pricing generally comes from the aggregated child subscriptions
      2. Typically you would have no pricing components on the aggregating rate-plan

Enable Aggregation

To enable aggregation the aggregatingProductRatePlanID property must be set on the account. This can be set by either creating or updating an account.

That's it! From now on when you add subscriptions to this account they will automatically be aggregated.