@blocklet/payment-types 1.19.0 → 1.19.2

package/lib/checkout-session.d.ts

@@ -157,7 +157,7 @@ export declare class CheckoutSession extends Model<InferAttributes<CheckoutSessi
             allowNull: boolean;
         };
         status: {
-            type: DataTypes.EnumDataType<"open" | "complete" | "expired">;
+            type: DataTypes.EnumDataType<"open" | "expired" | "complete">;
             allowNull: boolean;
         };
         payment_status: {

package/lib/credit-grant.d.ts

@@ -0,0 +1,160 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import { CreditGrantApplicabilityConfig } from './types';
+import { TPaymentCurrency } from './payment-currency';
+type CreditGrantSummary = {
+    paymentCurrency: TPaymentCurrency;
+    totalAmount: string;
+    remainingAmount: string;
+    grantCount: number;
+};
+export declare const nextCreditGrantId: (size?: number) => string;
+export declare class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreationAttributes<CreditGrant>> {
+    id: CreationOptional<string>;
+    object: CreationOptional<string>;
+    amount: string;
+    currency_id: string;
+    applicability_config?: CreditGrantApplicabilityConfig;
+    category: LiteralUnion<'paid' | 'promotional', string>;
+    customer_id: string;
+    effective_at?: number;
+    expires_at?: number;
+    livemode: boolean;
+    metadata?: Record<string, any>;
+    name?: string;
+    priority: number;
+    test_clock?: string;
+    voided_at?: number;
+    status: LiteralUnion<'pending' | 'granted' | 'depleted' | 'expired' | 'voided', string>;
+    remaining_amount: string;
+    created_by?: string;
+    updated_by?: string;
+    created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;
+    created_at: CreationOptional<Date>;
+    updated_at: CreationOptional<Date>;
+    static readonly GENESIS_ATTRIBUTES: {
+        id: {
+            type: DataTypes.StringDataType;
+            primaryKey: boolean;
+            allowNull: boolean;
+            defaultValue: (size?: number) => string;
+        };
+        object: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        amount: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        applicability_config: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        category: {
+            type: DataTypes.EnumDataType<"paid" | "promotional">;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        effective_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        expires_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        priority: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+            allowNull: boolean;
+            validate: {
+                min: number;
+                max: number;
+            };
+        };
+        test_clock: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        voided_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"pending" | "voided" | "depleted" | "expired" | "granted">;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        remaining_amount: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        created_by: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        updated_by: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        created_via: {
+            type: DataTypes.EnumDataType<"api" | "dashboard" | "portal">;
+            allowNull: boolean;
+        };
+        created_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    isAvailable(): boolean;
+    consumeCredit(amount: string, context: {
+        subscription_id?: string;
+        meter_event_id?: string;
+    }, dryRun?: boolean): Promise<{
+        consumed: string;
+        remaining: string;
+        depleted: boolean;
+    }>;
+    isApplicableToPrice(priceId: string): boolean;
+    static initialize(sequelize: any): void;
+    static associate(models: any): void;
+    static getAvailableCreditsForCustomer(customerId: string, currencyId: string, priceIds?: string[] | string): Promise<CreditGrant[]>;
+    static expireCredits(grantIds: string[]): Promise<number>;
+    /**
+     * 获取客户的有效信用额度总额（按货币分组）
+     */
+    static getEffectiveCreditSummary({ customerId, currencyId: searchCurrencyId, priceIds, }: {
+        customerId: string;
+        currencyId?: string[] | string;
+        priceIds?: string[];
+    }): Promise<Record<string, CreditGrantSummary>>;
+}
+export type TCreditGrant = InferAttributes<CreditGrant>;
+export {};

package/lib/credit-transaction.d.ts

@@ -0,0 +1,135 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+export declare const nextCreditTransactionId: (size?: number) => string;
+export declare class CreditTransaction extends Model<InferAttributes<CreditTransaction>, InferCreationAttributes<CreditTransaction>> {
+    id: CreationOptional<string>;
+    quantity: string;
+    credit_amount: string;
+    remaining_balance: string;
+    customer_id: string;
+    credit_grant_id: string;
+    meter_id?: string;
+    subscription_id?: string;
+    source?: string;
+    meter_event_name: string;
+    meter_unit: string;
+    description?: string;
+    metadata?: Record<string, any>;
+    created_at: CreationOptional<Date>;
+    updated_at: CreationOptional<Date>;
+    static readonly GENESIS_ATTRIBUTES: {
+        id: {
+            type: DataTypes.StringDataType;
+            primaryKey: boolean;
+            allowNull: boolean;
+            defaultValue: (size?: number) => string;
+        };
+        quantity: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        credit_amount: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        remaining_balance: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        customer_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        credit_grant_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        meter_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        subscription_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        source: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        meter_event_name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        meter_unit: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.TextDataTypeConstructor;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        created_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    static initialize(sequelize: any): void;
+    static associate(models: any): void;
+    static getUsageSummary({ customerId, subscriptionId, meterEventName, currencyId, startTime, endTime, }: {
+        customerId?: string;
+        subscriptionId?: string;
+        meterEventName?: string;
+        currencyId?: string;
+        startTime?: Date;
+        endTime?: Date;
+    }): Promise<{
+        total_quantity: string;
+        total_credit_amount: string;
+        transaction_count: number;
+        filters: {
+            customer_id: string | undefined;
+            subscription_id: string | undefined;
+            meter_event_name: string | undefined;
+            currency_id: string | undefined;
+            start_time: string | undefined;
+            end_time: string | undefined;
+        };
+    }>;
+    static getUsageSummaryForCustomer(customerId: string, meterEventName?: string, startTime?: Date, endTime?: Date): Promise<{
+        total_quantity: string;
+        total_credit_amount: string;
+        transaction_count: number;
+        filters: {
+            customer_id: string | undefined;
+            subscription_id: string | undefined;
+            meter_event_name: string | undefined;
+            currency_id: string | undefined;
+            start_time: string | undefined;
+            end_time: string | undefined;
+        };
+    }>;
+    static getUsageSummaryForSubscription(subscriptionId: string, startTime?: Date, endTime?: Date): Promise<{
+        total_quantity: string;
+        total_credit_amount: string;
+        transaction_count: number;
+        filters: {
+            customer_id: string | undefined;
+            subscription_id: string | undefined;
+            meter_event_name: string | undefined;
+            currency_id: string | undefined;
+            start_time: string | undefined;
+            end_time: string | undefined;
+        };
+    }>;
+    static getUsageTrend(customerId: string, meterEventName: string, startTime: Date, endTime: Date): Promise<CreditTransaction[]>;
+}
+export type TCreditTransaction = InferAttributes<CreditTransaction>;

package/lib/index.d.ts

@@ -22,11 +22,15 @@ import { SetupIntent, TSetupIntent } from './setup-intent';
 import { Subscription, TSubscription } from './subscription';
 import { SubscriptionItem, TSubscriptionItem } from './subscription-item';
 import { SubscriptionSchedule } from './subscription-schedule';
-import type { LineItem, PricingTableItem } from './types';
+import type { LineItem, PriceCurrency, PricingTableItem } from './types';
 import { TUsageRecord, UsageRecord } from './usage-record';
 import { TWebhookAttempt, WebhookAttempt } from './webhook-attempt';
 import { TWebhookEndpoint, WebhookEndpoint } from './webhook-endpoint';
 import { Setting } from './setting';
+import { CreditGrant, TCreditGrant } from './credit-grant';
+import { CreditTransaction, TCreditTransaction } from './credit-transaction';
+import { Meter, TMeter } from './meter';
+import { MeterEvent, TMeterEvent } from './meter-event';
 declare const models: {
     CheckoutSession: typeof CheckoutSession;
     Coupon: typeof Coupon;
@@ -56,6 +60,10 @@ declare const models: {
     Job: typeof Job;
     Lock: typeof Lock;
     Setting: typeof Setting;
+    CreditGrant: typeof CreditGrant;
+    CreditTransaction: typeof CreditTransaction;
+    Meter: typeof Meter;
+    MeterEvent: typeof MeterEvent;
 };
 export declare function initialize(sequelize: any): void;
 export default models;
@@ -88,6 +96,10 @@ export * from './webhook-attempt';
 export * from './webhook-endpoint';
 export * from './types';
 export * from './setting';
+export * from './credit-grant';
+export * from './credit-transaction';
+export * from './meter';
+export * from './meter-event';
 export type TPriceExpanded = TPrice & {
     object: 'price';
     product: TProduct;
@@ -96,6 +108,10 @@ export type TPriceExpanded = TPrice & {
         upsells_to: TPriceExpanded;
         upsells_to_id: string;
     };
+    meter?: TMeter;
+    currency_options?: (PriceCurrency & {
+        currency?: TPaymentCurrency;
+    })[];
 };
 export type TLineItemExpanded = LineItem & {
     price: TPriceExpanded;
@@ -152,6 +168,7 @@ export type TSubscriptionExpanded = TSubscription & {
     paymentCurrency: TPaymentCurrency;
     paymentMethod: TPaymentMethod;
     items: TSubscriptionItemExpanded[];
+    serviceType: 'credit' | 'standard';
 };
 export type TSubscriptionItemExpanded = TSubscriptionItem & {
     object: 'subscription';
@@ -207,16 +224,19 @@ export type TSetupIntentExpanded = TSetupIntent & {
     object: 'setup_intent';
 };
 export type TPricingTableItem = PricingTableItem & {
+    object: 'pricing_table_item';
     price: TPrice;
     product: TProduct;
     is_selected?: boolean;
     is_disabled?: boolean;
 };
 export type TPricingTableExpanded = TPricingTable & {
+    object: 'pricing_table';
     items: TPricingTableItem[];
     currency: TPaymentCurrency;
 };
 export type TRefundExpanded = TRefund & {
+    object: 'refund';
     customer: TCustomer;
     paymentCurrency: TPaymentCurrency;
     paymentMethod: TPaymentMethod;
@@ -231,3 +251,32 @@ export type TPayoutExpanded = TPayout & {
     paymentIntent: TPaymentIntent;
     customer: TCustomer;
 };
+export type TCreditGrantExpanded = TCreditGrant & {
+    object: 'credit_grant';
+    customer: TCustomer;
+    paymentCurrency: TPaymentCurrency;
+    paymentMethod: TPaymentMethod;
+    items?: TLineItemExpanded[];
+};
+export type TCreditTransactionExpanded = TCreditTransaction & {
+    object: 'credit_transaction';
+    customer: TCustomer;
+    paymentCurrency: TPaymentCurrency;
+    paymentMethod?: TPaymentMethod;
+    creditGrant: TCreditGrant;
+    meter: TMeter;
+    subscription: TSubscription;
+};
+export type TMeterEventExpanded = TMeterEvent & {
+    object: 'meter_event';
+    customer: Customer;
+    subscription?: TSubscription;
+    meter: TMeter;
+    paymentCurrency: TPaymentCurrency;
+};
+export type CreditGrantSummary = {
+    paymentCurrency: TPaymentCurrency;
+    totalAmount: string;
+    remainingAmount: string;
+    grantCount: number;
+};

package/lib/meter-event.d.ts

@@ -0,0 +1,136 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import { GroupedBN, GroupedStrList, MeterEventPayload, MeterEventStatus } from './types';
+export declare const nextMeterEventId: (size?: number) => string;
+export declare class MeterEvent extends Model<InferAttributes<MeterEvent>, InferCreationAttributes<MeterEvent>> {
+    id: CreationOptional<string>;
+    event_name: string;
+    payload: MeterEventPayload;
+    identifier: string;
+    timestamp: number;
+    livemode: boolean;
+    status: MeterEventStatus;
+    processed_at?: number;
+    attempt_count: number;
+    next_attempt?: number;
+    credit_consumed: string;
+    credit_pending: string;
+    metadata?: Record<string, any>;
+    created_by?: string;
+    created_via: LiteralUnion<'api' | 'dashboard' | 'webhook' | 'batch', string>;
+    created_at: CreationOptional<Date>;
+    updated_at: CreationOptional<Date>;
+    static readonly GENESIS_ATTRIBUTES: {
+        id: {
+            type: DataTypes.StringDataType;
+            primaryKey: boolean;
+            allowNull: boolean;
+            defaultValue: (size?: number) => string;
+        };
+        event_name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        timestamp: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        payload: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+            validate: {
+                hasRequiredFields(value: any): void;
+            };
+        };
+        identifier: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+            unique: boolean;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"pending" | "processing" | "requires_action" | "requires_capture" | "completed" | "canceled">;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        attempt_count: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            defaultValue: number;
+            allowNull: boolean;
+        };
+        next_attempt: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        processed_at: {
+            type: DataTypes.IntegerDataTypeConstructor;
+            allowNull: boolean;
+        };
+        credit_consumed: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        credit_pending: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        created_by: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        created_via: {
+            type: DataTypes.EnumDataType<"api" | "dashboard" | "webhook" | "batch">;
+            allowNull: boolean;
+        };
+        created_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    markAsCompleted(): Promise<void>;
+    markAsProcessing(): Promise<void>;
+    markAsRequiresCapture(errorMessage: string, nextAttemptTime: number): Promise<void>;
+    markAsRequiresAction(errorMessage: string): Promise<void>;
+    markAsCanceled(reason: string): Promise<void>;
+    getCustomerId(): string;
+    getValue(): string;
+    getSubscriptionId(): string | undefined;
+    static initialize(sequelize: any): void;
+    static processUnprocessedEvents(eventName?: string, limit?: number): Promise<MeterEvent[]>;
+    static isEventExists(identifier: string): Promise<boolean>;
+    static getEventStats(eventName: string, startTime?: Date, endTime?: Date): Promise<{
+        total_events: number;
+        processed_events: number;
+        pending_events: number;
+        total_value: number;
+    }>;
+    static expand(events: MeterEvent[], livemode?: boolean, options?: {
+        customer?: boolean;
+        subscription?: boolean;
+        meter?: boolean;
+    }): Promise<MeterEvent[]>;
+    private static _getPendingAmounts;
+    static getPendingAmounts({ subscriptionId, livemode, currencyId, status, customerId, }: {
+        subscriptionId?: string;
+        livemode?: boolean;
+        currencyId?: string;
+        status?: MeterEventStatus | MeterEventStatus[];
+        customerId?: string;
+    }): Promise<[GroupedBN, GroupedStrList, MeterEvent[]]>;
+}
+export type TMeterEvent = InferAttributes<MeterEvent>;

package/lib/meter.d.ts

@@ -0,0 +1,111 @@
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+import type { TPaymentCurrency } from './payment-currency';
+export declare const nextMeterId: (size?: number) => string;
+export type TMeterExpanded = TMeter & {
+    paymentCurrency: TPaymentCurrency;
+};
+export declare class Meter extends Model<InferAttributes<Meter>, InferCreationAttributes<Meter>> {
+    id: CreationOptional<string>;
+    object: CreationOptional<string>;
+    name: string;
+    event_name: string;
+    aggregation_method: LiteralUnion<'sum' | 'count' | 'last', string>;
+    status: LiteralUnion<'active' | 'inactive', string>;
+    unit: string;
+    description?: string;
+    component_did?: string;
+    livemode: boolean;
+    metadata?: Record<string, any>;
+    currency_id?: string;
+    created_by?: string;
+    updated_by?: string;
+    created_via: LiteralUnion<'api' | 'dashboard' | 'portal', string>;
+    created_at: CreationOptional<Date>;
+    updated_at: CreationOptional<Date>;
+    static readonly GENESIS_ATTRIBUTES: {
+        id: {
+            type: DataTypes.StringDataType;
+            primaryKey: boolean;
+            allowNull: boolean;
+            defaultValue: (size?: number) => string;
+        };
+        object: {
+            type: DataTypes.StringDataType;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        event_name: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+            unique: boolean;
+        };
+        aggregation_method: {
+            type: DataTypes.EnumDataType<"count" | "sum" | "last">;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        status: {
+            type: DataTypes.EnumDataType<"active" | "inactive">;
+            defaultValue: string;
+            allowNull: boolean;
+        };
+        unit: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        description: {
+            type: DataTypes.TextDataTypeConstructor;
+            allowNull: boolean;
+        };
+        component_did: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        currency_id: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        livemode: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        metadata: {
+            type: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        created_by: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        updated_by: {
+            type: DataTypes.StringDataType;
+            allowNull: boolean;
+        };
+        created_via: {
+            type: DataTypes.EnumDataType<"api" | "dashboard" | "portal">;
+            allowNull: boolean;
+        };
+        created_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+        updated_at: {
+            type: DataTypes.DateDataTypeConstructor;
+            defaultValue: DataTypes.AbstractDataTypeConstructor;
+            allowNull: boolean;
+        };
+    };
+    static initialize(sequelize: any): void;
+    static associate(models: any): void;
+    static getMeterByEventName(eventName: string, livemode?: boolean): Promise<Meter | null>;
+    static getMetricsForMeter(meterId: string, customerId?: string): Promise<{
+        total_usage: number;
+    }>;
+}
+export type TMeter = InferAttributes<Meter>;

package/lib/payment-currency.d.ts

@@ -1,4 +1,5 @@
 import { CreationOptional, DataTypes, FindOptions, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
 import { VaultConfig } from './types';
 export declare class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, InferCreationAttributes<PaymentCurrency>> {
     id: CreationOptional<string>;
@@ -20,6 +21,7 @@ export declare class PaymentCurrency extends Model<InferAttributes<PaymentCurren
     created_at: CreationOptional<Date>;
     updated_at: CreationOptional<Date>;
     vault_config?: VaultConfig;
+    type: LiteralUnion<'standard' | 'credit', string>;
     static readonly GENESIS_ATTRIBUTES: {
         id: {
             type: DataTypes.StringDataType;
@@ -108,5 +110,7 @@ export declare class PaymentCurrency extends Model<InferAttributes<PaymentCurren
     static findByPkOrSymbol(id: string, options?: FindOptions<PaymentCurrency>): Promise<PaymentCurrency | null>;
     isLocked(): Promise<boolean>;
     isUsed(): Promise<boolean>;
+    static createForMeter(meter: any, paymentMethodId: string): Promise<PaymentCurrency>;
+    isCredit(): boolean;
 }
 export type TPaymentCurrency = InferAttributes<PaymentCurrency>;

package/lib/payment-intent.d.ts

@@ -106,7 +106,7 @@ export declare class PaymentIntent extends Model<InferAttributes<PaymentIntent>,
             allowNull: boolean;
         };
         status: {
-            type: DataTypes.EnumDataType<"requires_payment_method" | "requires_confirmation" | "requires_action" | "processing" | "requires_capture" | "canceled" | "succeeded">;
+            type: DataTypes.EnumDataType<"processing" | "requires_action" | "requires_capture" | "canceled" | "requires_payment_method" | "requires_confirmation" | "succeeded">;
             allowNull: boolean;
         };
         canceled_at: {

package/lib/payout.d.ts

@@ -76,7 +76,7 @@ export declare class Payout extends Model<InferAttributes<Payout>, InferCreation
             allowNull: boolean;
         };
         status: {
-            type: DataTypes.EnumDataType<"paid" | "canceled" | "pending" | "failed" | "in_transit">;
+            type: DataTypes.EnumDataType<"pending" | "canceled" | "paid" | "failed" | "in_transit">;
             allowNull: boolean;
         };
         failure_message: {

package/lib/price.d.ts

@@ -2,6 +2,7 @@ import { CreationOptional, DataTypes, FindOptions, InferAttributes, InferCreatio
 import type { LiteralUnion } from 'type-fest';
 import type { TPaymentCurrency } from './payment-currency';
 import type { CustomUnitAmount, LineItem, PriceCurrency, PriceRecurring, PriceTier, TransformQuantity } from './types';
+import { type TMeter } from './meter';
 export declare const nextPriceId: (size?: number) => string;
 type TPriceExpanded = TPrice & {
     object: 'price';
@@ -11,6 +12,7 @@ type TPriceExpanded = TPrice & {
         upsells_to: TPriceExpanded;
         upsells_to_id: string;
     };
+    meter?: TMeter;
 };
 type TLineItemExpanded = LineItem & {
     price: TPriceExpanded;
@@ -133,7 +135,7 @@ export declare class Price extends Model<InferAttributes<Price>, InferCreationAt
     };
     static initialize(sequelize: any): void;
     static associate(models: any): void;
-    static getModel(price: TPrice): LiteralUnion<"graduated" | "volume", string> | "package" | "standard" | null;
+    static getModel(price: TPrice): "standard" | LiteralUnion<"graduated" | "volume", string> | "package" | null;
     transformQuantity(quantity: number): number;
     static formatBeforeSave(price: Partial<TPrice & {
         model: string;

package/lib/product.d.ts

@@ -9,7 +9,7 @@ export declare class Product extends Model<InferAttributes<Product>, InferCreati
     active: boolean;
     livemode: boolean;
     locked: CreationOptional<boolean>;
-    type: LiteralUnion<'service' | 'good', string>;
+    type: LiteralUnion<'service' | 'good' | 'credit', string>;
     name: string;
     description: string;
     images: any[];
@@ -45,7 +45,7 @@ export declare class Product extends Model<InferAttributes<Product>, InferCreati
             defaultValue: boolean;
         };
         type: {
-            type: DataTypes.EnumDataType<"service" | "good">;
+            type: DataTypes.EnumDataType<"credit" | "service" | "good">;
         };
         name: {
             type: DataTypes.StringDataType;

package/lib/refund.d.ts

@@ -77,7 +77,7 @@ export declare class Refund extends Model<InferAttributes<Refund>, InferCreation
             allowNull: boolean;
         };
         status: {
-            type: DataTypes.EnumDataType<"requires_action" | "canceled" | "succeeded" | "pending" | "failed">;
+            type: DataTypes.EnumDataType<"pending" | "requires_action" | "canceled" | "succeeded" | "failed">;
             allowNull: boolean;
         };
         reason: {

package/lib/setup-intent.d.ts

@@ -56,7 +56,7 @@ export declare class SetupIntent extends Model<InferAttributes<SetupIntent>, Inf
             allowNull: boolean;
         };
         status: {
-            type: DataTypes.EnumDataType<"requires_payment_method" | "requires_confirmation" | "requires_action" | "processing" | "requires_capture" | "canceled" | "succeeded">;
+            type: DataTypes.EnumDataType<"processing" | "requires_action" | "requires_capture" | "canceled" | "requires_payment_method" | "requires_confirmation" | "succeeded">;
             allowNull: boolean;
         };
         usage: {

package/lib/subscription-schedule.d.ts

@@ -62,7 +62,7 @@ export declare class SubscriptionSchedule extends Model<InferAttributes<Subscrip
             allowNull: boolean;
         };
         status: {
-            type: DataTypes.EnumDataType<"active" | "canceled" | "completed" | "not_started" | "released">;
+            type: DataTypes.EnumDataType<"active" | "completed" | "canceled" | "not_started" | "released">;
             allowNull: boolean;
         };
         default_settings: {

package/lib/subscription.d.ts

@@ -209,6 +209,7 @@ export declare class Subscription extends Model<InferAttributes<Subscription>, I
     isImmutable(): boolean;
     isActive(): boolean;
     isScheduledToCancel(): boolean;
+    isConsumesCredit(): Promise<boolean>;
     start(): Promise<boolean>;
     static getSummary(livemode?: boolean, field?: string): Promise<Subscription[]>;
     static getToSubscriptions(subscriptionId: string): Promise<string[]>;

package/lib/types.d.ts

@@ -37,6 +37,7 @@ export type PriceRecurring = {
     interval_count: number;
     aggregate_usage?: LiteralUnion<'sum' | 'last_during_period' | 'max' | 'last_ever', string>;
     usage_type?: LiteralUnion<'licensed' | 'metered', string>;
+    meter_id?: string;
 };
 export type PriceCurrency = {
     currency_id: string;
@@ -265,7 +266,7 @@ export type PaymentDetails = {
     arcblock?: {
         tx_hash: string;
         payer: string;
-        type?: LiteralUnion<'slash' | 'transfer' | 'delegate' | 'stake_return', string>;
+        type?: LiteralUnion<'slash' | 'transfer' | 'delegate' | 'stake_return' | 'credit', string>;
         receiver?: string;
         staking?: {
             tx_hash: string;
@@ -422,7 +423,7 @@ export type SubscriptionUpdateItem = {
     price_id?: string;
     quantity?: number;
 };
-export type EventType = LiteralUnion<'account.application.authorized' | 'account.application.deauthorized' | 'account.external_account.created' | 'account.external_account.deleted' | 'account.external_account.updated' | 'account.updated' | 'application_fee.created' | 'application_fee.refund.updated' | 'application_fee.refunded' | 'balance.available' | 'billing_portal.configuration.created' | 'billing_portal.configuration.updated' | 'billing_portal.session.created' | 'capability.updated' | 'cash_balance.funds_available' | 'charge.captured' | 'charge.dispute.closed' | 'charge.dispute.created' | 'charge.dispute.funds_reinstated' | 'charge.dispute.funds_withdrawn' | 'charge.dispute.updated' | 'charge.expired' | 'charge.failed' | 'charge.pending' | 'charge.refund.updated' | 'charge.refunded' | 'charge.succeeded' | 'charge.updated' | 'checkout.session.async_payment_failed' | 'checkout.session.async_payment_succeeded' | 'checkout.session.nft_minted' | 'checkout.session.completed' | 'checkout.session.expired' | 'checkout.session.created' | 'coupon.created' | 'coupon.deleted' | 'coupon.updated' | 'credit_note.created' | 'credit_note.updated' | 'credit_note.voided' | 'customer_cash_balance_transaction.created' | 'customer.created' | 'customer.deleted' | 'customer.discount.created' | 'customer.discount.deleted' | 'customer.discount.updated' | 'customer.source.created' | 'customer.source.deleted' | 'customer.source.expiring' | 'customer.source.updated' | 'customer.subscription.created' | 'customer.subscription.deleted' | 'customer.subscription.paused' | 'customer.subscription.past_due' | 'customer.subscription.pending_update_applied' | 'customer.subscription.pending_update_expired' | 'customer.subscription.resumed' | 'customer.subscription.renewed' | 'customer.subscription.recovered' | 'customer.subscription.upgraded' | 'customer.subscription.renew_failed' | 'customer.subscription.trial_start' | 'customer.subscription.trial_will_end' | 'customer.subscription.trial_end' | 'customer.subscription.started' | 'customer.subscription.updated' | 'customer.tax_id.created' | 'customer.tax_id.deleted' | 'customer.tax_id.updated' | 'customer.updated' | 'file.created' | 'financial_connections.account.created' | 'financial_connections.account.deactivated' | 'financial_connections.account.disconnected' | 'financial_connections.account.reactivated' | 'financial_connections.account.refreshed_balance' | 'identity.verification_session.canceled' | 'identity.verification_session.created' | 'identity.verification_session.processing' | 'identity.verification_session.redacted' | 'identity.verification_session.requires_input' | 'identity.verification_session.verified' | 'invoice.created' | 'invoice.deleted' | 'invoice.finalization_failed' | 'invoice.finalized' | 'invoice.marked_uncollectible' | 'invoice.paid' | 'invoice.payment_action_required' | 'invoice.payment_failed' | 'invoice.payment_succeeded' | 'invoice.sent' | 'invoice.upcoming' | 'invoice.updated' | 'invoice.voided' | 'invoiceitem.created' | 'invoiceitem.deleted' | 'issuing_authorization.created' | 'issuing_authorization.request' | 'issuing_authorization.updated' | 'issuing_card.created' | 'issuing_card.updated' | 'issuing_cardholder.created' | 'issuing_cardholder.updated' | 'issuing_dispute.closed' | 'issuing_dispute.created' | 'issuing_dispute.funds_reinstated' | 'issuing_dispute.submitted' | 'issuing_dispute.updated' | 'issuing_transaction.created' | 'issuing_transaction.updated' | 'mandate.updated' | 'order.created' | 'payment_intent.amount_capturable_updated' | 'payment_intent.canceled' | 'payment_intent.created' | 'payment_intent.partially_funded' | 'payment_intent.payment_failed' | 'payment_intent.processing' | 'payment_intent.requires_action' | 'payment_intent.succeeded' | 'payment_link.created' | 'payment_link.updated' | 'payment_method.attached' | 'payment_method.automatically_updated' | 'payment_method.detached' | 'payment_method.updated' | 'payout.canceled' | 'payout.created' | 'payout.failed' | 'payout.paid' | 'payout.reconciliation_completed' | 'payout.updated' | 'person.created' | 'person.deleted' | 'person.updated' | 'plan.created' | 'plan.deleted' | 'plan.updated' | 'price.created' | 'price.deleted' | 'price.updated' | 'product.created' | 'product.deleted' | 'product.updated' | 'promotion_code.created' | 'promotion_code.updated' | 'quote.accepted' | 'quote.canceled' | 'quote.created' | 'quote.finalized' | 'radar.early_fraud_warning.created' | 'radar.early_fraud_warning.updated' | 'recipient.created' | 'recipient.deleted' | 'recipient.updated' | 'refund.created' | 'refund.updated' | 'refund.succeeded' | 'refund.canceled' | 'reporting.report_run.failed' | 'reporting.report_run.succeeded' | 'reporting.report_type.updated' | 'review.closed' | 'review.opened' | 'setup_intent.canceled' | 'setup_intent.created' | 'setup_intent.requires_action' | 'setup_intent.setup_failed' | 'setup_intent.succeeded' | 'sigma.scheduled_query_run.created' | 'sku.created' | 'sku.deleted' | 'sku.updated' | 'source.canceled' | 'source.chargeable' | 'source.failed' | 'source.mandate_notification' | 'source.refund_attributes_required' | 'source.transaction.created' | 'source.transaction.updated' | 'subscription_schedule.aborted' | 'subscription_schedule.canceled' | 'subscription_schedule.completed' | 'subscription_schedule.created' | 'subscription_schedule.expiring' | 'subscription_schedule.released' | 'subscription_schedule.updated' | 'tax_rate.created' | 'tax_rate.updated' | 'tax.settings.updated' | 'terminal.reader.action_failed' | 'terminal.reader.action_succeeded' | 'test_helpers.test_clock.advancing' | 'test_helpers.test_clock.created' | 'test_helpers.test_clock.deleted' | 'test_helpers.test_clock.internal_failure' | 'test_helpers.test_clock.ready' | 'topup.canceled' | 'topup.created' | 'topup.failed' | 'topup.reversed' | 'topup.succeeded' | 'transfer.created' | 'transfer.reversed' | 'transfer.updated' | 'billing.discrepancy' | 'usage.report.empty', string>;
+export type EventType = LiteralUnion<'account.application.authorized' | 'account.application.deauthorized' | 'account.external_account.created' | 'account.external_account.deleted' | 'account.external_account.updated' | 'account.updated' | 'application_fee.created' | 'application_fee.refund.updated' | 'application_fee.refunded' | 'balance.available' | 'billing_portal.configuration.created' | 'billing_portal.configuration.updated' | 'billing_portal.session.created' | 'capability.updated' | 'cash_balance.funds_available' | 'charge.captured' | 'charge.dispute.closed' | 'charge.dispute.created' | 'charge.dispute.funds_reinstated' | 'charge.dispute.funds_withdrawn' | 'charge.dispute.updated' | 'charge.expired' | 'charge.failed' | 'charge.pending' | 'charge.refund.updated' | 'charge.refunded' | 'charge.succeeded' | 'charge.updated' | 'checkout.session.async_payment_failed' | 'checkout.session.async_payment_succeeded' | 'checkout.session.nft_minted' | 'checkout.session.completed' | 'checkout.session.expired' | 'checkout.session.created' | 'coupon.created' | 'coupon.deleted' | 'coupon.updated' | 'credit_note.created' | 'credit_note.updated' | 'credit_note.voided' | 'customer_cash_balance_transaction.created' | 'customer.created' | 'customer.deleted' | 'customer.discount.created' | 'customer.discount.deleted' | 'customer.discount.updated' | 'customer.source.created' | 'customer.source.deleted' | 'customer.source.expiring' | 'customer.source.updated' | 'customer.subscription.created' | 'customer.subscription.deleted' | 'customer.subscription.paused' | 'customer.subscription.past_due' | 'customer.subscription.pending_update_applied' | 'customer.subscription.pending_update_expired' | 'customer.subscription.resumed' | 'customer.subscription.renewed' | 'customer.subscription.recovered' | 'customer.subscription.upgraded' | 'customer.subscription.renew_failed' | 'customer.subscription.trial_start' | 'customer.subscription.trial_will_end' | 'customer.subscription.trial_end' | 'customer.subscription.started' | 'customer.subscription.updated' | 'customer.tax_id.created' | 'customer.tax_id.deleted' | 'customer.tax_id.updated' | 'customer.updated' | 'file.created' | 'financial_connections.account.created' | 'financial_connections.account.deactivated' | 'financial_connections.account.disconnected' | 'financial_connections.account.reactivated' | 'financial_connections.account.refreshed_balance' | 'identity.verification_session.canceled' | 'identity.verification_session.created' | 'identity.verification_session.processing' | 'identity.verification_session.redacted' | 'identity.verification_session.requires_input' | 'identity.verification_session.verified' | 'invoice.created' | 'invoice.deleted' | 'invoice.finalization_failed' | 'invoice.finalized' | 'invoice.marked_uncollectible' | 'invoice.paid' | 'invoice.payment_action_required' | 'invoice.payment_failed' | 'invoice.payment_succeeded' | 'invoice.sent' | 'invoice.upcoming' | 'invoice.updated' | 'invoice.voided' | 'invoiceitem.created' | 'invoiceitem.deleted' | 'issuing_authorization.created' | 'issuing_authorization.request' | 'issuing_authorization.updated' | 'issuing_card.created' | 'issuing_card.updated' | 'issuing_cardholder.created' | 'issuing_cardholder.updated' | 'issuing_dispute.closed' | 'issuing_dispute.created' | 'issuing_dispute.funds_reinstated' | 'issuing_dispute.submitted' | 'issuing_dispute.updated' | 'issuing_transaction.created' | 'issuing_transaction.updated' | 'mandate.updated' | 'order.created' | 'payment_intent.amount_capturable_updated' | 'payment_intent.canceled' | 'payment_intent.created' | 'payment_intent.partially_funded' | 'payment_intent.payment_failed' | 'payment_intent.processing' | 'payment_intent.requires_action' | 'payment_intent.succeeded' | 'payment_link.created' | 'payment_link.updated' | 'payment_method.attached' | 'payment_method.automatically_updated' | 'payment_method.detached' | 'payment_method.updated' | 'payout.canceled' | 'payout.created' | 'payout.failed' | 'payout.paid' | 'payout.reconciliation_completed' | 'payout.updated' | 'person.created' | 'person.deleted' | 'person.updated' | 'plan.created' | 'plan.deleted' | 'plan.updated' | 'price.created' | 'price.deleted' | 'price.updated' | 'product.created' | 'product.deleted' | 'product.updated' | 'promotion_code.created' | 'promotion_code.updated' | 'quote.accepted' | 'quote.canceled' | 'quote.created' | 'quote.finalized' | 'radar.early_fraud_warning.created' | 'radar.early_fraud_warning.updated' | 'recipient.created' | 'recipient.deleted' | 'recipient.updated' | 'refund.created' | 'refund.updated' | 'refund.succeeded' | 'refund.canceled' | 'reporting.report_run.failed' | 'reporting.report_run.succeeded' | 'reporting.report_type.updated' | 'review.closed' | 'review.opened' | 'setup_intent.canceled' | 'setup_intent.created' | 'setup_intent.requires_action' | 'setup_intent.setup_failed' | 'setup_intent.succeeded' | 'sigma.scheduled_query_run.created' | 'sku.created' | 'sku.deleted' | 'sku.updated' | 'source.canceled' | 'source.chargeable' | 'source.failed' | 'source.mandate_notification' | 'source.refund_attributes_required' | 'source.transaction.created' | 'source.transaction.updated' | 'subscription_schedule.aborted' | 'subscription_schedule.canceled' | 'subscription_schedule.completed' | 'subscription_schedule.created' | 'subscription_schedule.expiring' | 'subscription_schedule.released' | 'subscription_schedule.updated' | 'tax_rate.created' | 'tax_rate.updated' | 'tax.settings.updated' | 'terminal.reader.action_failed' | 'terminal.reader.action_succeeded' | 'test_helpers.test_clock.advancing' | 'test_helpers.test_clock.created' | 'test_helpers.test_clock.deleted' | 'test_helpers.test_clock.internal_failure' | 'test_helpers.test_clock.ready' | 'topup.canceled' | 'topup.created' | 'topup.failed' | 'topup.reversed' | 'topup.succeeded' | 'transfer.created' | 'transfer.reversed' | 'transfer.updated' | 'billing.discrepancy' | 'usage.report.empty' | 'customer.credit.insufficient' | 'customer.credit_grant.granted' | 'customer.credit_grant.low_balance' | 'customer.credit_grant.depleted', string>;
 export type StripeRefundReason = 'duplicate' | 'fraudulent' | 'requested_by_customer';
 export type SettingType = LiteralUnion<'donate' | 'notification', string>;
 export type NotificationFrequency = 'default' | 'daily' | 'weekly' | 'monthly';
@@ -442,4 +443,16 @@ export type NotificationSetting = {
     exclude_events?: EventType[];
     include_events?: EventType[];
 };
+export type CreditGrantApplicabilityConfig = {
+    scope: {
+        prices?: string[];
+        price_type?: 'metered';
+    };
+};
+export type MeterEventStatus = 'pending' | 'processing' | 'requires_action' | 'requires_capture' | 'completed' | 'canceled';
+export type MeterEventPayload = {
+    customer_id: string;
+    value: string;
+    subscription_id?: string;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocklet/payment-types",
-  "version": "1.19.0",
+  "version": "1.19.2",
   "description": "Typings for Payment Kit SDK",
   "keywords": [
     "types",
@@ -48,5 +48,5 @@
     "sequelize": "^6.37.7",
     "type-fest": "^4.41.0"
   },
-  "gitHead": "2810263174bb900ebb5a431dc53930b08b4a8d6d"
+  "gitHead": "741c897204afc412721a942201516932bff59235"
 }