@blocklet/payment-types 1.23.11 → 1.24.0

package/lib/subscription.d.ts

@@ -1,6 +1,6 @@
 import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
-import type { PaymentDetails, PaymentSettings, PriceRecurring, ServiceAction, SubscriptionBillingThresholds } from './types';
+import type { CreditScheduleState, PaymentDetails, PaymentSettings, PriceRecurring, ServiceAction, SubscriptionBillingThresholds } from './types';
 export declare const nextSubscriptionId: (size?: number) => string;
 export declare class Subscription extends Model<InferAttributes<Subscription>, InferCreationAttributes<Subscription>> {
     id: CreationOptional<string>;
@@ -70,6 +70,7 @@ export declare class Subscription extends Model<InferAttributes<Subscription>, I
         payment_method_id: string;
         payment_details: PaymentDetails;
     };
+    credit_schedule_state?: CreditScheduleState;
     static readonly GENESIS_ATTRIBUTES: {
         id: {
             type: DataTypes.StringDataType;

package/lib/types.d.ts

@@ -501,6 +501,37 @@ export type StructuredSourceDataField = {
     group?: string;
 };
 export type SourceData = SimpleSourceData | StructuredSourceDataField[];
+export type CreditScheduleConfig = {
+    enabled: boolean;
+    delivery_mode: 'invoice' | 'schedule';
+    interval_value: number;
+    interval_unit: 'hour' | 'day' | 'week' | 'month';
+    amount_per_grant?: string;
+    first_grant_timing?: 'immediate' | 'after_trial' | 'after_first_payment';
+    expire_with_next_grant?: boolean;
+    max_grants_per_period?: number;
+};
+export type CreditConfig = {
+    credit_amount: string;
+    currency_id: string;
+    applicable_prices?: string[];
+    valid_duration_value?: number;
+    valid_duration_unit?: 'hours' | 'days' | 'weeks' | 'months' | 'years';
+    priority?: number;
+    schedule?: CreditScheduleConfig;
+};
+export type CreditSchedulePriceState = {
+    enabled: boolean;
+    schedule_anchor_at: number;
+    next_grant_at: number;
+    last_grant_seq: number;
+    grants_in_current_period: number;
+    last_grant_id?: string;
+    last_error?: string;
+};
+export type CreditScheduleState = {
+    [priceId: string]: CreditSchedulePriceState;
+};
 export type CreditGrantChainStatus = 'mint_pending' | 'mint_completed' | 'mint_failed' | 'burn_pending' | 'burn_completed' | 'burn_failed' | 'transfer_completed' | 'transfer_failed';
 export type CreditGrantChainDetail = {
     mint?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocklet/payment-types",
-  "version": "1.23.11",
+  "version": "1.24.0",
   "description": "Typings for Payment Kit SDK",
   "keywords": [
     "types",
@@ -48,5 +48,5 @@
     "sequelize": "^6.37.7",
     "type-fest": "^4.41.0"
   },
-  "gitHead": "72af80fc6e91e88058665212985002966f55787c"
+  "gitHead": "f3fad0829a1377422d51f9b6445a3502d0e94719"
 }