feat: support redirect URL in payment link after the purchase is complete

Author: quochuydev

python/stripe_agent_toolkit/functions.py

@@ -154,13 +154,14 @@ def list_prices(
     return stripe.Price.list(**prices_data).data
 
 
-def create_payment_link(context: Context, price: str, quantity: int):
+def create_payment_link(context: Context, price: str, quantity: int, redirect_url: Optional[str] = None):
     """
     Create a payment link.
 
     Parameters:
         price (str): The ID of the price.
         quantity (int): The quantity of the product.
+        redirect_url (string, optional): The URL the customer will be redirected to after the purchase is complete.
 
     Returns:
         stripe.PaymentLink: The created payment link.
@@ -173,6 +174,9 @@ def create_payment_link(context: Context, price: str, quantity: int):
         if account is not None:
             payment_link_data["stripe_account"] = account
 
+    if redirect_url:
+        payment_link_data["after_completion"] = {"type": "redirect", "redirect": {"url": redirect_url}}
+
     payment_link = stripe.PaymentLink.create(**payment_link_data)
 
     return {"id": payment_link.id, "url": payment_link.url}

python/stripe_agent_toolkit/prompts.py

@@ -51,6 +51,7 @@
 It takes two arguments:
 - price (str): The ID of the price to create the payment link for.
 - quantity (int): The quantity of the product to include in the payment link.
+- redirect_url (string, optional): The URL the customer will be redirected to after the purchase is complete.
 """
 
 LIST_INVOICES_PROMPT = """

python/stripe_agent_toolkit/schema.py

@@ -104,6 +104,10 @@ class CreatePaymentLink(BaseModel):
         ...,
         description="The quantity of the product to include.",
     )
+    redirect_url: Optional[str] = Field(
+        None,
+        description="The URL the customer will be redirected to after the purchase is complete.",
+    )
 
 
 class ListInvoices(BaseModel):

python/tests/test_functions.py

@@ -343,6 +343,24 @@ def test_create_payment_link(self):
 
             self.assertEqual(result, mock_payment_link)
 
+    def test_create_payment_link_with_redirect_url(self):
+        with mock.patch("stripe.PaymentLink.create") as mock_function:
+            mock_payment_link = {"id": "pl_123", "url": "https://example.com"}
+            mock_function.return_value = stripe.PaymentLink.construct_from(
+                mock_payment_link, "sk_test_123"
+            )
+
+            result = create_payment_link(
+                context={}, price="price_123", quantity=1, redirect_url="https://example.com"
+            )
+
+            mock_function.assert_called_with(
+                line_items=[{"price": "price_123", "quantity": 1, }],
+                after_completion={"type": "redirect", "redirect": {"url": "https://example.com"}}
+            )
+
+            self.assertEqual(result, mock_payment_link)
+
     def test_create_payment_link_with_context(self):
         with mock.patch("stripe.PaymentLink.create") as mock_function:
             mock_payment_link = {"id": "pl_123", "url": "https://example.com"}

typescript/src/shared/paymentLinks/createPaymentLink.ts

@@ -9,6 +9,7 @@ This tool will create a payment link in Stripe.
 It takes two arguments:
 - price (str): The ID of the price to create the payment link for.
 - quantity (int): The quantity of the product to include in the payment link.
+- redirect_url (str, optional): The URL to redirect to after the payment is completed.
 `;
 
 export const createPaymentLink = async (
@@ -19,7 +20,17 @@ export const createPaymentLink = async (
   try {
     const paymentLink = await stripe.paymentLinks.create(
       {
-        line_items: [params],
+        line_items: [{price: params.price, quantity: params.quantity}],
+        ...(params.redirect_url
+          ? {
+              after_completion: {
+                type: 'redirect',
+                redirect: {
+                  url: params.redirect_url,
+                },
+              },
+            }
+          : undefined),
       },
       context.account ? {stripeAccount: context.account} : undefined
     );
@@ -39,6 +50,10 @@ export const createPaymentLinkParameters = (_context: Context = {}) =>
       .number()
       .int()
       .describe('The quantity of the product to include.'),
+    redirect_url: z
+      .string()
+      .optional()
+      .describe('The URL to redirect to after the payment is completed.'),
   });
 
 const tool = (context: Context): Tool => ({

typescript/src/test/shared/paymentLinks/functions.test.ts

@@ -72,4 +72,39 @@ describe('createPaymentLink', () => {
     });
     expect(result).toEqual(mockPaymentLink);
   });
+
+  it('should specify the redirect URL if included in params', async () => {
+    const params = {
+      line_items: [
+        {
+          price: 'price_123456',
+          quantity: 1,
+        },
+      ],
+      after_completion: {
+        type: 'redirect',
+        redirect: {
+          url: 'https://example.com',
+        },
+      },
+    };
+
+    const mockPaymentLink = {
+      id: 'pl_123456',
+      url: 'https://example.com',
+    };
+
+    const context = {};
+
+    stripe.paymentLinks.create.mockResolvedValue(mockPaymentLink);
+
+    const result = await createPaymentLink(stripe, context, {
+      price: 'price_123456',
+      quantity: 1,
+      redirect_url: 'https://example.com',
+    });
+
+    expect(stripe.paymentLinks.create).toHaveBeenCalledWith(params, undefined);
+    expect(result).toEqual(mockPaymentLink);
+  });
 });

typescript/src/test/shared/paymentLinks/parameters.test.ts

@@ -5,14 +5,14 @@ describe('createPaymentLinkParameters', () => {
     const parameters = createPaymentLinkParameters({});
 
     const fields = Object.keys(parameters.shape);
-    expect(fields).toEqual(['price', 'quantity']);
-    expect(fields.length).toBe(2);
+    expect(fields).toEqual(['price', 'quantity', 'redirect_url']);
+    expect(fields.length).toBe(3);
   });
 
   it('should return the correct parameters if customer is specified', () => {
     const parameters = createPaymentLinkParameters({customer: 'cus_123'});
 
     const fields = Object.keys(parameters.shape);
-    expect(fields).toEqual(['price', 'quantity']);
+    expect(fields).toEqual(['price', 'quantity', 'redirect_url']);
   });
 });

typescript/src/test/shared/paymentLinks/prompts.test.ts

@@ -11,6 +11,9 @@ describe('createPaymentLinkPrompt', () => {
     expect(prompt).toContain(
       'quantity (int): The quantity of the product to include in the payment link.'
     );
+    expect(prompt).toContain(
+      'redirect_url (str, optional): The URL to redirect to after the payment is completed.'
+    );
   });
 
   it('should return the correct prompt with customer context', () => {
@@ -23,5 +26,8 @@ describe('createPaymentLinkPrompt', () => {
     expect(prompt).toContain(
       'quantity (int): The quantity of the product to include in the payment link.'
     );
+    expect(prompt).toContain(
+      'redirect_url (str, optional): The URL to redirect to after the payment is completed.'
+    );
   });
 });