View Product Page

Emails

The plugin will automatically send an email to users and/or to the shop admin when certain conditions are met. Email settings can be managed from WooCommerce > Settings > Emails.

Besides the default emails, you will also find the emails generated by the plugin.

Emails
  • Subscription status: Sent to admin to inform about a status change in subscriptions (user paused/resumed etc).
  • Subscription cancelled: Sent to users when a subscription is cancelled.
  • Subscription suspended: Sent to users when subscription switches to ‘suspended’.
  • Subscription expired: Sent to users when the subscription is expired.
  • Subscription is going to expire: Sent to users 1 day before subscription expires.
  • Subscription paused: Sent to users when a subscription is paused.
  • Subscription resumed: Sent to users when a subscription is resumed.
  • Subscription payment request: Sent to users when payment has not been received within periodic payment expiration date.
  • Subscription renew reminder: Sent as a reminder for the next payment a certain number of days before the due date (default 15 days).
  • Subscription payment made: Sent to users when shop admin receives payment.
  • Subscription payment failed: Sent to users whenever a payment attempt fails.
  • Subscription Delivery Schedules: sent to users whenever a scheduled delivery is set to shipped.

The admin can decide if he wants to receive a copy of each email. Click on the email you wish to receive a copy of, and enable ‘Send to admin?’.

copy email admin

REST API

From version 2.4, YITH Subscription supports REST API.

Requirements

It is essential to enable WordPress permalinks in Settings > Permalinks.

How to generate API keys

The WooCommerce REST API works on a key system to control access. These keys are linked to WordPress users on your website.

REST API key

To create or manage keys for a specific WordPress user:

  1. Go to: WooCommerce > Settings > Advanced > REST API.
  2. Select Add Key. You will be redirected to the Key Details screen.
API key details

3. Add a Description.
4. Select the User you would like to generate a key for in the dropdown.
5. Select a level of access for this API key — Read access, Write access or Read/Write access.
6. Select Generate API Key, and WooCommerce will create API keys for that user.
 

Now that keys have been generated, you should see Consumer Key and Consumer Secret, a QRCode, and a Revoke API Key button.

REST API key generated

The Consumer Key and Consumer Secret may be entered in the application using the WooCommerce API, and the app should also request your URL.

You can find the REST API documentation at https://docs.yithemes.com/yith-woocommerce-subscription-rest-api/

Webhook

A Webhook is an event notification sent to an URL of your choice. Users can configure them to trigger events on one site to invoke behavior on another.

Webhooks are useful for integrations with third-party services and other external APIs that support them.

How to create webhooks

To create a new webhook:
1. go to WooCommerce > Settings > Advanced > Webhooks.

Note: Webhooks were formerly found under WooCommerce > Settings > API before WooCommerce 3.4.

2. Select Create a new webhook (first incident) or Add webhook. The Webhook Databox will show.

WooCommerce webhooks

3. Set the following:

  • Name: The name is auto-generated as “Webhook created on [date and time of creation]” as a standard to simplify its creation. Change the name to something else.
  • Status: Set to Active (delivers payload), Paused (does not deliver), or Disabled (does not deliver due to delivery failures).
  • Topic: Choose when the webhook should be triggered from

– subscription created
– subscription updated
– subscription deleted
– subscription restored

Webhook topic

  • Delivery URL: URL where the webhook payload is delivered.
  • Secret: The Secret Key generates a hash of the delivered webhook and is provided in the request headers. This defaults to the current API user’s consumer secret if nothing is entered.

4. Save Webhook.

Blocks

The plugin is ready to use with the block editor. With one click, you can add the YITH block to your page.

Gutenberg block

You can customize it the way you want to by using the many options it offers.

edit gutenberg fields

Change colors, add shadows, links, images, CSS etc.

Gutenberg frontend view

YITH WooCommerce Account Funds

The integration with  YITH WooCommerce Account Funds, lets the customers pay with their Funds, also renew orders can be payed with Funds. After the installation the payment method YITH Funds must be enabled from WooCommerce > Settings > Payments.

Integration with YITH Account Funds

You will be able to perform the following actions on your subscriptions:

  • cancel: both the admin and the customers can cancel a subscription.
  • pause: both the admin and the customers can pause a subscription.
  • add multiple subscriptions to the same cart: any user will be able to add more than one subscription to the same cart and pay with credit card.
  • edit details of ongoing subscriptions: billing cycle, price, billing date, expiry date, subscription recurring amount.
Edit subscription details

You will be able to edit the following subscription information:

Recurring period: you can change the duration of the billing cycle and change it to a given number of days, weeks, months or years.

Start date: you can change the start date of the subscription. A note in the subscription details will keep track of this action. You will see a note with the following text: The start date has been changed from xx/xx/xxxx to xx/xx/xxxx.

Payment due date: change here the date of the next payment. The customer will automatically be charged on the new date you’ve set. A note in the subscription details will keep track of this action.

Expired date: you can change here the subscription expiry date here. Remove the date if you want the subscription to NEVER expire.
Please, note that if the subscription is already expired, changing the expiry date here will not re-activate the subscription, you will have to change it from the subscription Actions box on the right. Read more about this here.

You will also be able to edit the price of the recurring fee:

Edit price of ongoing subscriptions

YITH WooCommerce Affiliates

The integration with YITH WooCommerce Affiliates plugin allows the admin to enable commissions for your affiliates also on renewal orders.

To enable this, make sure both plugins are activated, then, go to YITH > Affiliates > General options > Commissions & Payments, and you’ll see a new option in the Commissions section called Enable commission handling for renews.

Integration with YITH Affiliates

Choose the option that best suits your business:

  • Do not handle renewals: this will not assign any commissions to affiliates for renewal orders.
  • Register only first renew, when subscription switches from trial to active: this allows you to generate a commission for the first renewal order. This might be useful in case you offer a free trial, and so the first order is a €0, but you want to grant anyway a commission on the first actual payment to the affiliate who generated that sale.
  • Register all renews: this will assign affiliate commissions also on renewal orders.

For more details about the YITH Affiliates settings, please, refer to the plugin documentation.

YITH WooCommerce Automatic Role Changer

With the Automatic Role Changer plugin you can automatically assign roles to your customers depending on a specific purchase or amount spent.

Integration with YITH Automatic Role Changer

If you combine this plugin with YITH WooCommerce Subscription, the customer will automatically get the role you have set when the subscription changes to status ‘active’ or ‘trial’. The role will be removed automatically when the subscription gets the status ‘paused’, ‘pending’, ‘overdue’, ‘cancelled’, ‘expired’ or ‘suspended’.

You will only have to activate both plugins in order to make them work together. For more information on how to create a rules, check the full documentation here.

YITH Customize My Account Page

YITH WooCommerce Customize My Account Page helps you customize “My Account” page in your website in a few simple steps, adding new sections and editing the default WooCommerce ones.

Thanks to this integration you can automatically show ‘My subscriptions’ menu in My Account and easily edit it as you prefer.

To start using them together, just make sure you have installed and activated both plugins from Plugins menu in your WordPress dashboard.

Then, you will see My subscription menu automatically appear in the list of endpoints in YITH > Customize My Account Page. You can either keep it as is so it will automatically show users all their subscriptions or customize it with custom content.

Integration with YITH Customize My Account Page
Integration with YITH Customize My Account Page

For more details about the configuration of YITH Customize My Account Page plugin, please, refer to the official plugin documentation.

YITH Donations for WooCommerce

YITH Donations for WooCommerce is the plugin that allows adding a form to your site through which your users can make online donations. You can show the donation form on one or more products, on the cart page, use the widget to show the donations received and much more.

When used in combination with YITH WooCommerce Subscription, it allows turning the product created by the plugin (named YITH Donations for WooCommerce) into a subscription-based product and receiving recurring donations from your customers.

After installing and activating both plugins, go to WooCommerce > Products and search for YITH Donations for WooCommerce. In the product edit page, enable the checkbox Subscription.

Donations with subscription

Now you will be able to set the subscription details like for any other subscription-based product.

Donation with subscription settings

For further details about YITH Donations for WooCommerce settings, please refer to the official documentation.

YITH WooCommerce Email Templates

Thanks to the integration with YITH WooCommerce Email Templates, you are also free to customize every single email it sends. You only need to install and activate both plugins and you will have the possibility to stylize the following emails:

  • Subscription status
  • Subscription cancelled
  • Subscription suspended
  • Subscription expired
  • Subscription is going to expire
  • Subscription paused
  • Subscription resumed
  • Subscription payment request
  • Subscription renew reminder
  • Subscription payment made
  • Subscription failed
subscription_email