xendit-components-web 0.0.18 → 0.0.20

package/sdk/dist/index.d.ts

@@ -735,8 +735,9 @@ export declare interface XenditSession {
      *
      * PAY sessions create a payment request, calling /v3/payment_requests
      * SAVE sessions create a saved payment token, calling /v3/payment_tokens
+     * SUBSCRIPTION sessions create a subscription, also calling /v3/payment_tokens
      */
-    sessionType: "PAY" | "SAVE";
+    sessionType: "PAY" | "SAVE" | "SUBSCRIPTION";
     /**
      * The kind of session, only COMPONENT sessions can be used with the components SDK.
      */
@@ -791,6 +792,48 @@ export declare interface XenditSession {
      * Indicates whether the payment will be captured automatically or manually.
      */
     captureMethod?: "AUTOMATIC" | "MANUAL";
+    /**
+     * For subscription sessions, the subscription details. This will be undefined for PAY and SAVE sessions.
+     */
+    subscription?: {
+        /**
+         * Whether the first payment for the subscription should be made immediately upon session completion, or only after the anchor date.
+         */
+        immediatePayment?: boolean;
+        /**
+         * The subscription schedule. This includes the anchor date, which determines when the subscription payments will be made, as well as the interval and count for both the regular payments and the retries.
+         */
+        schedule: {
+            /**
+             * The anchor date for the subscription. This determines when the subscription payments will be made.
+             */
+            anchorDate: Date;
+            /**
+             * The interval for the subscription payments.
+             */
+            interval: "DAY" | "WEEK" | "MONTH";
+            /**
+             * The number of intervals for the subscription payments.
+             */
+            intervalCount: number;
+            /**
+             * The interval for retrying failed subscription payments.
+             */
+            retryInterval?: "DAY" | "WEEK" | "MONTH";
+            /**
+             * The number of intervals for retrying failed subscription payments.
+             */
+            retryIntervalCount?: number;
+            /**
+             * The total number of subscription payments.
+             */
+            totalRecurrence?: number;
+            /**
+             * The total number of retry attempts for failed subscription payments.
+             */
+            totalRetry?: number;
+        };
+    };
     /**
      * Line items. The components SDK does not use this, but you may show it to your users.
      */