Setup Guide

Get Started in 5 Minutes

1. Install from Shopify App Store

Click Install on the Shopify App Store listing. The app requests these scopes:

  • read_products — to read product and collection information for rule conditions
  • read_orders — to monitor new orders for plan matching
  • write_orders — to record payment plan assignments and charge attempts
  • read_customers — to check customer tags in rule conditions

2. Configure Stripe

Go to the app's Payments Providers page and enter your Stripe publishable key (pk_...). Your Stripe secret key (sk_... or rk_...) is stored as an environment variable on your server — it never touches the database.

Don't have a Stripe account? Create one free. You'll get test keys to start, then switch to live keys when you're ready.

3. Create Your First Payment Plan

Go to Payment Plans and click Create plan:

Field Example
Plan title "50% Deposit Handmade"
Plan type Deposit
Deposit type Percent
Deposit value 50
Auto-charge balance ✅ Enabled

You can also create Pre-order plans (deposit now, balance when item ships) or Deferred plans (split balance into installments).

4. Set Up a Rule

Go to Plan Rules and click Create rule:

Field Example
Rule name "Handmade collection orders"
Target plan "50% Deposit Handmade"
Condition Collection in order
GIDs gid://shopify/Collection/{your-collection-id}
Action Require
Priority 0

Now any order containing a product from that collection will automatically require a 50% deposit.

5. Test It

  1. Place a test order in your Shopify store (or use an existing one)
  2. The app's webhook will fire → the rule engine matches your rule → an OrderPayment is created
  3. Go to Orders & Payments to see the order with awaiting_deposit status
  4. Copy the deposit link and test the Stripe checkout flow
  5. After payment, status changes to deposit_paid

6. Turn On Autocharge + Dunning

If you're on Growth or Pro plan:

  • Autocharge: The npm run autocharge cron script collects outstanding balances automatically. Set it to run every 5-10 minutes.
  • Dunning: Failed payments trigger the 4-stage recovery flow automatically. No setup needed.

Ready to go? Install Shopigent Payments →