User Membership
The User Membership resource is created when a customer gains access to a membership. Each user membership is linked to one user and one membership plan only. Additionally, a membership has a status and a start date. This resource is described in the WooCommerce Memberships plugin. For more details, see the WooCommerce Memberships User Memberships documentation.
In addition to User Memberships, there is the Membership Plan resource that can be accessed in the Zapier Integration.
Trigger Rules¶
The following trigger rules are available to activate your Zaps when user membership data in your WooCommerce store is added, changed, or deleted.
User Membership Created¶
Triggers when a new user membership is created.
User Membership Deleted¶
Triggers when a user membership is permanently 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.
User Membership status changed¶
User Membership statuses are an important part of the membership processing and tracking in WooCommerce.
A user membership’s status can be changed by a store owner, a member, or an automatically scheduled event1, such as renewals or expiration.
More details on the user membership statuses in WooCommerce can be found in the User Membership Statuses documentation.
The User Membership status changed (any status) trigger rule will trigger every time a user membership’s status changes to any status. It will always be triggered on status changes, regardless of what initiated the status change.
If you are interested in specific status change(s) only, you may wish to use a more specific User Membership status changed to … trigger rule.
Below is a full list of User Membership status changed trigger rules:
- User Membership status changed (any status)
- User Membership status changed to Active
- User Membership status changed to Cancelled
- User Membership status changed to Complimentary
- User Membership status changed to Delayed
- User Membership status changed to Expired
- User Membership status changed to Free Trial1
- User Membership status changed to Paused
- User Membership status changed to Pending Cancellation
User Membership Transferred¶
Triggers when a user membership is transferred from one user to another.
User Membership Updated¶
Triggers when a user membership is updated, including any status change.
Actions and Searches¶
The following actions are available for use in your Zaps to create, update, or find user memberships.
Create User Membership¶
Creates a new user membership in WooCommerce.
Create Input Fields¶
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Customer Id | integer | Unique identifier of the user the membership belongs to. Required |
| Plan Id | integer | Unique identifier of the plan the user membership grants access to. Required |
| Status | string | User membership status. |
| Order Id | integer | Unique identifier of the order that grants access. |
| Subscription Id1 | integer | Unique identifier of a subscription the user membership is tied to. |
| Installment Plan | boolean | Flag whether the user membership is using a subscription for installments. |
| Product Id | integer | Unique identifier of the purchased product, or its variation, that grants access. |
| Profile Fields | array | User membership profile fields. Only the child fields are visible in the Zapier UI. |
| Profile Fields → Slug | string | Profile field slug. |
| Profile Fields → Value | any | Profile field value. |
| Meta Data | array | User membership additional meta data. Only the child fields are visible in the Zapier UI. |
| Meta Data → Key | string | Meta key. |
| Meta Data → Value | any | Meta value. |
Update User Membership¶
Updates an existing user membership in WooCommerce.
An update action always requires a valid top-level ID to be specified. This ensures that your Zap knows which record to update. On the other hand, any non-top-level ID is optional. If you leave it empty, WooCommerce will create a new entry, such as a new Meta Data item.
To help identify the correct Resource ID, you can add a Find step before your update step. The result of your Find step will contain the Resource ID, which you can then use in the Update step.
Update Input Fields¶
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Existing ID | integer | Unique identifier of a user membership. Required |
| Customer Id | integer | Unique identifier of the user the membership belongs to. |
| Plan Id | integer | Unique identifier of the plan the user membership grants access to. |
| Status | string | User membership status. |
| Order Id | integer | Unique identifier of the order that grants access. |
| Subscription Id1 | integer | Unique identifier of a subscription the user membership is tied to. |
| Installment Plan | boolean | Flag whether the user membership is using a subscription for installments. |
| Product Id | integer | Unique identifier of the purchased product, or its variation, that grants access. |
| Profile Fields | array | User membership profile fields. Only the child fields are visible in the Zapier UI. |
| Profile Fields → Slug | string | Profile field slug. |
| Profile Fields → Value | any | Profile field value. |
| Meta Data | array | User membership additional meta data. Only the child fields are visible in the Zapier UI. |
| Meta Data → Existing ID | integer | Meta ID. Leave empty to create a new meta data record. Otherwise, enter an existing ID. |
| Meta Data → Key | string | Meta key. |
| Meta Data → Value | any | Meta value. |
Find User Membership¶
Searches for an existing user membership 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 |
|---|---|---|
| User Membership Id | string | Limit search by ID. |
| Search | string | Limit results to those matching a string. |
| Status | string | Limit results to user memberships of a specific status. |
| Plan | string | Limit results to user memberships for a specific plan (matched by ID or slug). |
| Customer | string | Limit results to user memberships belonging to a specific customer (matched by ID, login name or email address). |
| Order Id | integer | Limit results to user memberships related to a specific order (matched by ID). |
| Product Id | integer | Limit results to user memberships granted after the purchase of a specific product (matched by ID). |
| Subscription Id1 | integer | Limit results to user memberships linked to a specific subscription (matched by ID). |
| Order | string | Order sort attribute ascending or descending. |
| Orderby | string | Sort collection by object attribute. |
User Membership Data¶
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Id | integer | Unique identifier of the user membership. |
| Customer Id | integer | Unique identifier of the user the membership belongs to. |
| Plan Id | integer | Unique identifier of the plan the user membership grants access to. |
| Status | string | User membership status. |
| Order Id | integer | Unique identifier of the order that grants access. |
| Product Id | integer | Unique identifier of the purchased product, or its variation, that grants access. |
| Date Created | date-time | The date when the user membership is created, in the site timezone. |
| Start Date | date-time | The date when the user membership starts being active, in the site timezone. |
| End Date | date-time | The date when the user membership ends, in the site timezone. |
| Paused Date | date-time | The date when the user membership was last paused, in the site timezone. |
| Cancelled Date | date-time | The date when the user membership was cancelled, in the site timezone. |
| View Url | string | The URL pointing to the Members Area to view the membership. |
| Profile Fields | array | User membership profile fields. |
| Profile Fields → Slug | string | Profile field slug. |
| Profile Fields → Value | any | Profile field value. |
| Meta Data | array | User membership additional meta data. |
| Meta Data → Id | integer | Meta ID. |
| Meta Data → Key | string | Meta key. |
| Meta Data → Value | any | Meta value. |
| Subscription Id1 | integer | Unique identifier of a subscription the user membership is tied to. |
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_USlocale. - WooCommerce v9.2 with tax and coupon functionality enabled.
- The WooCommerce Bookings, WooCommerce Memberships, and WooCommerce Subscriptions plugins were active.