/*
 * Copyright 2010-2013 Ning, Inc.
 *
 * Ning licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package org.killbill.billing.catalog.api;

/**
 * Specifies how {@code Subscription} cancellation or plan change should operate
 * <p/>
 */
public enum BillingActionPolicy {
    /**
     * The cancellation or {@code Plan} change effectiveDate will occur at the end of the current invoiced service
     * period, and that will not trigger any proration and credit.
     */
    END_OF_TERM,
    /**
     * The cancellation or {@code Plan} change effectiveDate will occur at the requestedDate
     */
    IMMEDIATE,
    ILLEGAL
}

/*
 * Copyright 2010-2013 Ning, Inc.
 *
 * Ning licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package org.killbill.billing.catalog.api;

/**
 * Specifies how {@code Subscription} cancellation or plan change should operate
 * <p/>
 */
public enum BillingActionPolicy {
    /**
     * The cancellation or {@code Plan} change effectiveDate will occur at the start of the current invoiced service
     * period and that will trigger a full credit.
     */
    START_OF_TERM,
    /**
     * The cancellation or {@code Plan} change effectiveDate will occur at the end of the current invoiced service
     * period, and that will not trigger any proration and credit.
     */
    END_OF_TERM,
    /**
     * The cancellation or {@code Plan} change effectiveDate will occur at the requestedDate
     */
    IMMEDIATE,
    ILLEGAL
}

Add START_OF_TERM BillingActionPolicy. See killbill/killbill#656