import * as Ucanto from '@ucanto/interface';
import { AccountDID, DID, PlanGetFailure, PlanGetSuccess, PlanSetFailure, PlanSetSuccess, PlanCreateAdminSessionFailure, PlanCreateAdminSessionSuccess, PlanCreateCheckoutSessionFailure, PlanCreateCheckoutSessionSuccess, UnexpectedError } from '../types.js';
export type PlanID = DID;
export interface CustomerExists extends Ucanto.Failure {
    name: 'CustomerExists';
}
type PlanInitializeFailure = CustomerExists | UnexpectedError;
export interface PlanCreateCheckoutSessionOptions {
    redirectAfterCompletion?: boolean;
    successURL?: string;
    cancelURL?: string;
    freeTrial?: boolean;
}
/**
 * Stores subscription plan information.
 */
export interface PlansStorage {
    /**
     * Initialize a customer in our system, tracking the external billing
     * system ID and the plan they have chosen.
     *
     * Designed to be use from, eg, a webhook handler for an account creation event
     * in a third party billing system.
     *
     * @param account account DID
     * @param billingID ID used by billing system to track this account
     * @param plan the ID of the initial plan
     */
    initialize: (account: AccountDID, billingID: string, plan: PlanID) => Promise<Ucanto.Result<Ucanto.Unit, PlanInitializeFailure>>;
    /**
     * Get plan information for a customer
     *
     * @param account account DID
     */
    get: (account: AccountDID) => Promise<Ucanto.Result<PlanGetSuccess, PlanGetFailure>>;
    /**
     * Set a customer's plan. Update our systems and any third party billing systems.
     *
     * @param account account DID
     * @param plan the ID of the new plan
     */
    set: (account: AccountDID, plan: PlanID) => Promise<Ucanto.Result<PlanSetSuccess, PlanSetFailure>>;
    /**
     * Create an "admin session" for the user so they can update their billing information.
     *
     * May not be possible with all billing providers - this is designed with
     * https://docs.stripe.com/api/customer_portal/sessions/create in mind.
     *
     * @param account account DID
     */
    createAdminSession: (account: AccountDID, returnURL: string) => Promise<Ucanto.Result<PlanCreateAdminSessionSuccess, PlanCreateAdminSessionFailure>>;
    /**
     * Create a "checkout session"
     *
     * May not be possible with all billing providers - this is designed with
     * https://docs.stripe.com/api/checkout/sessions in mind.
     *
     * @param account account DID
     */
    createCheckoutSession: (account: AccountDID, plan: PlanID, options: PlanCreateCheckoutSessionOptions) => Promise<Ucanto.Result<PlanCreateCheckoutSessionSuccess, PlanCreateCheckoutSessionFailure>>;
}
export {};
//# sourceMappingURL=plans.d.ts.map