@plyaz/types 1.16.6 → 1.16.8

package/dist/payments/provider/core/enums.d.ts

@@ -6,3 +6,10 @@ export declare enum WITHDRAWAL_STATUS {
     Failed = "failed",
     Cancelled = "cancelled"
 }
+export declare enum SUBSCRIPTION_STATUS {
+    ACTIVE = "active",
+    TRIALING = "trialing",
+    PAUSED = "paused",
+    CANCELED = "canceled",
+    EXPIRED = "expired"
+}

package/dist/payments/provider/core/types.d.ts

@@ -1,7 +1,7 @@
 import type { CurrencyCode } from '../../../locale/types';
 import type { FeeBreakdown, Money } from '../../transaction';
 import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE, PAYMENT_STATUS } from '../provider-capability';
-import type { WITHDRAWAL_STATUS } from './enums';
+import type { SUBSCRIPTION_STATUS, WITHDRAWAL_STATUS } from './enums';
 /**
  * Parameters required to initiate a refund.
  * Refunds can be full or partial.
@@ -353,26 +353,44 @@ export interface SavedPaymentMethod<TMetadata extends object = object> {
 export interface CreateSubscriptionParams<TMetadata extends object = object> {
     /** Plyaz user ID (Stripe customer ID or your internal user ID mapped to Stripe) */
     userId: string;
-    /** Plan to subscribe the user to: 'standard' | 'pro' | 'enterprise' */
-    plan: 'standard' | 'pro' | 'enterprise';
-    /** Payment method to charge (Stripe payment method ID) */
-    paymentMethodId: string;
+    paymentMethod: PAYMENT_METHOD;
+    /** Plan to subscribe the user to (internal plan name) */
+    plan: string;
     /** Optional trial period in days */
     trialDays?: number;
+    /** URL to redirect user after successful payment completion */
+    returnUrl?: string;
+    /** URL to redirect user after payment cancellation */
+    cancelUrl?: string;
+    /**
+     * Idempotency key to prevent duplicate payment processing
+     * Should be unique per payment attempt, recommended: UUID v4
+     */
+    idempotencyKey?: string;
     /** Optional metadata for additional info */
-    metadata?: TMetadata;
+    metadata?: {
+        /** Geographic and device information */
+        geoInfo?: {
+            country: string;
+            region?: string;
+            city?: string;
+            timezone?: string;
+        };
+        /** Custom metadata fields */
+        custom?: TMetadata;
+    };
 }
 export interface SubscriptionResult<TMetadata extends object = object> {
-    /** Internal subscription ID */
-    subscriptionId: string;
-    /** Provider subscription ID */
+    /** Checkout session URL for user to complete subscription */
+    checkoutUrl: string;
+    /** Optional: provider subscription ID (available after webhook confirmation) */
     providerSubscriptionId?: string;
     /** Status: active, trialing, paused, canceled, expired */
-    status: 'active' | 'trialing' | 'paused' | 'canceled' | 'expired';
-    /** Next billing date */
+    status?: SUBSCRIPTION_STATUS;
+    /** Next billing date (available after webhook) */
     nextBillingDate?: Date;
-    /** Subscription start date */
-    startedAt: Date;
+    /** Subscription start date (available after webhook) */
+    startedAt?: Date;
     /** Provider-specific metadata */
     metadata?: TMetadata;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.16.6",
+  "version": "1.16.8",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",