Configuration

Automated Subscriptions has no settings page of its own. It is configured through four fields it adds to Subscription Settings, four fields on each Customer, the Payment Gateway of each Subscription Plan, and one site configuration key. This page lists them, then lists everything the app adds to your site.

Subscription Settings

The app adds an Automated Subscriptions section to Subscription Settings, below ERPNext's Prorate.

The defaults are written to the database when the app is installed and on every bench migrate, so the form and the billing code see the same values. A value you saved is never overwritten.

ERPNext's own settings on the same page still apply. Grace Period and Cancel Subscription After Grace Period decide when an unpaid subscription becomes Unpaid or Cancelled. Prorate decides whether a cancellation invoice is prorated; for an anchored customer it also decides whether the first, partial period is prorated (off, the first period is billed at the full plan rate).

There is no setting for a delay before a payment is collected. When the money is collected comes from Days Until Due on each Subscription: see When the customer is charged.

Customer: Subscription Billing

The Subscription Billing section on the Accounting tab of the Customer form switches the billing engine on for that customer. With every field blank or off, the customer is billed by stock ERPNext.

Subscription Plan and Subscription

These ERPNext fields decide what the app does with a subscription.

Stop all automatic charging

Add this key to the site's site_config.json to stop every automatic charge on that site:

{
	"subscription_auto_charge_disabled": 1
}

Or from the bench directory:

bench --site <SITE_NAME> set-config subscription_auto_charge_disabled 1

With the key set, submitting a subscription invoice raises no Payment Request at all. Invoices are still made. Frappe also reads the key from common_site_config.json, where it stops charging on every site of the bench.

The key lives in the site's directory and is not part of a database backup. A copy of a live site restored onto a staging bench therefore does not carry it over: set it on the staging site before the copy's scheduler runs, so the copy does not charge live mandates.

Selling Settings

A consolidated invoice cannot hold two lines with the same item and the same description unless Allow same Item to be added multiple times in a transaction is ticked in Selling Settings. Giving each subscription its own Service Identifier avoids the clash. See Consolidate invoices.

Permissions

The app adds no roles. It checks these permissions itself:

The Payment Request is made with permissions ignored, so whoever submits the invoice (a user, or the scheduler) does not need rights on Payment Request. The invoices themselves are made by ERPNext's subscription code, as in stock ERPNext.

What the app adds to your site

This is the complete list, so you can see what a migration changes.

Fields

Property setters

Behaviour

The app adds no scheduled job. ERPNext's daily Process Subscription job bills consolidating customers too, through the extended Subscription class.

Whitelisted methods

The extended classes also re-declare three methods that ERPNext already whitelists, so the desk keeps calling them: cancel_subscription and process on Subscription, and set_missing_values on Sales Invoice.

Related

• Install and upgrade

• How it works for the code behind each row above