@clerk/backend/dist/api/resources/CommercePlan.d.ts

Clerk Backend SDK - REST Client for Backend API & JWT verification utilities

import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';
type CommerceMoneyAmount = {
    amount: number;
    amountFormatted: string;
    currency: string;
    currencySymbol: string;
};
/**
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
 * It is advised to pin the SDK version to avoid breaking changes.
 */
export declare class CommercePlan {
    /**
     * The unique identifier for the plan.
     */
    readonly id: string;
    /**
     * The id of the product the plan belongs to.
     */
    readonly productId: string;
    /**
     * The name of the plan.
     */
    readonly name: string;
    /**
     * The URL-friendly identifier of the plan.
     */
    readonly slug: string;
    /**
     * The description of the plan.
     */
    readonly description: string | undefined;
    /**
     * Whether the plan is the default plan.
     */
    readonly isDefault: boolean;
    /**
     * Whether the plan is recurring.
     */
    readonly isRecurring: boolean;
    /**
     * Whether the plan has a base fee.
     */
    readonly hasBaseFee: boolean;
    /**
     * Whether the plan is displayed in the `<PriceTable/>` component.
     */
    readonly publiclyVisible: boolean;
    /**
     * The monthly fee of the plan.
     */
    readonly fee: CommerceMoneyAmount;
    /**
     * The annual fee of the plan.
     */
    readonly annualFee: CommerceMoneyAmount;
    /**
     * The annual fee of the plan on a monthly basis.
     */
    readonly annualMonthlyFee: CommerceMoneyAmount;
    /**
     * The type of payer for the plan.
     */
    readonly forPayerType: 'org' | 'user';
    /**
     * The features the plan offers.
     */
    readonly features: Feature[];
    constructor(
    /**
     * The unique identifier for the plan.
     */
    id: string, 
    /**
     * The id of the product the plan belongs to.
     */
    productId: string, 
    /**
     * The name of the plan.
     */
    name: string, 
    /**
     * The URL-friendly identifier of the plan.
     */
    slug: string, 
    /**
     * The description of the plan.
     */
    description: string | undefined, 
    /**
     * Whether the plan is the default plan.
     */
    isDefault: boolean, 
    /**
     * Whether the plan is recurring.
     */
    isRecurring: boolean, 
    /**
     * Whether the plan has a base fee.
     */
    hasBaseFee: boolean, 
    /**
     * Whether the plan is displayed in the `<PriceTable/>` component.
     */
    publiclyVisible: boolean, 
    /**
     * The monthly fee of the plan.
     */
    fee: CommerceMoneyAmount, 
    /**
     * The annual fee of the plan.
     */
    annualFee: CommerceMoneyAmount, 
    /**
     * The annual fee of the plan on a monthly basis.
     */
    annualMonthlyFee: CommerceMoneyAmount, 
    /**
     * The type of payer for the plan.
     */
    forPayerType: 'org' | 'user', 
    /**
     * The features the plan offers.
     */
    features: Feature[]);
    static fromJSON(data: CommercePlanJSON): CommercePlan;
}
export {};
//# sourceMappingURL=CommercePlan.d.ts.map