Membership Plan
The Membership Plan resource is a collection of settings and conditions according to which customers can gain access to restricted content, products, and member-only discounts, among other benefits. This resource is described in the WooCommerce Memberships plugin. For more details, see the WooCommerce Memberships Plans documentation.
In addition to Membership Plans, there is the User Membership resource that can be accessed in the Zapier Integration.
Trigger Rules¶
The following trigger rules are available to activate your Zaps when membership plan data in your WooCommerce store is added, changed, or deleted.
Membership Plan Created¶
Triggers when a new membership plan is created.
Membership Plan Deleted¶
Triggers when a membership plan is deleted (trashed).
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.
Membership Plan Restored¶
Triggers when a previously trashed membership plan is restored from the trash.
Membership Plan Updated¶
Triggers when a membership plan is updated/edited/changed/modified, including when a plan is created, changes status, or is restored from the trash.
Actions and Searches¶
Only the search action can be used in your Zaps with the membership plans resource.
Find Membership Plan¶
Searches for an existing Membership Plan in WooCommerce. Does not support creation.
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 |
---|---|---|
Membership Plan Id | string | Limit search by ID. |
Name | string | Limit results to those with the specified plan name. |
Order | string | Order sort attribute ascending or descending. |
Orderby | string | Sort collection by object attribute. |
Membership Plan Data¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Id | integer | Unique identifier of the membership plan. |
Name | string | Membership plan name. |
Slug | string | Membership plan slug. |
Status | string | Membership plan status. |
Access Method | string | Membership plan access method. |
Has Subscription1 | boolean | Marks a membership plan that has at least one subscription product that can give access upon purchase. |
Has Subscription Installment1 | boolean | Marks a membership plan whose duration is not bound to a tied subscription, but where the subscription handles installment billing. |
Access Product Ids | array | List of products that can grant access to the membership plan. |
Access Length Type | string | Duration type of the membership. |
Subscription Access Length1 | integer | Membership plan access duration in seconds, when tied to a subscription. |
Subscription Access Length Type1 | string | Duration type of the membership plan when access is tied to a subscription. |
Access Length | integer | Membership plan access duration in seconds. |
Access Start Date | date-time | The date when access will start, in the site timezone. |
Access End Date | date-time | The set date when access will end for fixed-length membership plans, in the site timezone. |
Subscription Access Start Date1 | date-time | The date when access will start, when tied to a subscription, in the site timezone. |
Subscription Access End Date1 | date-time | The set date when access will end for fixed-length membership plans tied to a subscription, in the site timezone. |
Date Created | date-time | The date when the membership plan was created, in the site timezone. |
Date Modified | date-time | The date when the membership plan was last updated, in the site timezone. |
Meta Data | array | Membership plan additional meta data. |
Meta Data → Id | integer | Meta ID. |
Meta Data → Key | string | Meta key. |
Meta Data → Value | any | Meta value. |
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.