Subscription Note
v2.9 WooCommerce Subscriptions
Subscription Notes are the notes attached to individual subscriptions. They behave in the same way as Order Notes.
They are used to keep track of internal notes, such as subscription status changes, fulfilment notes, or customer notes such as notes about a customer’s preferences, or subscription history.
When viewing an existing subscription in WooCommerce, you can see the subscription notes in the Subscription notes section on the right of the screen.
Trigger Rules¶
A Trigger Rule defines an event (or multiple events) that will cause WooCommerce data to be sent to a Zapier Zap.
The following trigger rules are available to trigger your Zaps when subscription note data in your WooCommerce store is added or deleted.
Subscription Note created¶
Triggers when a subscription note is added to a subscription.
The Subscription Note created trigger rule will trigger for all subscription notes that are added (both customer notes and private notes).
Subscription Note deleted¶
Triggers when a subscription note is deleted.
Due to limitations in how WooCommerce handles deleted events, only the ID
of the deleted resource is sent to Zapier when using this trigger rule. No other data fields are available.
Actions and Searches¶
WooCommerce does not allow updating a subscription note.
An action is an event a Zap performs after it is triggered. Actions allow you to create new WooCommerce data from a Zap.
Searches let you find existing WooCommerce data in a Zap, and then use it later in a subsequent step.
Create Subscription Note¶
Creates a new subscription note in WooCommerce, attached to an existing Subscription.
When creating a subscription note, if the Customer Note field is set to True, then the note will be emailed to the customer. If Customer Note is set to False, then the note will be private and only visible to store administrators.
Create Input Fields¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Subscription Id | integer | The Subscription ID to add the note to. Required |
Note | string | Order note content. Required |
Customer Note | boolean | If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only. |
Added by User | boolean | If true, this note will be attributed to the current user. If false, the note will be attributed to the system. |
Find Subscription Note¶
Searches for an existing subscription note in WooCommerce. Optionally create one if none are found.
Searches return the first result found
Each search has a default sort order, so when defining your Search step, you can use the Order and Orderby fields to choose (for example) whether the most recent result or the oldest result is returned from your search.
Search Input Fields¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Subscription Note Id | string | Limit search by ID. |
Subscription Id | integer | Limit results to those matching this Subscription ID. |
Type | string | Limit result to customers or internal notes. |
Search | string | Limit results to those matching a string. |
Order | string | Order sort attribute ascending or descending. |
Orderby | string | Sort collection by object attribute. |
Subscription Note Data¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Id | integer | Unique identifier for the resource. |
Subscription Id | integer | Subscription ID |
Author | string | Order note author. |
Date Created | date-time | The date the order note was created, in the site’s timezone. |
Note | string | Order note content. |
Customer Note | boolean | If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only. |
Data Fields May Differ in Your WooCommerce Store
WooCommerce Zapier utilises WooCommerce’s REST API. Data field names, descriptions, and values can vary from one WooCommerce store to another.
Your store’s data, fields, and trigger rules may differ from this documentation due to any of the following:
- WordPress versions and the locale/language used.
- Your WooCommerce versions and the features enabled.
- Your active WordPress plugins and WooCommerce extensions.
- Any custom code that overrides or changes how the WooCommerce/WordPress REST API operates.
Note: The field definitions are generated using the following settings:
- WordPress v6.6 with the
en_US
locale. - WooCommerce v9.2 with tax and coupon functionality enabled.
- The WooCommerce Bookings, WooCommerce Memberships, and WooCommerce Subscriptions plugins were active.