Add explanation of the isTest Field

Also add the returnURL field to docs
Shopify · Nov 22, 2023 · 94de21e · 94de21e
1 parent 2dec481
commit 94de21e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.changeset/happy-lobsters-draw.md b/.changeset/happy-lobsters-draw.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/shopify-app-remix/src/server/authenticate/admin/billing/types.ts b/packages/shopify-app-remix/src/server/authenticate/admin/billing/types.ts
@@ -25,6 +25,14 @@ export interface RequestBillingOptions<Config extends AppConfigArg>
    * The plan to request. Must be one of the values defined in the `billing` config option.
    */
   plan: keyof Config['billing'];
+  /**
+   * Whether to use the test mode. This prevents the credit card from being charged. Test shops and demo shops cannot be charged.
+   */
+  isTest?: boolean;
+  /**
+   * The URL to return to after the merchant approves the payment.
+   */
+  returnUrl?: string;
 }
 
 export interface CancelBillingOptions {
@@ -38,6 +46,9 @@ export interface CancelBillingOptions {
    * {@link https://shopify.dev/docs/apps/billing/subscriptions/cancel-recurring-charges}
    */
   prorate?: boolean;
+  /*
+   * Whether to use the test mode. This prevents the credit card from being charged. Test shops and demo shops cannot be charged.
+   */
   isTest?: boolean;
 }