Plugin Header
Plugin URI: https://swregistry.earthasylum.com/subscriptions-for-woocommerce/
Author: EarthAsylum Consulting
Stable tag: 2.1.1
Last Updated: 08-Nov-2024
Requires at least: 5.8
Tested up to: 6.7
WC requires at least: 7.0
WC tested up to: 9.3
Requires PHP: 7.4
Contributors: kevinburkholder
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl.html
Tags: WooCommerce Subscriptions, WooCommerce Webhooks, SUMO subscriptions, subscriptions, {eac}SoftwareRegistry
WordPress URI: https://wordpress.org/plugins/eacsoftwareregistry-subscription-webhooks/
Github URI: https://github.com/EarthAsylum/eacsoftwareregistry-subscription-webhooks/
Adds a custom Webhook topic to WooCommerrce Webhooks for subscription updates; adds subscription and product data to WooCommerce order Webhooks.
{eac}SoftwareRegistry Subscriptions for WooCommerce is a plugin, installed on your WooCommerce site, that adds a custom Webhook topic for subscription updates to the WooCommerrce Webhooks, and adds subscription and product data to WooCommerce order Webhooks.
-
Adds a custom Webhook topic for subscription updates to WooCommerce Webhooks.
-
Extends the WooCommerce Order Webhooks by adding subscription data to orders with subscriptions.
-
Adds product meta data to order and subscription records passed through WooCommerce webhooks.
-
Works with WooCommerce Subscriptions - and - SUMO Subscriptions.
When WooCommerce creates an order, the order is stored as a post with type set to "shop_order". When the order is for a subscription, a related order is stored as a post with type set to "shop_subscription". When a subscription is renewed, a new "shop_order" is created related back to the original "shop_subscription" order.
When subscriptions (shop_subscription) are passed through the "{eac}SoftwareRegistry Subscription updated" webhook, additional subscription data and related order numbers are added to the subscription order record being passed.
When orders (shop_order) are passed through the WooCommerce Order created, Order updated, and Order restored webhooks, this plugin will append any related shop_subscription orders with the additional subscription data and related order numbers.
Meta data (custom fields and attributes) from the products in the order may be appended to the order and subscription records.
For order webhooks, options are presented on the "Webhook" edit screen to choose what data may be added to the orders so that extended data is only retrieved and sent through the webhook where needed.
WooCommerce Webhooks are created by going to: WooCommerce → Settings → Advanced → Webhooks in the administration of your store site.
With version 2+, SUMO Subscriptions is also supported in nearly the same way as WooCommerce Subscriptions by creating a pseudo shop_subscription order from the SUMO Subscription post record and the original or renewal WooCommerce shop_order.
To create a webhook for subscription updates, choose "{eac}SoftwareRegistry Subscription updated", when using Woo Subscriptions, or "{eac}SoftwareRegistry Sumo Subscription", when using SUMO Subscriptions, for the topic on the Webhook data screen.
Whenever a subscription is updated, the subscription data will be sent to the Delivery URL specified in the Webhook.
This plugin also adds subscription data to orders passed through the Order created, Order updated, and Order restored webhooks when the order has related subscription(s).
Orders without subscriptions may be appended with meta data from the products in the order.
The subscription data added (overlayed on the shop_subscription record) in the webhooks is:
'date_created' => datetime // 'YYYY-MM-DDThh:mm:ss',
'date_modified' => datetime // 'YYYY-MM-DDThh:mm:ss',
'date_paid' => datetime // 'YYYY-MM-DDThh:mm:ss',
'date_completed' => datetime // 'YYYY-MM-DDThh:mm:ss',
'last_order_id' => int // last completed order id,
'last_order_date_created' => datetime // 'YYYY-MM-DDThh:mm:ss',
'last_order_date_paid' => datetime // 'YYYY-MM-DDThh:mm:ss',
'last_order_date_completed' => datetime // 'YYYY-MM-DDThh:mm:ss',
'schedule_trial_end' => datetime // 'YYYY-MM-DDThh:mm:ss',
'schedule_start' => datetime // 'YYYY-MM-DDThh:mm:ss',
'schedule_end' => datetime // 'YYYY-MM-DDThh:mm:ss',
'schedule_cancelled' => datetime // 'YYYY-MM-DDThh:mm:ss',
'schedule_next_payment' => datetime // 'YYYY-MM-DDThh:mm:ss',
'schedule_payment_retry' => datetime // 'YYYY-MM-DDThh:mm:ss',
'billing_period' => string // 'day','month','year',
'billing_interval' => int // number of days,months,years,
'sign_up_fee' => float // signup fee amount,
'product_meta' => array // [ product_id => [product_meta_data] ]
'related_orders' => array // [ order_id => type ('parent','renewal','resubscribe','switch') ]
product_meta includes:
'id' => int // product id,
'name' => string // product name,
'slug' => string // product slug,
'sku' => string // product sku,
'attributes' => array // product attributes (name => value)
'meta_data' => array // product custom fields (name => value)
'categories' => array // product categories (slug => name)
For the subscription webhook, this data is overlayed on the subscription order created by WooCommerce.
For the order webhooks, this data is overlayed on the related subscription order and appended to the shop_order in a "subscriptions" array, indexed by id (allowing for multiple subscriptions per order).
For orders without subscriptions, the product_meta array is appended to the shop_order.
The pseudo subscription order is built by taking the SUMO subscription post record and overlaying the most recent shop_order. The 'id' number of the pseudo order is the subscription post id. The parent id is the original shop_order that created the subscription.
You must have the {eac}SoftwareRegistry WebHooks for WooCommerce extension enabled on your Software Registration server.
When creating a subscription webhook, the Delivery URL for "{eac}SoftwareRegistry Subscription updated" and "{eac}SoftwareRegistry Sumo Subscription" is:
https://{your_registration_server}.com/wp-json/softwareregistry/v1/wc-subscription
When creating order webhooks, the Delivery URL for Order created, Order updated, Order deleted and Order restored is:
https://{your_registration_server}.com/wp-json/softwareregistry/v1/wc-order
With this configuration, you can pass registry values (registry_*) in the product_meta array by creating custom fields on the product record and overriding the registration server defaults. For example:
registry_product = package_name
registry_license = Basic
See {eac}SoftwareRegistry WebHooks for WooCommerce for more information.
This plugin is intended to be installed on your WooCommerce store site (not necessarily your software registration server).
This plugin is available from the WordPress Plugin Repository and can be installed from the WordPress Dashboard » Plugins » Add New page. Search for 'EarthAsylum', click the plugin's [Install] button and, once installed, click [Activate].
See Managing Plugins -> Automatic Plugin Installation
Installation of this plugin can be managed from the WordPress Dashboard » Plugins » Add New page. Click the [Upload Plugin] button, then select the eacsoftwareregistry-subscription-webhooks.zip file from your computer.
See Managing Plugins -> Upload via WordPress Admin
You can install the plugin manually by extracting the eacsoftwareregistry-subscription-webhooks.zip file and uploading the 'eacsoftwareregistry-subscription-webhooks' folder to the 'wp-content/plugins' folder on your WordPress server.
See Managing Plugins -> Manual Plugin Installation
Options for this plugin will be found on the WooCommerce → Settings → Advanced → Webhooks page.
-
WooCommerce > Settings > Advanced > Webhooks
-
Options for Order Webhooks
Requires WooCommerce and either WooCommerce Payments (with subscriptions), WooCommerce Subscriptions or SUMO Subscriptions.
- Developed for use with {eac}SoftwareRegistry Registration Server.
- Nonetheless can be used wherever subscriptions or additional product details are needed in WooCommerce webhooks.