Merge pull request #311 from stripe/hkj-session-params

feat: Added more parameters to SessionCreateParams

Author: hiranya911

firestore-stripe-web-sdk/etc/firestore-stripe-payments.api.md

@@ -15,9 +15,19 @@ export interface CommonLineItemParams {
 
 // @public
 export interface CommonSessionCreateParams {
+    allow_promotion_codes?: boolean;
+    automatic_tax?: boolean;
     cancel_url?: string;
+    client_reference_id?: string;
+    metadata?: {
+        [key: string]: any;
+    };
     mode?: "subscription" | "payment";
+    payment_method_types?: PaymentMethodType[];
+    promotion_code?: string;
     success_url?: string;
+    tax_id_collection?: boolean;
+    trial_from_plan?: boolean;
 }
 
 // @public (undocumented)
@@ -92,6 +102,9 @@ export interface LineItemSessionCreateParams extends CommonSessionCreateParams {
 // @public
 export function onCurrentUserSubscriptionUpdate(payments: StripePayments, onUpdate: (snapshot: SubscriptionSnapshot) => void, onError?: (error: StripePaymentsError) => void): () => void;
 
+// @public
+export type PaymentMethodType = "card" | "acss_debit" | "afterpay_clearpay" | "alipay" | "bacs_debit" | "bancontact" | "boleto" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "oxxo" | "p24" | "sepa_debit" | "sofort" | "wechat_pay";
+
 // @public
 export interface Price {
     // (undocumented)
@@ -137,14 +150,24 @@ export interface Product {
 
 // @public
 export interface Session {
+    readonly allow_promotion_codes?: boolean;
+    readonly automatic_tax?: boolean;
     readonly cancel_url: string;
+    readonly client_reference_id?: string;
     readonly created_at: string;
     readonly id: string;
     readonly line_items?: LineItem[];
+    readonly metadata?: {
+        [key: string]: any;
+    };
     readonly mode: "subscription" | "payment";
+    readonly payment_method_types?: PaymentMethodType[];
     readonly price?: string;
+    readonly promotion_code?: string;
     readonly quantity?: number;
     readonly success_url: string;
+    readonly tax_id_collection?: boolean;
+    readonly trial_from_plan?: boolean;
     readonly url: string;
 }
 

firestore-stripe-web-sdk/src/index.ts

@@ -31,6 +31,7 @@ export {
   LineItem,
   LineItemParams,
   LineItemSessionCreateParams,
+  PaymentMethodType,
   PriceIdLineItemParams,
   PriceIdSessionCreateParams,
   Session,

firestore-stripe-web-sdk/src/session.ts

@@ -43,23 +43,90 @@ import {
  * Parameters common across all session types.
  */
 export interface CommonSessionCreateParams {
+  /**
+   * Enables user redeemable promotion codes.
+   */
+  allow_promotion_codes?: boolean;
+
+  /**
+   * Set to true to enable automatic taxes. Defaults to false.
+   */
+  automatic_tax?: boolean;
+
+  /**
+   * A unique string to reference the Checkout Session. This can be a customer ID, a cart ID,
+   * or similar, and can be used to reconcile the session with your internal systems.
+   */
+  client_reference_id?: string;
+
   /**
    * The URL the customer will be directed to if they decide to cancel payment and return to
    * your website.
    */
   cancel_url?: string;
 
+  /**
+   * Set of key-value pairs that you can attach to an object. This can be useful for storing
+   * additional information about the object in a structured format.
+   */
+  metadata?: { [key: string]: any };
+
   /**
    * The mode of the Checkout Session. If not specified defaults to `subscription`.
    */
   mode?: "subscription" | "payment";
 
+  /**
+   * A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
+   * Defaults to `["card"]`.
+   */
+  payment_method_types?: PaymentMethodType[];
+
+  /**
+   * The promotion code to apply to this Session.
+   */
+  promotion_code?: string;
+
   /**
    * The URL to which Stripe should send customers when payment or setup is complete.
    */
   success_url?: string;
+
+  /**
+   * Controls tax ID collection settings for the session.
+   */
+  tax_id_collection?: boolean;
+
+  /**
+   * Indicates if a plan’s `trial_period_days` should be applied to the subscription. Defaults
+   * to `true`.
+   */
+  trial_from_plan?: boolean;
 }
 
+/**
+ * Supported payment methods.
+ */
+export type PaymentMethodType =
+  | "card"
+  | "acss_debit"
+  | "afterpay_clearpay"
+  | "alipay"
+  | "bacs_debit"
+  | "bancontact"
+  | "boleto"
+  | "eps"
+  | "fpx"
+  | "giropay"
+  | "grabpay"
+  | "ideal"
+  | "klarna"
+  | "oxxo"
+  | "p24"
+  | "sepa_debit"
+  | "sofort"
+  | "wechat_pay";
+
 /**
  * Parameters for createing a session with one or more line items.
  */
@@ -160,22 +227,66 @@ export interface Session {
    */
   readonly url: string;
 
+  /**
+   * Enables user redeemable promotion codes.
+   */
+  readonly allow_promotion_codes?: boolean;
+
+  /**
+   * Indicates whether automatic tax is enabled for the session
+   */
+  readonly automatic_tax?: boolean;
+
+  /**
+   * A unique string to reference the Checkout Session. This can be a customer ID, a cart ID,
+   * or similar, and can be used to reconcile the session with your internal systems.
+   */
+  readonly client_reference_id?: string;
+
   /**
    * The array of line items purchased with this session. A session is guaranteed to contain either
    * {@link Session.line_items} or {@link Session.price}.
    */
   readonly line_items?: LineItem[];
 
+  /**
+   * Set of key-value pairs that you can attach to an object. This can be useful for storing
+   * additional information about the object in a structured format.
+   */
+  readonly metadata?: { [key: string]: any };
+
+  /**
+   * A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
+   * Defaults to `["card"]`.
+   */
+  readonly payment_method_types?: PaymentMethodType[];
+
   /**
    * The ID of the Stripe price object purchased with this session. A session is guaranteed to
    * contain either {@link Session.line_items} or {@link Session.price}.
    */
   readonly price?: string;
 
+  /**
+   * The promotion code to apply to this Session.
+   */
+  readonly promotion_code?: string;
+
   /**
    * The quantity of item purchased. Defaults to 1.
    */
   readonly quantity?: number;
+
+  /**
+   * Controls tax ID collection settings for the session.
+   */
+  readonly tax_id_collection?: boolean;
+
+  /**
+   * Indicates if a plan’s `trial_period_days` should be applied to the subscription. Defaults
+   * to `true`.
+   */
+  readonly trial_from_plan?: boolean;
 }
 
 /**

firestore-stripe-web-sdk/test/emulator.spec.ts

@@ -187,29 +187,59 @@ describe("Emulator tests", () => {
           },
         ];
         const session = await createCheckoutSession(payments, {
+          allow_promotion_codes: true,
+          automatic_tax: true,
           cancel_url: "https://example.com/cancel",
+          client_reference_id: "example",
           line_items: lineItems,
+          metadata: {
+            test: true,
+          },
           mode: "subscription",
+          payment_method_types: ["card"],
+          promotion_code: "discount",
           success_url: "https://example.com/success",
+          tax_id_collection: true,
+          trial_from_plan: true,
         });
 
         expect(backend.events).to.have.length(1);
         const { uid, docId, data, timestamp } = backend.events[0];
         expect(session).to.eql({
+          allow_promotion_codes: true,
+          automatic_tax: true,
           cancel_url: "https://example.com/cancel",
+          client_reference_id: "example",
           created_at: timestamp.toDate().toUTCString(),
           id: `test_session_${docId}`,
           line_items: lineItems,
+          metadata: {
+            test: true,
+          },
           mode: "subscription",
+          payment_method_types: ["card"],
+          promotion_code: "discount",
           success_url: "https://example.com/success",
+          tax_id_collection: true,
+          trial_from_plan: true,
           url: `https://example.stripe.com/session/${docId}`,
         });
         expect(uid).to.equal(currentUser);
         expect(data).to.eql({
+          allow_promotion_codes: true,
+          automatic_tax: true,
           cancel_url: "https://example.com/cancel",
+          client_reference_id: "example",
           line_items: lineItems,
+          metadata: {
+            test: true,
+          },
           mode: "subscription",
+          payment_method_types: ["card"],
+          promotion_code: "discount",
           success_url: "https://example.com/success",
+          tax_id_collection: true,
+          trial_from_plan: true,
         });
       });
 
@@ -240,32 +270,62 @@ describe("Emulator tests", () => {
 
       it("should create a session when called with all price ID parameters", async () => {
         const session = await createCheckoutSession(payments, {
+          allow_promotion_codes: true,
+          automatic_tax: true,
           cancel_url: "https://example.com/cancel",
+          client_reference_id: "example",
+          metadata: {
+            test: true,
+          },
           mode: "subscription",
+          payment_method_types: ["card"],
           price: "foo",
+          promotion_code: "discount",
           quantity: 5,
           success_url: "https://example.com/success",
+          tax_id_collection: true,
+          trial_from_plan: true,
         });
 
         expect(backend.events).to.have.length(1);
         const { uid, docId, data, timestamp } = backend.events[0];
         expect(session).to.eql({
+          allow_promotion_codes: true,
+          automatic_tax: true,
           cancel_url: "https://example.com/cancel",
+          client_reference_id: "example",
           created_at: timestamp.toDate().toUTCString(),
           id: `test_session_${docId}`,
+          metadata: {
+            test: true,
+          },
           mode: "subscription",
+          payment_method_types: ["card"],
           price: "foo",
+          promotion_code: "discount",
           quantity: 5,
           success_url: "https://example.com/success",
+          tax_id_collection: true,
+          trial_from_plan: true,
           url: `https://example.stripe.com/session/${docId}`,
         });
         expect(uid).to.equal(currentUser);
         expect(data).to.eql({
+          allow_promotion_codes: true,
+          automatic_tax: true,
           cancel_url: "https://example.com/cancel",
+          client_reference_id: "example",
+          metadata: {
+            test: true,
+          },
           mode: "subscription",
+          payment_method_types: ["card"],
           price: "foo",
+          promotion_code: "discount",
           quantity: 5,
           success_url: "https://example.com/success",
+          tax_id_collection: true,
+          trial_from_plan: true,
         });
       });
 

firestore-stripe-web-sdk/test/session.spec.ts

@@ -44,12 +44,22 @@ const payments: StripePayments = getStripePayments(app, {
 });
 
 const testSession: Session = {
+  allow_promotion_codes: true,
+  automatic_tax: true,
   cancel_url: "https://example.com/cancel",
+  client_reference_id: "example",
   created_at: new Date().toUTCString(),
   id: "test_session_1",
+  metadata: {
+    test: true,
+  },
   mode: "subscription",
+  payment_method_types: ["card"],
   price: "price1",
+  promotion_code: "discount",
   success_url: "https://example.com/success",
+  tax_id_collection: true,
+  trial_from_plan: true,
   url: "https://example.stripe.com/session/test_session_1",
 };
 
@@ -183,11 +193,21 @@ describe("createCheckoutSession()", () => {
     const userFake: SinonSpy = sinonFake.returns("alice");
     setUserDAO(payments, testUserDAO(userFake));
     const params: SessionCreateParams = {
+      allow_promotion_codes: true,
+      automatic_tax: true,
+      client_reference_id: "example",
       cancel_url: "https://example.com/cancel",
+      metadata: {
+        test: true,
+      },
       mode: "subscription",
+      payment_method_types: ["card"],
       price: "price1",
+      promotion_code: "discount",
       quantity: 5,
       success_url: "https://example.com/success",
+      tax_id_collection: true,
+      trial_from_plan: true,
     };
 
     const session: Session = await createCheckoutSession(payments, params);