Developer Tools Event Triggers

Overview

Member

• Member Added
• Member Signup Completed
• Member Account Info Updated
• Member Deleted
• Member Logged In

Subscription

• Subscription Created
• Subscription Paused
• Subscription Resumed
• Subscription Stopped
• Subscription Upgraded
• Subscription Downgraded
• Subscription Upgraded to Non-Recurring
• Subscription Upgraded to Recurring
• Subscription Downgraded to Non-Recurring
• Subscription Downgraded to Recurring
• Subscription Expired

Transactions

• Transaction Completed
• Transaction Refunded
• Transaction Failed
• Transaction Expired
• Recurring Transaction Completed
• Renewal Transaction Completed
• Recurring Transaction Failed
• Recurring Transaction Expired
• Non-Recurring Transaction Completed
• Non-Recurring Transaction Expired

Reminders

• After Member Registers
• After Signup Abandoned
• Before Subscription Expires
• After Subscription Expires
• Before Subscription Renews
• After Credit Card Expires
• Before Credit Card Expires

Courses

• Course Started
• Course Completed
• Lesson Started
• Lesson Completed
• Quiz Attempted

Member Added

Description

Sent when a new member registers but before their payment details are accepted.

Sample Response

{
  "event": "member-added",
  "type": "member",
  "data": {
    "id": 56,
    "email": "zapier@test.com",
    "username": "zapiertest",
    "nicename": "zapiertest",
    "url": "",
    "message": "",
    "registered_at": "2019-04-18 16:47:14",
    "first_name": "zapier",
    "last_name": "test",
    "display_name": "zapiertest",
    "active_memberships": [
      {
        "id": 15,
        "title": "Gold Membership",
        "content": "",
        "excerpt": "",
        "date": "2018-08-30 16:10:22",
        "status": "publish",
        "author": "2",
        "date_gmt": "2018-08-30 16:10:22",
        "modified": "2019-04-23 08:57:21",
        "modified_gmt": "2019-04-23 14:57:21",
        "group": "17",
        "price": "100.00",
        "period": "1",
        "period_type": "months",
        "signup_button_text": "Sign Up",
        "limit_cycles": false,
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "trial": false,
        "trial_days": "0",
        "trial_amount": "0.00",
        "trial_once": "1",
        "group_order": "2",
        "is_highlighted": false,
        "plan_code": "",
        "pricing_title": "Gold Membership",
        "pricing_show_price": true,
        "pricing_display": "custom",
        "custom_price": "$100 recurring yearly",
        "pricing_heading_txt": "",
        "pricing_footer_txt": "",
        "pricing_button_txt": "Sign Up",
        "pricing_button_position": "footer",
        "pricing_benefits": [
          ""
        ],
        "register_price_action": "custom",
        "register_price": "$100 recurring yearly",
        "thank_you_page_enabled": false,
        "thank_you_page_type": "message",
        "thank_you_message": "",
        "thank_you_page_id": "0",
        "custom_login_urls_enabled": false,
        "custom_login_urls_default": "",
        "custom_login_urls": [],
        "expire_type": "none",
        "expire_after": "1",
        "expire_unit": "days",
        "expire_fixed": "2019-04-23",
        "tax_exempt": false,
        "allow_renewal": false,
        "access_url": "",
        "disable_address_fields": false,
        "simultaneous_subscriptions": "1",
        "use_custom_template": false,
        "custom_template": "template-sitemap.php",
        "customize_payment_methods": "1",
        "custom_payment_methods": [
          "peum51-1tc"
        ],
        "customize_profile_fields": false,
        "custom_profile_fields": [],
        "cannot_purchase_message": "You don't have access to purchase this item."
      }
    ],
    "active_txn_count": "1",
    "expired_txn_count": "1",
    "trial_txn_count": null,
    "sub_count": null,
    "login_count": "1",
    "first_txn": {
      "membership": "15",
      "member": "56",
      "coupon": "0",
      "subscription": "69",
      "id": "198",
      "amount": "0.00",
      "total": "0.00",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "cus_EuSIHGllVD3168",
      "status": "confirmed",
      "txn_type": "subscription_confirmation",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-04-18 16:47:14",
      "expires_at": "2019-04-18 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "latest_txn": {
      "membership": "15",
      "member": "56",
      "coupon": "0",
      "subscription": "69",
      "id": "199",
      "amount": "100.00",
      "total": "100.00",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "ch_1EQdOLJT1LHvX6ILZhIzeboJ",
      "status": "complete",
      "txn_type": "payment",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-04-18 16:47:21",
      "expires_at": "2019-05-18 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "address": {
      "mepr-address-one": "123 fake st",
      "mepr-address-two": "",
      "mepr-address-city": "city",
      "mepr-address-state": "UT",
      "mepr-address-zip": "81111",
      "mepr-address-country": "US"
    },
    "profile": {
      "mepr_company_name": "MemberPress",
      "mepr_birthday": "2019-04-18",
      "mepr_testslug": ""
    },
    "recent_transactions": [
      {
        "membership": "15",
        "member": "56",
        "coupon": "0",
        "subscription": "69",
        "id": "199",
        "amount": "100.00",
        "total": "100.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "ch_1EQdOLJT1LHvX6ILZhIzeboJ",
        "status": "complete",
        "txn_type": "payment",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-04-18 16:47:21",
        "expires_at": "2019-05-18 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      },
      {
        "membership": "15",
        "member": "56",
        "coupon": "0",
        "subscription": "69",
        "id": "198",
        "amount": "0.00",
        "total": "0.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "cus_EuSIHGllVD3168",
        "status": "confirmed",
        "txn_type": "subscription_confirmation",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-04-18 16:47:14",
        "expires_at": "2019-04-18 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ],
    "recent_subscriptions": [
      {
        "coupon": "0",
        "membership": "15",
        "member": "56",
        "id": "69",
        "subscr_id": "cus_EuSIHGllVD3168",
        "gateway": "peum51-1tc",
        "price": "100.00",
        "period": "1",
        "period_type": "months",
        "limit_cycles": "0",
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "prorated_trial": "0",
        "trial": "0",
        "trial_days": "0",
        "trial_amount": "0.00",
        "status": "active",
        "created_at": "2019-04-18 16:47:19",
        "total": "100.00",
        "tax_rate": "0.000",
        "tax_amount": "0.00",
        "tax_desc": "",
        "tax_class": "standard",
        "cc_last4": "1111",
        "cc_exp_month": "10",
        "cc_exp_year": "2020",
        "token": "",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ]
  }
}

Member Signup Completed

Description

Sent when a new member completes the signup and their payment is accepted.

Sample Response

{
  "event": "member-signup-completed",
  "type": "member",
  "data": {
    "id": 46,
    "email": "zapier@test.com",
    "username": "zapier@test.com",
    "nicename": "zapiertest-com",
    "url": "",
    "message": "",
    "registered_at": "2019-03-19 16:48:20",
    "first_name": "Zapier",
    "last_name": "test",
    "display_name": "zapier@test.com",
    "active_memberships": [
      {
        "id": 15,
        "title": "Gold Membership",
        "content": "",
        "excerpt": "",
        "date": "2018-08-30 16:10:22",
        "status": "publish",
        "author": "2",
        "date_gmt": "2018-08-30 16:10:22",
        "modified": "2019-03-14 13:10:21",
        "modified_gmt": "2019-03-14 19:10:21",
        "group": "17",
        "price": "100.00",
        "period": "1",
        "period_type": "months",
        "signup_button_text": "Sign Up",
        "limit_cycles": false,
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "trial": false,
        "trial_days": "0",
        "trial_amount": "0.00",
        "trial_once": "1",
        "group_order": "2",
        "is_highlighted": false,
        "plan_code": "",
        "pricing_title": "Gold Membership",
        "pricing_show_price": true,
        "pricing_display": "custom",
        "custom_price": "Pricing",
        "pricing_heading_txt": "",
        "pricing_footer_txt": "",
        "pricing_button_txt": "Sign Up",
        "pricing_button_position": "footer",
        "pricing_benefits": [
          ""
        ],
        "register_price_action": "default",
        "register_price": "This is a test",
        "thank_you_page_enabled": false,
        "thank_you_page_type": "message",
        "thank_you_message": "",
        "thank_you_page_id": "0",
        "custom_login_urls_enabled": false,
        "custom_login_urls_default": "",
        "custom_login_urls": [],
        "expire_type": "none",
        "expire_after": "1",
        "expire_unit": "days",
        "expire_fixed": "2019-03-14",
        "tax_exempt": false,
        "allow_renewal": false,
        "access_url": "",
        "disable_address_fields": false,
        "simultaneous_subscriptions": "1",
        "use_custom_template": false,
        "custom_template": "template-sitemap.php",
        "customize_payment_methods": "1",
        "custom_payment_methods": [
          "peum51-1tc"
        ],
        "customize_profile_fields": false,
        "custom_profile_fields": [],
        "cannot_purchase_message": "You don't have access to purchase this item."
      },
      {
        "id": 15,
        "title": "Gold Membership",
        "content": "",
        "excerpt": "",
        "date": "2018-08-30 16:10:22",
        "status": "publish",
        "author": "2",
        "date_gmt": "2018-08-30 16:10:22",
        "modified": "2019-03-14 13:10:21",
        "modified_gmt": "2019-03-14 19:10:21",
        "group": "17",
        "price": "100.00",
        "period": "1",
        "period_type": "months",
        "signup_button_text": "Sign Up",
        "limit_cycles": false,
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "trial": false,
        "trial_days": "0",
        "trial_amount": "0.00",
        "trial_once": "1",
        "group_order": "2",
        "is_highlighted": false,
        "plan_code": "",
        "pricing_title": "Gold Membership",
        "pricing_show_price": true,
        "pricing_display": "custom",
        "custom_price": "Pricing",
        "pricing_heading_txt": "",
        "pricing_footer_txt": "",
        "pricing_button_txt": "Sign Up",
        "pricing_button_position": "footer",
        "pricing_benefits": [
          ""
        ],
        "register_price_action": "default",
        "register_price": "This is a test",
        "thank_you_page_enabled": false,
        "thank_you_page_type": "message",
        "thank_you_message": "",
        "thank_you_page_id": "0",
        "custom_login_urls_enabled": false,
        "custom_login_urls_default": "",
        "custom_login_urls": [],
        "expire_type": "none",
        "expire_after": "1",
        "expire_unit": "days",
        "expire_fixed": "2019-03-14",
        "tax_exempt": false,
        "allow_renewal": false,
        "access_url": "",
        "disable_address_fields": false,
        "simultaneous_subscriptions": "1",
        "use_custom_template": false,
        "custom_template": "template-sitemap.php",
        "customize_payment_methods": "1",
        "custom_payment_methods": [
          "peum51-1tc"
        ],
        "customize_profile_fields": false,
        "custom_profile_fields": [],
        "cannot_purchase_message": "You don't have access to purchase this item."
      }
    ],
    "active_txn_count": "2",
    "expired_txn_count": "0",
    "trial_txn_count": null,
    "sub_count": null,
    "login_count": "1",
    "first_txn": {
      "membership": "15",
      "member": "46",
      "coupon": "0",
      "subscription": "59",
      "id": "166",
      "amount": "0.00",
      "total": "0.00",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "cus_EjDYhKuKyRY5N2",
      "status": "confirmed",
      "txn_type": "subscription_confirmation",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-03-19 16:48:21",
      "expires_at": "2019-03-19 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "latest_txn": {
      "membership": "15",
      "member": "46",
      "coupon": "0",
      "subscription": "59",
      "id": "167",
      "amount": "100.00",
      "total": "100.00",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "ch_1EFl6yJT1LHvX6IL95fhb7M4",
      "status": "complete",
      "txn_type": "payment",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-03-19 16:48:28",
      "expires_at": "2019-04-19 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "address": {
      "mepr-address-one": "123 fake st",
      "mepr-address-two": "",
      "mepr-address-city": "city",
      "mepr-address-state": "UT",
      "mepr-address-zip": "81111",
      "mepr-address-country": "US"
    },
    "profile": {
      "mepr_company_name": "Zapier test",
      "mepr_birthday": "2019-03-19",
      "mepr_testslug": ""
    },
    "recent_transactions": [
      {
        "membership": "15",
        "member": "46",
        "coupon": "0",
        "subscription": "59",
        "id": "167",
        "amount": "100.00",
        "total": "100.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "ch_1EFl6yJT1LHvX6IL95fhb7M4",
        "status": "complete",
        "txn_type": "payment",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-03-19 16:48:28",
        "expires_at": "2019-04-19 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      },
      {
        "membership": "15",
        "member": "46",
        "coupon": "0",
        "subscription": "59",
        "id": "166",
        "amount": "0.00",
        "total": "0.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "cus_EjDYhKuKyRY5N2",
        "status": "confirmed",
        "txn_type": "subscription_confirmation",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-03-19 16:48:21",
        "expires_at": "2019-03-19 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ],
    "recent_subscriptions": [
      {
        "coupon": "0",
        "membership": "15",
        "member": "46",
        "id": "59",
        "subscr_id": "cus_EjDYhKuKyRY5N2",
        "gateway": "peum51-1tc",
        "price": "100.00",
        "period": "1",
        "period_type": "months",
        "limit_cycles": "0",
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "prorated_trial": "0",
        "trial": "0",
        "trial_days": "0",
        "trial_amount": "0.00",
        "status": "active",
        "created_at": "2019-03-19 16:48:25",
        "total": "100.00",
        "tax_rate": "0.000",
        "tax_amount": "0.00",
        "tax_desc": "",
        "tax_class": "standard",
        "cc_last4": "1111",
        "cc_exp_month": "10",
        "cc_exp_year": "2030",
        "token": "",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ]
  }
}

Member Account Info Updated

Description

Sent when a member updates his/her account information.

Sample Response

{
  "event": "member-account-updated",
  "type": "member",
  "data": {
    "id": 49,
    "email": "coupon@testing2.com",
    "username": "coupon@testing2.com",
    "nicename": "coupontesting2-com",
    "url": "",
    "message": "",
    "registered_at": "2019-04-03 17:33:06",
    "first_name": "coupon",
    "last_name": "testing2",
    "display_name": "coupon testing2",
    "active_memberships": [
      {
        "id": 267,
        "title": "coupon testing",
        "content": "",
        "excerpt": "",
        "date": "2019-04-03 11:18:41",
        "status": "publish",
        "author": "5",
        "date_gmt": "2019-04-03 17:18:41",
        "modified": "2019-04-04 10:58:44",
        "modified_gmt": "2019-04-04 16:58:44",
        "group": "0",
        "price": "9.99",
        "period": "1",
        "period_type": "months",
        "signup_button_text": "Sign Up",
        "limit_cycles": false,
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "trial": "1",
        "trial_days": "90",
        "trial_amount": "29.94",
        "trial_once": "1",
        "group_order": "0",
        "is_highlighted": false,
        "plan_code": "",
        "pricing_title": "coupon testing",
        "pricing_show_price": true,
        "pricing_display": "auto",
        "custom_price": "",
        "pricing_heading_txt": "",
        "pricing_footer_txt": "",
        "pricing_button_txt": "Sign Up",
        "pricing_button_position": "footer",
        "pricing_benefits": [
          ""
        ],
        "register_price_action": "default",
        "register_price": "",
        "thank_you_page_enabled": false,
        "thank_you_page_type": "message",
        "thank_you_message": "",
        "thank_you_page_id": "0",
        "custom_login_urls_enabled": false,
        "custom_login_urls_default": "",
        "custom_login_urls": [],
        "expire_type": "none",
        "expire_after": "1",
        "expire_unit": "days",
        "expire_fixed": "2019-04-04",
        "tax_exempt": false,
        "allow_renewal": false,
        "access_url": "",
        "disable_address_fields": false,
        "simultaneous_subscriptions": false,
        "use_custom_template": false,
        "custom_template": "template-sitemap.php",
        "customize_payment_methods": false,
        "custom_payment_methods": [],
        "customize_profile_fields": false,
        "custom_profile_fields": [],
        "cannot_purchase_message": "You don't have access to purchase this item."
      }
    ],
    "active_txn_count": "1",
    "expired_txn_count": "0",
    "trial_txn_count": null,
    "sub_count": null,
    "login_count": "1",
    "first_txn": {
      "membership": "267",
      "member": "49",
      "coupon": "0",
      "subscription": "62",
      "id": "178",
      "amount": "29.94",
      "total": "29.94",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "ch_1ELCxmJT1LHvX6ILZSGECdgo",
      "status": "complete",
      "txn_type": "payment",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-04-03 17:33:07",
      "expires_at": "2019-07-02 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "latest_txn": {
      "membership": "267",
      "member": "49",
      "coupon": "0",
      "subscription": "62",
      "id": "178",
      "amount": "29.94",
      "total": "29.94",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "ch_1ELCxmJT1LHvX6ILZSGECdgo",
      "status": "complete",
      "txn_type": "payment",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-04-03 17:33:07",
      "expires_at": "2019-07-02 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "address": {
      "mepr-address-one": "123 fake st",
      "mepr-address-two": "",
      "mepr-address-city": "city",
      "mepr-address-state": "UT",
      "mepr-address-zip": "81111",
      "mepr-address-country": "US"
    },
    "profile": {
      "mepr_company_name": "blah",
      "mepr_birthday": "2019-04-03",
      "mepr_testslug": ""
    },
    "recent_transactions": [
      {
        "membership": "267",
        "member": "49",
        "coupon": "0",
        "subscription": "62",
        "id": "178",
        "amount": "29.94",
        "total": "29.94",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "ch_1ELCxmJT1LHvX6ILZSGECdgo",
        "status": "complete",
        "txn_type": "payment",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-04-03 17:33:07",
        "expires_at": "2019-07-02 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ],
    "recent_subscriptions": [
      {
        "coupon": "0",
        "membership": "267",
        "member": "49",
        "id": "62",
        "subscr_id": "cus_EoqfMhbLzIxdXZ",
        "gateway": "peum51-1tc",
        "price": "9.99",
        "period": "1",
        "period_type": "months",
        "limit_cycles": "0",
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "prorated_trial": "0",
        "trial": "1",
        "trial_days": "90",
        "trial_amount": "29.94",
        "status": "active",
        "created_at": "2019-04-03 17:33:31",
        "total": "9.99",
        "tax_rate": "0.000",
        "tax_amount": "0.00",
        "tax_desc": "",
        "tax_class": "standard",
        "cc_last4": "1111",
        "cc_exp_month": "10",
        "cc_exp_year": "2020",
        "token": "",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ]
  }
}

Member Deleted

Description

Sent when a member is deleted from the system.

Sample Response

{
  "event": "member-deleted",
  "type": "member",
  "data": {
    "id": null,
    "email": null,
    "username": null,
    "nicename": null,
    "url": null,
    "message": null,
    "registered_at": null,
    "first_name": null,
    "last_name": null,
    "display_name": null,
    "active_memberships": [],
    "active_txn_count": "0",
    "expired_txn_count": "2",
    "trial_txn_count": null,
    "sub_count": null,
    "login_count": "0",
    "first_txn": {
      "membership": "187",
      "member": "0",
      "coupon": "0",
      "subscription": "0",
      "id": "80",
      "amount": "25.00",
      "total": "25.00",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "ch_1DofUJJT1LHvX6ILMJpFFPBR",
      "status": "complete",
      "txn_type": "payment",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-01-03 23:20:15",
      "expires_at": "2019-01-01 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "latest_txn": {
      "membership": "187",
      "member": "0",
      "coupon": "0",
      "subscription": "0",
      "id": "81",
      "amount": "25.00",
      "total": "25.00",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "ch_1DofiBJT1LHvX6ILVSQdUD4q",
      "status": "complete",
      "txn_type": "payment",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-01-03 23:34:36",
      "expires_at": "2019-01-31 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "address": {
      "mepr-address-one": "",
      "mepr-address-two": "",
      "mepr-address-city": "",
      "mepr-address-state": "",
      "mepr-address-zip": "",
      "mepr-address-country": ""
    },
    "profile": {
      "mepr_company_name": false,
      "mepr_birthday": false,
      "mepr_testslug": false
    },
    "recent_transactions": [
      {
        "membership": "187",
        "member": "0",
        "coupon": "0",
        "subscription": "0",
        "id": "81",
        "amount": "25.00",
        "total": "25.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "ch_1DofiBJT1LHvX6ILVSQdUD4q",
        "status": "complete",
        "txn_type": "payment",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-01-03 23:34:36",
        "expires_at": "2019-01-31 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      },
      {
        "membership": "187",
        "member": "0",
        "coupon": "0",
        "subscription": "0",
        "id": "80",
        "amount": "25.00",
        "total": "25.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "ch_1DofUJJT1LHvX6ILMJpFFPBR",
        "status": "complete",
        "txn_type": "payment",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-01-03 23:20:15",
        "expires_at": "2019-01-01 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      },
      {
        "membership": "29",
        "member": "0",
        "coupon": "0",
        "subscription": "14",
        "id": "36",
        "amount": "100.00",
        "total": "100.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "mp-txn-5be36b50d3ba3",
        "status": "pending",
        "txn_type": "payment",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2018-11-07 22:46:40",
        "expires_at": "2019-11-07 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ],
    "recent_subscriptions": [
      {
        "coupon": "0",
        "membership": "29",
        "member": "0",
        "id": "14",
        "subscr_id": "mp-sub-5be36b50ddb45",
        "gateway": "peum51-1tc",
        "price": "100.00",
        "period": "1",
        "period_type": "years",
        "limit_cycles": "0",
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "prorated_trial": "0",
        "trial": "0",
        "trial_days": "0",
        "trial_amount": "0.00",
        "status": "pending",
        "created_at": "2018-11-07 22:46:40",
        "total": "100.00",
        "tax_rate": "0.000",
        "tax_amount": "0.00",
        "tax_desc": "",
        "tax_class": "standard",
        "cc_last4": "",
        "cc_exp_month": "",
        "cc_exp_year": "",
        "token": "",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ]
  }
}

Member Logged In

Description

Sent when any member logs in.

Sample Response

{
  "event": "login",
  "type": "member",
  "data": {
    "id": 56,
    "email": "zapier@test.com",
    "username": "zapiertest",
    "nicename": "zapiertest",
    "url": "",
    "message": "",
    "registered_at": "2019-04-18 16:47:14",
    "first_name": "zapier",
    "last_name": "test",
    "display_name": "zapiertest",
    "active_memberships": [
      {
        "id": 15,
        "title": "Gold Membership",
        "content": "",
        "excerpt": "",
        "date": "2018-08-30 16:10:22",
        "status": "publish",
        "author": "2",
        "date_gmt": "2018-08-30 16:10:22",
        "modified": "2019-04-23 08:57:21",
        "modified_gmt": "2019-04-23 14:57:21",
        "group": "17",
        "price": "100.00",
        "period": "1",
        "period_type": "months",
        "signup_button_text": "Sign Up",
        "limit_cycles": false,
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "trial": false,
        "trial_days": "0",
        "trial_amount": "0.00",
        "trial_once": "1",
        "group_order": "2",
        "is_highlighted": false,
        "plan_code": "",
        "pricing_title": "Gold Membership",
        "pricing_show_price": true,
        "pricing_display": "custom",
        "custom_price": "$100 recurring yearly",
        "pricing_heading_txt": "",
        "pricing_footer_txt": "",
        "pricing_button_txt": "Sign Up",
        "pricing_button_position": "footer",
        "pricing_benefits": [
          ""
        ],
        "register_price_action": "custom",
        "register_price": "$100 recurring yearly",
        "thank_you_page_enabled": false,
        "thank_you_page_type": "message",
        "thank_you_message": "",
        "thank_you_page_id": "0",
        "custom_login_urls_enabled": false,
        "custom_login_urls_default": "",
        "custom_login_urls": [],
        "expire_type": "none",
        "expire_after": "1",
        "expire_unit": "days",
        "expire_fixed": "2019-04-23",
        "tax_exempt": false,
        "allow_renewal": false,
        "access_url": "",
        "disable_address_fields": false,
        "simultaneous_subscriptions": "1",
        "use_custom_template": false,
        "custom_template": "template-sitemap.php",
        "customize_payment_methods": "1",
        "custom_payment_methods": [
          "peum51-1tc"
        ],
        "customize_profile_fields": false,
        "custom_profile_fields": [],
        "cannot_purchase_message": "You don't have access to purchase this item."
      }
    ],
    "active_txn_count": "1",
    "expired_txn_count": "1",
    "trial_txn_count": null,
    "sub_count": null,
    "login_count": "1",
    "first_txn": {
      "membership": "15",
      "member": "56",
      "coupon": "0",
      "subscription": "69",
      "id": "198",
      "amount": "0.00",
      "total": "0.00",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "cus_EuSIHGllVD3168",
      "status": "confirmed",
      "txn_type": "subscription_confirmation",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-04-18 16:47:14",
      "expires_at": "2019-04-18 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "latest_txn": {
      "membership": "15",
      "member": "56",
      "coupon": "0",
      "subscription": "69",
      "id": "199",
      "amount": "100.00",
      "total": "100.00",
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "tax_desc": "",
      "tax_class": "standard",
      "trans_num": "ch_1EQdOLJT1LHvX6ILZhIzeboJ",
      "status": "complete",
      "txn_type": "payment",
      "gateway": "peum51-1tc",
      "prorated": "0",
      "created_at": "2019-04-18 16:47:21",
      "expires_at": "2019-05-18 23:59:59",
      "corporate_account_id": "0",
      "parent_transaction_id": "0",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "address": {
      "mepr-address-one": "123 fake st",
      "mepr-address-two": "",
      "mepr-address-city": "city",
      "mepr-address-state": "UT",
      "mepr-address-zip": "81111",
      "mepr-address-country": "US"
    },
    "profile": {
      "mepr_company_name": "MemberPress",
      "mepr_birthday": "2019-04-18",
      "mepr_testslug": ""
    },
    "recent_transactions": [
      {
        "membership": "15",
        "member": "56",
        "coupon": "0",
        "subscription": "69",
        "id": "199",
        "amount": "100.00",
        "total": "100.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "ch_1EQdOLJT1LHvX6ILZhIzeboJ",
        "status": "complete",
        "txn_type": "payment",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-04-18 16:47:21",
        "expires_at": "2019-05-18 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      },
      {
        "membership": "15",
        "member": "56",
        "coupon": "0",
        "subscription": "69",
        "id": "198",
        "amount": "0.00",
        "total": "0.00",
        "tax_amount": "0.00",
        "tax_rate": "0.000",
        "tax_desc": "",
        "tax_class": "standard",
        "trans_num": "cus_EuSIHGllVD3168",
        "status": "confirmed",
        "txn_type": "subscription_confirmation",
        "gateway": "peum51-1tc",
        "prorated": "0",
        "created_at": "2019-04-18 16:47:14",
        "expires_at": "2019-04-18 23:59:59",
        "corporate_account_id": "0",
        "parent_transaction_id": "0",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ],
    "recent_subscriptions": [
      {
        "coupon": "0",
        "membership": "15",
        "member": "56",
        "id": "69",
        "subscr_id": "cus_EuSIHGllVD3168",
        "gateway": "peum51-1tc",
        "price": "100.00",
        "period": "1",
        "period_type": "months",
        "limit_cycles": "0",
        "limit_cycles_num": "2",
        "limit_cycles_action": "expire",
        "prorated_trial": "0",
        "trial": "0",
        "trial_days": "0",
        "trial_amount": "0.00",
        "status": "active",
        "created_at": "2019-04-18 16:47:19",
        "total": "100.00",
        "tax_rate": "0.000",
        "tax_amount": "0.00",
        "tax_desc": "",
        "tax_class": "standard",
        "cc_last4": "1111",
        "cc_exp_month": "10",
        "cc_exp_year": "2020",
        "token": "",
        "tax_compound": "0",
        "tax_shipping": "1",
        "response": null
      }
    ]
  }
}

Subscription Created

Description

Sent when a subscription is created.

Sample Response

{
  "event": "subscription-created",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 56,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "",
      "message": "",
      "registered_at": "2019-04-18 16:47:14",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapiertest"
    },
    "id": "69",
    "subscr_id": "cus_EuSIHGllVD3168",
    "gateway": {
      "name": "Stripe",
      "label": "My Stripe gateway",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/cards.png",
      "use_icon": true,
      "desc": "Pay with your credit card via Stripe",
      "use_desc": true,
      "id": "peum51-1tc",
      "has_spc_form": true,
      "settings": {
        "gateway": "MeprStripeGateway",
        "id": "peum51-1tc",
        "label": "My Stripe gateway",
        "use_label": true,
        "use_icon": true,
        "use_desc": true,
        "email": "",
        "sandbox": false,
        "force_ssl": false,
        "debug": false,
        "test_mode": "on",
        "use_stripe_checkout": false,
        "churn_buster_enabled": false,
        "churn_buster_uuid": "",
        "api_keys": {
          "test": {
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
          },
          "live": {
            "public": "",
            "secret": ""
          }
        },
        "saved": "1",
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
      },
      "capabilities": [
        "process-credit-cards",
        "process-payments",
        "process-refunds",
        "create-subscriptions",
        "cancel-subscriptions",
        "update-subscriptions",
        "suspend-subscriptions",
        "resume-subscriptions",
        "send-cc-expirations"
      ]
    },
    "price": "100.00",
    "period": "1",
    "period_type": "months",
    "limit_cycles": "0",
    "limit_cycles_num": "2",
    "limit_cycles_action": "expire",
    "prorated_trial": "0",
    "trial": "0",
    "trial_days": "0",
    "trial_amount": "0.00",
    "status": "active",
    "created_at": "2019-04-18 16:47:19",
    "total": "100.00",
    "tax_rate": "0.000",
    "tax_amount": "0.00",
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": "1111",
    "cc_exp_month": "10",
    "cc_exp_year": "2020",
    "token": "",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Subscription Paused

Description

Sent when a subscription is paused.

Sample Response

{
  "event": "subscription-paused",
  "type": "subscription",
  "data": {
    "coupon": {
      "id": 197,
      "coupon_code": "M5TGWIKIYU",
      "date": "2019-01-10 15:38:04",
      "status": "publish",
      "author": "5",
      "date_gmt": "2019-01-10 22:38:04",
      "modified": "2019-02-05 10:18:06",
      "modified_gmt": "2019-02-05 17:18:06",
      "valid_memberships": [
        "196"
      ],
      "should_expire": false,
      "expires_on": "0",
      "usage_count": "3",
      "usage_amount": "0",
      "discount_type": "percent",
      "discount_amount": "20",
      "discount_mode": "trial-override",
      "trial_days": "2",
      "trial_amount": "0.00"
    },
    "membership": {
      "id": 196,
      "title": "coupon test",
      "content": "[mepr-membership-registration-form]",
      "excerpt": "",
      "date": "2019-01-10 15:36:20",
      "status": "publish",
      "author": "5",
      "date_gmt": "2019-01-10 22:36:20",
      "modified": "2019-02-19 12:15:59",
      "modified_gmt": "2019-02-19 19:15:59",
      "group": "0",
      "price": "100.00",
      "period": "1",
      "period_type": "years",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": "1",
      "trial_days": "14",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "0",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "coupon test",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-02-19",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": false,
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 36,
      "email": "coupon@trial.com",
      "username": "coupontrial",
      "nicename": "coupontrial",
      "url": "",
      "message": "",
      "registered_at": "2019-01-10 22:39:32",
      "first_name": "",
      "last_name": "",
      "display_name": "coupontrial"
    },
    "id": "32",
    "subscr_id": "cus_EJprCdOvRzjvZq",
    "gateway": {
      "name": "Stripe",
      "label": "My Stripe gateway",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/cards.png",
      "use_icon": true,
      "desc": "Pay with your credit card via Stripe",
      "use_desc": true,
      "id": "peum51-1tc",
      "has_spc_form": true,
      "settings": {
        "gateway": "MeprStripeGateway",
        "id": "peum51-1tc",
        "label": "My Stripe gateway",
        "use_label": true,
        "use_icon": true,
        "use_desc": true,
        "email": "",
        "sandbox": false,
        "force_ssl": false,
        "debug": false,
        "test_mode": "on",
        "use_stripe_checkout": false,
        "churn_buster_enabled": false,
        "churn_buster_uuid": "",
        "api_keys": {
          "test": {
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
          },
          "live": {
            "public": "",
            "secret": ""
          }
        },
        "saved": "1",
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
      },
      "capabilities": [
        "process-credit-cards",
        "process-payments",
        "process-refunds",
        "create-subscriptions",
        "cancel-subscriptions",
        "update-subscriptions",
        "suspend-subscriptions",
        "resume-subscriptions",
        "send-cc-expirations"
      ]
    },
    "price": "80.00",
    "period": "1",
    "period_type": "years",
    "limit_cycles": "0",
    "limit_cycles_num": "2",
    "limit_cycles_action": "expire",
    "prorated_trial": "0",
    "trial": "1",
    "trial_days": "14",
    "trial_amount": "0.00",
    "status": "active",
    "created_at": "2019-01-10 22:40:03",
    "total": "80.00",
    "tax_rate": "0.000",
    "tax_amount": "0.00",
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": "1111",
    "cc_exp_month": "10",
    "cc_exp_year": "2020",
    "token": "32-yourdomain.com-5c59c54c8e755",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Subscription Resumed

Description

Sent when a subscription is resumed.

Sample Response

{
  "event": "subscription-resumed",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": false,
    "member": 0,
    "id": 0,
    "subscr_id": "mp-sub-5cbf49bc32f6b",
    "gateway": {
      "name": "Manual",
      "label": "Manual",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/offline.png",
      "use_icon": true,
      "desc": "",
      "use_desc": true,
      "id": "manual",
      "has_spc_form": null,
      "settings": {},
      "capabilities": []
    },
    "price": 0,
    "period": 1,
    "period_type": "months",
    "limit_cycles": false,
    "limit_cycles_num": 0,
    "limit_cycles_action": null,
    "prorated_trial": false,
    "trial": false,
    "trial_days": 0,
    "trial_amount": 0,
    "status": "pending",
    "created_at": null,
    "total": 0,
    "tax_rate": 0,
    "tax_amount": 0,
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": null,
    "cc_exp_month": null,
    "cc_exp_year": null,
    "token": null
  }
}

Subscription Stopped

Description

Sent when a subscription is cancelled.

Sample Response

{
  "event": "subscription-stopped",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": false,
    "member": 0,
    "id": 0,
    "subscr_id": "mp-sub-5cbf49f34eb28",
    "gateway": {
      "name": "Manual",
      "label": "Manual",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/offline.png",
      "use_icon": true,
      "desc": "",
      "use_desc": true,
      "id": "manual",
      "has_spc_form": null,
      "settings": {},
      "capabilities": []
    },
    "price": 0,
    "period": 1,
    "period_type": "months",
    "limit_cycles": false,
    "limit_cycles_num": 0,
    "limit_cycles_action": null,
    "prorated_trial": false,
    "trial": false,
    "trial_days": 0,
    "trial_amount": 0,
    "status": "pending",
    "created_at": null,
    "total": 0,
    "tax_rate": 0,
    "tax_amount": 0,
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": null,
    "cc_exp_month": null,
    "cc_exp_year": null,
    "token": null
  }
}

Subscription Upgraded

Description

DEPRECATED - Please use Subscription Upgraded to (Recurring | Non-Recurring) instead.

Sample Response

{
  "event": "subscription-upgraded",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": {
      "id": 247,
      "title": "274 yearly",
      "content": "",
      "excerpt": "",
      "date": "2019-03-04 15:47:14",
      "status": "publish",
      "author": "5",
      "date_gmt": "2019-03-04 22:47:14",
      "modified": "2019-03-04 15:47:14",
      "modified_gmt": "2019-03-04 22:47:14",
      "group": "248",
      "price": "274.00",
      "period": "1",
      "period_type": "years",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "1",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "274 yearly",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-03-04",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": false,
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 44,
      "email": "264@test.com",
      "username": "264@test.com",
      "nicename": "264test-com",
      "url": "",
      "message": "",
      "registered_at": "2019-03-04 22:48:48",
      "first_name": "",
      "last_name": "",
      "display_name": "264@test.com"
    },
    "id": "55",
    "subscr_id": "cus_Edh0OEAyG94pBP",
    "gateway": {
      "name": "Stripe",
      "label": "My Stripe gateway",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/cards.png",
      "use_icon": true,
      "desc": "Pay with your credit card via Stripe",
      "use_desc": true,
      "id": "peum51-1tc",
      "has_spc_form": true,
      "settings": {
        "gateway": "MeprStripeGateway",
        "id": "peum51-1tc",
        "label": "My Stripe gateway",
        "use_label": true,
        "use_icon": true,
        "use_desc": true,
        "email": "",
        "sandbox": false,
        "force_ssl": false,
        "debug": false,
        "test_mode": "on",
        "use_stripe_checkout": false,
        "churn_buster_enabled": false,
        "churn_buster_uuid": "",
        "api_keys": {
          "test": {
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
          },
          "live": {
            "public": "",
            "secret": ""
          }
        },
        "saved": "1",
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
      },
      "capabilities": [
        "process-credit-cards",
        "process-payments",
        "process-refunds",
        "create-subscriptions",
        "cancel-subscriptions",
        "update-subscriptions",
        "suspend-subscriptions",
        "resume-subscriptions",
        "send-cc-expirations"
      ]
    },
    "price": "274.00",
    "period": "1",
    "period_type": "years",
    "limit_cycles": "0",
    "limit_cycles_num": "2",
    "limit_cycles_action": "expire",
    "prorated_trial": "1",
    "trial": "1",
    "trial_days": "7",
    "trial_amount": "1.00",
    "status": "active",
    "created_at": "2019-03-04 22:51:12",
    "total": "274.00",
    "tax_rate": "0.000",
    "tax_amount": "0.00",
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": "1111",
    "cc_exp_month": "10",
    "cc_exp_year": "2020",
    "token": "",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Subscription Downgraded

Description

DEPRECATED - Please use Subscription Downgraded to (Recurring | Non-Recurring) instead.

Sample Response

{
  "event": "subscription-downgraded",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": {
      "id": 13,
      "title": "Bronze Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:08:50",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:08:50",
      "modified": "2019-01-14 13:49:13",
      "modified_gmt": "2019-01-14 20:49:13",
      "group": "17",
      "price": "0.00",
      "period": "1",
      "period_type": "lifetime",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "0",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Bronze Membership",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-01-14",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": false,
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 30,
      "email": "downgrade@email.com",
      "username": "downgrade@email.com",
      "nicename": "downgradeemail-com",
      "url": "",
      "message": "",
      "registered_at": "2018-12-28 17:51:46",
      "first_name": "downgrade",
      "last_name": "downgrade",
      "display_name": "downgrade@email.com"
    },
    "id": "71",
    "amount": "0.00",
    "total": "0.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "mp-txn-5c2663104e471",
    "status": "complete",
    "txn_type": "payment",
    "gateway": {
      "name": "Free",
      "label": "Free",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/offline.png",
      "use_icon": true,
      "desc": "",
      "use_desc": true,
      "id": "free",
      "has_spc_form": null,
      "settings": {},
      "capabilities": []
    },
    "prorated": "1",
    "created_at": "2018-12-28 17:53:18",
    "expires_at": "0000-00-00 00:00:00",
    "subscription_id": "0",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Subscription Upgraded to Non-Recurring

Description

Sent when a user upgrades their Subscription and the new Subscription is non-recurring (one-time payment).

Sample Response

{
  "event": "subscription-upgraded-to-one-time",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 16,
      "title": "Platinum Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:44",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:44",
      "modified": "2018-11-29 10:04:26",
      "modified_gmt": "2018-11-29 17:04:26",
      "group": "17",
      "price": "2600.00",
      "period": "1",
      "period_type": "lifetime",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "3",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Platinum Membership",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2018-11-29",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": "0",
    "id": "26",
    "amount": "2590.83",
    "total": "2590.83",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1DMLSfJT1LHvX6ILAUpQUAe0",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "1",
    "created_at": "2018-10-17 20:17:14",
    "expires_at": "0000-00-00 00:00:00",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": false,
    "commissions": []
  }
}

Subscription Upgraded to Recurring

Description

Sent when a user upgrades their Subscription and the new Subscription is auto-recurring (payments happen automatically each payment cycle).

Sample Response

{
  "event": "subscription-upgraded-to-recurring",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": {
      "id": 247,
      "title": "274 yearly",
      "content": "",
      "excerpt": "",
      "date": "2019-03-04 15:47:14",
      "status": "publish",
      "author": "5",
      "date_gmt": "2019-03-04 22:47:14",
      "modified": "2019-03-04 15:47:14",
      "modified_gmt": "2019-03-04 22:47:14",
      "group": "248",
      "price": "274.00",
      "period": "1",
      "period_type": "years",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "1",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "274 yearly",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-03-04",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": false,
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 44,
      "email": "264@test.com",
      "username": "264@test.com",
      "nicename": "264test-com",
      "url": "",
      "message": "",
      "registered_at": "2019-03-04 22:48:48",
      "first_name": "",
      "last_name": "",
      "display_name": "264@test.com"
    },
    "id": "55",
    "subscr_id": "cus_Edh0OEAyG94pBP",
    "gateway": {
      "name": "Stripe",
      "label": "My Stripe gateway",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/cards.png",
      "use_icon": true,
      "desc": "Pay with your credit card via Stripe",
      "use_desc": true,
      "id": "peum51-1tc",
      "has_spc_form": true,
      "settings": {
        "gateway": "MeprStripeGateway",
        "id": "peum51-1tc",
        "label": "My Stripe gateway",
        "use_label": true,
        "use_icon": true,
        "use_desc": true,
        "email": "",
        "sandbox": false,
        "force_ssl": false,
        "debug": false,
        "test_mode": "on",
        "use_stripe_checkout": false,
        "churn_buster_enabled": false,
        "churn_buster_uuid": "",
        "api_keys": {
          "test": {
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
          },
          "live": {
            "public": "",
            "secret": ""
          }
        },
        "saved": "1",
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
      },
      "capabilities": [
        "process-credit-cards",
        "process-payments",
        "process-refunds",
        "create-subscriptions",
        "cancel-subscriptions",
        "update-subscriptions",
        "suspend-subscriptions",
        "resume-subscriptions",
        "send-cc-expirations"
      ]
    },
    "price": "274.00",
    "period": "1",
    "period_type": "years",
    "limit_cycles": "0",
    "limit_cycles_num": "2",
    "limit_cycles_action": "expire",
    "prorated_trial": "1",
    "trial": "1",
    "trial_days": "7",
    "trial_amount": "1.00",
    "status": "active",
    "created_at": "2019-03-04 22:51:12",
    "total": "274.00",
    "tax_rate": "0.000",
    "tax_amount": "0.00",
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": "1111",
    "cc_exp_month": "10",
    "cc_exp_year": "2020",
    "token": "",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Subscription Downgraded to Non-Recurring

Description

Sent when a user downgrades their Subscription and the new Subscription is non-recurring (one-time payment).

Sample Response

{
  "event": "subscription-downgraded-to-one-time",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 13,
      "title": "Bronze Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:08:50",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:08:50",
      "modified": "2019-01-14 13:49:13",
      "modified_gmt": "2019-01-14 20:49:13",
      "group": "17",
      "price": "0.00",
      "period": "1",
      "period_type": "lifetime",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "0",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Bronze Membership",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-01-14",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": false,
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 30,
      "email": "downgrade@email.com",
      "username": "downgrade@email.com",
      "nicename": "downgradeemail-com",
      "url": "",
      "message": "",
      "registered_at": "2018-12-28 17:51:46",
      "first_name": "downgrade",
      "last_name": "downgrade",
      "display_name": "downgrade@email.com",
      "address": {
        "mepr-address-one": "123 fake st",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": "0",
    "id": "71",
    "amount": "0.00",
    "total": "0.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "mp-txn-5c2663104e471",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "free",
    "prorated": "1",
    "created_at": "2018-12-28 17:53:18",
    "expires_at": "0000-00-00 00:00:00",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": false
  }
}

Subscription Downgraded to Recurring

Description

Sent when a user downgrades their Subscription and the new Subscription is auto-recurring (payments happen automatically each payment cycle).

Sample Response

{
  "event": "subscription-downgraded-to-recurring",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
    },
    "id": "12",
    "subscr_id": "cus_DrJ5MoBA4aJi27",
    "gateway": {
      "name": "Stripe",
      "label": "My Stripe gateway",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/cards.png",
      "use_icon": true,
      "desc": "Pay with your credit card via Stripe",
      "use_desc": true,
      "id": "peum51-1tc",
      "has_spc_form": true,
      "settings": {
        "gateway": "MeprStripeGateway",
        "id": "peum51-1tc",
        "label": "My Stripe gateway",
        "use_label": true,
        "use_icon": true,
        "use_desc": true,
        "email": "",
        "sandbox": false,
        "force_ssl": false,
        "debug": false,
        "test_mode": "on",
        "use_stripe_checkout": false,
        "churn_buster_enabled": false,
        "churn_buster_uuid": "",
        "api_keys": {
          "test": {
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
          },
          "live": {
            "public": "",
            "secret": ""
          }
        },
        "saved": "1",
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
      },
      "capabilities": [
        "process-credit-cards",
        "process-payments",
        "process-refunds",
        "create-subscriptions",
        "cancel-subscriptions",
        "update-subscriptions",
        "suspend-subscriptions",
        "resume-subscriptions",
        "send-cc-expirations"
      ]
    },
    "price": "100.00",
    "period": "1",
    "period_type": "months",
    "limit_cycles": "0",
    "limit_cycles_num": "2",
    "limit_cycles_action": "expire",
    "prorated_trial": "1",
    "trial": "1",
    "trial_days": "31",
    "trial_amount": "0.00",
    "status": "cancelled",
    "created_at": "2018-10-26 18:56:20",
    "total": "100.00",
    "tax_rate": "0.000",
    "tax_amount": "0.00",
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": "1111",
    "cc_exp_month": "10",
    "cc_exp_year": "2020",
    "token": "",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Subscription Expired

Description

Sent when a subscription expires.

Sample Response

{
  "event": "subscription-expired",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
    },
    "id": "58",
    "subscr_id": "cus_EhmAfr0Y1tbHSL",
    "gateway": {
      "name": "Stripe",
      "label": "My Stripe gateway",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/cards.png",
      "use_icon": true,
      "desc": "Pay with your credit card via Stripe",
      "use_desc": true,
      "id": "peum51-1tc",
      "has_spc_form": true,
      "settings": {
        "gateway": "MeprStripeGateway",
        "id": "peum51-1tc",
        "label": "My Stripe gateway",
        "use_label": true,
        "use_icon": true,
        "use_desc": true,
        "email": "",
        "sandbox": false,
        "force_ssl": false,
        "debug": false,
        "test_mode": "on",
        "use_stripe_checkout": false,
        "churn_buster_enabled": false,
        "churn_buster_uuid": "",
        "api_keys": {
          "test": {
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
          },
          "live": {
            "public": "",
            "secret": ""
          }
        },
        "saved": "1",
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
      },
      "capabilities": [
        "process-credit-cards",
        "process-payments",
        "process-refunds",
        "create-subscriptions",
        "cancel-subscriptions",
        "update-subscriptions",
        "suspend-subscriptions",
        "resume-subscriptions",
        "send-cc-expirations"
      ]
    },
    "price": "100.00",
    "period": "1",
    "period_type": "months",
    "limit_cycles": "0",
    "limit_cycles_num": "2",
    "limit_cycles_action": "expire",
    "prorated_trial": "0",
    "trial": "0",
    "trial_days": "0",
    "trial_amount": "0.00",
    "status": "cancelled",
    "created_at": "2019-03-15 20:26:28",
    "total": "100.00",
    "tax_rate": "0.000",
    "tax_amount": "0.00",
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": "1111",
    "cc_exp_month": "10",
    "cc_exp_year": "2020",
    "token": "",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Transaction Completed

Description

Sent when a transaction has completed in MemberPress.

Sample Response

{
  "event": "transaction-completed",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-03-14 13:10:21",
      "modified_gmt": "2019-03-14 19:10:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "Pricing",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "This is a test",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-03-14",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 46,
      "email": "zapier@test.com",
      "username": "zapier@test.com",
      "nicename": "zapiertest-com",
      "url": "",
      "message": "",
      "registered_at": "2019-03-19 16:48:20",
      "first_name": "Zapier",
      "last_name": "test",
      "display_name": "zapier@test.com",
      "address": {
        "mepr-address-one": "123 fake st",
        "mepr-address-two": "",
        "mepr-address-city": "city",
        "mepr-address-state": "UT",
        "mepr-address-zip": "81111",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "Zapier test",
        "mepr_birthday": "2019-03-19",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "46",
      "id": "59",
      "subscr_id": "cus_EjDYhKuKyRY5N2",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-03-19 16:48:25",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "10",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "167",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1EFl6yJT1LHvX6IL95fhb7M4",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-03-19 16:48:28",
    "expires_at": "2019-04-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": 1,
    "commissions": []
  }
}

Transaction Refunded

Description

Sent when any transaction is refunded.

Sample Response

{
  "event": "transaction-refunded",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-03-14 13:10:21",
      "modified_gmt": "2019-03-14 19:10:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "Pricing",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "This is a test",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-03-14",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 46,
      "email": "zapier@test.com",
      "username": "zapier@test.com",
      "nicename": "zapiertest-com",
      "url": "",
      "message": "",
      "registered_at": "2019-03-19 16:48:20",
      "first_name": "Zapier",
      "last_name": "test",
      "display_name": "zapier@test.com",
      "address": {
        "mepr-address-one": "123 fake st",
        "mepr-address-two": "",
        "mepr-address-city": "city",
        "mepr-address-state": "UT",
        "mepr-address-zip": "81111",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "Zapier test",
        "mepr_birthday": "2019-03-19",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "46",
      "id": "59",
      "subscr_id": "cus_EjDYhKuKyRY5N2",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-03-19 16:48:25",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "10",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "167",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1EFl6yJT1LHvX6IL95fhb7M4",
    "status": "refunded",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-03-19 16:48:28",
    "expires_at": "2019-04-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": 1,
    "commissions": []
  }
}

Transaction Failed

Description

Sent when any transaction fails.

Sample Response

{
  "event": "transaction-failed",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "46",
      "subscr_id": "cus_EYoeMWfkPS0bOA",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-02-19 22:24:53",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "11",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "201",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ER69hJT1LHvX6ILF05DBg0q",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-19 23:30:08",
    "expires_at": "2019-05-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": true,
    "subscription_payment_index": 3,
    "commissions": []
  }
}

Transaction Expired

Description

Sent when any transaction expires.

Sample Response

{
  "event": "transaction-expired",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "58",
      "subscr_id": "cus_EhmAfr0Y1tbHSL",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "cancelled",
      "created_at": "2019-03-15 20:26:28",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "10",
      "cc_exp_year": "2020",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "165",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1EEMbnJT1LHvX6ILQovJh8vj",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-03-15 20:26:30",
    "expires_at": "2019-04-15 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": 1,
    "commissions": []
  }
}

Recurring Transaction Completed

Description

Sent when a transaction associated with a recurring subscription completes.

Sample Response

{
  "event": "recurring-transaction-completed",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "46",
      "subscr_id": "cus_EYoeMWfkPS0bOA",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-02-19 22:24:53",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "11",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "201",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ER69hJT1LHvX6ILF05DBg0q",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-19 23:30:08",
    "expires_at": "2019-05-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": true,
    "subscription_payment_index": 3,
    "commissions": []
  }
}

Renewal Transaction Completed

Description

Sent when the 2nd+ transaction associated with a recurring subscription completes. This does not fire for the first transaction in a recurring subscription, only the 2nd or later payments will trigger this event.

Sample Response

{
  "event": "renewal-transaction-completed",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "46",
      "subscr_id": "cus_EYoeMWfkPS0bOA",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-02-19 22:24:53",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "11",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "201",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ER69hJT1LHvX6ILF05DBg0q",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-19 23:30:08",
    "expires_at": "2019-05-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": true,
    "subscription_payment_index": 3,
    "commissions": []
  }
}

Recurring Transaction Failed

Description

Sent when a recurring transaction completes. Because recurring transactions typically involve a 3rd party gateway it's good to know when a payment has failed on the gateway's end.

Sample Response

{
  "event": "recurring-transaction-failed",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "46",
      "subscr_id": "cus_EYoeMWfkPS0bOA",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-02-19 22:24:53",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "11",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "201",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ER69hJT1LHvX6ILF05DBg0q",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-19 23:30:08",
    "expires_at": "2019-05-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": true,
    "subscription_payment_index": 3,
    "commissions": []
  }
}

Recurring Transaction Expired

Description

Sent when any transaction associated with a subscription expires. This event will not indicate that a recurring subscription is expiring, just that a transaction associated with it is expiring. If you're looking through a subscription expiration event, try 'subscription-expired'.

Sample Response

{
  "event": "recurring-transaction-expired",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "58",
      "subscr_id": "cus_EhmAfr0Y1tbHSL",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "cancelled",
      "created_at": "2019-03-15 20:26:28",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "10",
      "cc_exp_year": "2020",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "165",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1EEMbnJT1LHvX6ILQovJh8vj",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-03-15 20:26:30",
    "expires_at": "2019-04-15 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": 1,
    "commissions": []
  }
}

Non-Recurring Transaction Completed

Description

Sent when a non-recurring transaction has completed on MemberPress.

Sample Response

{
  "event": "non-recurring-transaction-completed",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 271,
      "title": "One day membership",
      "content": "",
      "excerpt": "",
      "date": "2019-04-04 12:14:54",
      "status": "publish",
      "author": "5",
      "date_gmt": "2019-04-04 18:14:54",
      "modified": "2019-04-04 12:14:54",
      "modified_gmt": "2019-04-04 18:14:54",
      "group": "0",
      "price": "10.00",
      "period": "1",
      "period_type": "lifetime",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "0",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "One day membership",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "delay",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-04",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": false,
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": "0",
    "id": "195",
    "amount": "10.00",
    "total": "10.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1EPstWJT1LHvX6ILpbHj3WEZ",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-16 15:08:20",
    "expires_at": "2019-04-17 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": false,
    "commissions": []
  }
}

Non-Recurring Transaction Expired

Description

Sent when any transaction not associated with a subscription expires.

Sample Response

{
  "event": "non-recurring-transaction-expired",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 92,
      "title": "Unlock Your Performance - Premium",
      "content": "",
      "excerpt": "",
      "date": "2018-09-24 14:24:43",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-09-24 20:24:43",
      "modified": "2019-04-05 15:35:29",
      "modified_gmt": "2019-04-05 21:35:29",
      "group": "93",
      "price": "257.00",
      "period": "1",
      "period_type": "lifetime",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "0",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Unlock Your Performance - Premium",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "delay",
      "expire_after": "1",
      "expire_unit": "weeks",
      "expire_fixed": "2019-04-05",
      "tax_exempt": false,
      "allow_renewal": "1",
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": false,
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
     "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": "0",
    "id": "188",
    "amount": "257.00",
    "total": "257.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ELzhmJT1LHvX6ILPVV6mtMr",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-05 21:35:49",
    "expires_at": "2019-04-12 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": false,
    "commissions": []
  }
}

After Member Registers

Description

Sent when any After Member Signup reminder fires.

Sample Response

{
  "event": "after-member-signup-reminder",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "46",
      "subscr_id": "cus_EYoeMWfkPS0bOA",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-02-19 22:24:53",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "11",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "201",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ER69hJT1LHvX6ILF05DBg0q",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-19 23:30:08",
    "expires_at": "2019-05-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": true,
    "subscription_payment_index": 3,
    "commissions": []
  }
}

After Signup Abandoned

Description

Sent when any After Member Signup Abandoned reminder fires.

Sample Response

{
  "event": "after-signup-abandoned-reminder",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 92,
      "title": "Unlock Your Performance - Premium",
      "content": "",
      "excerpt": "",
      "date": "2018-09-24 14:24:43",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-09-24 20:24:43",
      "modified": "2019-04-05 15:35:29",
      "modified_gmt": "2019-04-05 21:35:29",
      "group": "93",
      "price": "257.00",
      "period": "1",
      "period_type": "lifetime",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "0",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Unlock Your Performance - Premium",
      "pricing_show_price": true,
      "pricing_display": "auto",
      "custom_price": "",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "default",
      "register_price": "",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "delay",
      "expire_after": "1",
      "expire_unit": "weeks",
      "expire_fixed": "2019-04-05",
      "tax_exempt": false,
      "allow_renewal": "1",
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": false,
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": false,
      "custom_payment_methods": [],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": "0",
    "id": "189",
    "amount": "257.00",
    "total": "257.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "mp-txn-5ca7ca6a1d8a6",
    "status": "pending",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-05 21:36:42",
    "expires_at": "2019-04-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": false,
    "subscription_payment_index": false
  }
}

Before Subscription Expires

Description

Sent when any Before Subscription Expires reminder fires

Sample Response

{
  "event": "before-sub-expires-reminder",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "46",
      "subscr_id": "cus_EYoeMWfkPS0bOA",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-02-19 22:24:53",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "11",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "201",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ER69hJT1LHvX6ILF05DBg0q",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-19 23:30:08",
    "expires_at": "2019-05-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": true,
    "subscription_payment_index": 3,
    "commissions": []
  }
}

After Subscription Expires

Description

Sent when any After Subscription Expires reminder fires.

Sample Response

{
  "event": "after-sub-expires-reminder",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "46",
      "subscr_id": "cus_EYoeMWfkPS0bOA",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-02-19 22:24:53",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "11",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "201",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ER69hJT1LHvX6ILF05DBg0q",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-19 23:30:08",
    "expires_at": "2019-05-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": true,
    "subscription_payment_index": 3,
    "commissions": []
  }
}

Before Subscription Renews

Description

Sent when any Before Subscription Renews reminder fires.

Sample Response

{
  "event": "before-sub-renews-reminder",
  "type": "transaction",
  "data": {
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 5,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "http://zapier.test.com",
      "message": "",
      "registered_at": "2018-08-30 16:42:13",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapier test",
      "address": {
        "mepr-address-one": "120 S 200 W",
        "mepr-address-two": "",
        "mepr-address-city": "lehi",
        "mepr-address-state": "UT",
        "mepr-address-zip": "84043",
        "mepr-address-country": "US"
      },
      "profile": {
        "mepr_company_name": "",
        "mepr_birthday": "2019-01-02",
        "mepr_testslug": ""
      }
    },
    "coupon": "0",
    "subscription": {
      "coupon": "0",
      "membership": "15",
      "member": "5",
      "id": "46",
      "subscr_id": "cus_EYoeMWfkPS0bOA",
      "gateway": "peum51-1tc",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "limit_cycles": "0",
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "prorated_trial": "0",
      "trial": "0",
      "trial_days": "0",
      "trial_amount": "0.00",
      "status": "active",
      "created_at": "2019-02-19 22:24:53",
      "total": "100.00",
      "tax_rate": "0.000",
      "tax_amount": "0.00",
      "tax_desc": "",
      "tax_class": "standard",
      "cc_last4": "1111",
      "cc_exp_month": "11",
      "cc_exp_year": "2030",
      "token": "",
      "tax_compound": "0",
      "tax_shipping": "1",
      "response": null
    },
    "id": "201",
    "amount": "100.00",
    "total": "100.00",
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "tax_desc": "",
    "tax_class": "standard",
    "trans_num": "ch_1ER69hJT1LHvX6ILF05DBg0q",
    "status": "complete",
    "txn_type": "payment",
    "gateway": "peum51-1tc",
    "prorated": "0",
    "created_at": "2019-04-19 23:30:08",
    "expires_at": "2019-05-19 23:59:59",
    "corporate_account_id": "0",
    "parent_transaction_id": "0",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null,
    "rebill": true,
    "subscription_payment_index": 3,
    "commissions": []
  }
}

After Credit Card Expires

Description

Sent when any After Credit Card Expires reminder fires.

Sample Response

{
  "event": "after-cc-expires-reminder",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 56,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "",
      "message": "",
      "registered_at": "2019-04-18 16:47:14",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapiertest"
    },
    "id": "69",
    "subscr_id": "cus_EuSIHGllVD3168",
    "gateway": {
      "name": "Stripe",
      "label": "My Stripe gateway",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/cards.png",
      "use_icon": true,
      "desc": "Pay with your credit card via Stripe",
      "use_desc": true,
      "id": "peum51-1tc",
      "has_spc_form": true,
      "settings": {
        "gateway": "MeprStripeGateway",
        "id": "peum51-1tc",
        "label": "My Stripe gateway",
        "use_label": true,
        "use_icon": true,
        "use_desc": true,
        "email": "",
        "sandbox": false,
        "force_ssl": false,
        "debug": false,
        "test_mode": "on",
        "use_stripe_checkout": false,
        "churn_buster_enabled": false,
        "churn_buster_uuid": "",
        "api_keys": {
          "test": {
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
          },
          "live": {
            "public": "",
            "secret": ""
          }
        },
        "saved": "1",
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
      },
      "capabilities": [
        "process-credit-cards",
        "process-payments",
        "process-refunds",
        "create-subscriptions",
        "cancel-subscriptions",
        "update-subscriptions",
        "suspend-subscriptions",
        "resume-subscriptions",
        "send-cc-expirations"
      ]
    },
    "price": "100.00",
    "period": "1",
    "period_type": "months",
    "limit_cycles": "0",
    "limit_cycles_num": "2",
    "limit_cycles_action": "expire",
    "prorated_trial": "0",
    "trial": "0",
    "trial_days": "0",
    "trial_amount": "0.00",
    "status": "active",
    "created_at": "2019-04-18 16:47:19",
    "total": "100.00",
    "tax_rate": "0.000",
    "tax_amount": "0.00",
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": "1111",
    "cc_exp_month": "10",
    "cc_exp_year": "2020",
    "token": "",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Before Credit Card Expires

Description

Sent when any Before Credit Card Expires reminder fires.

Sample Response

{
  "event": "before-cc-expires-reminder",
  "type": "subscription",
  "data": {
    "coupon": false,
    "membership": {
      "id": 15,
      "title": "Gold Membership",
      "content": "",
      "excerpt": "",
      "date": "2018-08-30 16:10:22",
      "status": "publish",
      "author": "2",
      "date_gmt": "2018-08-30 16:10:22",
      "modified": "2019-04-23 08:57:21",
      "modified_gmt": "2019-04-23 14:57:21",
      "group": "17",
      "price": "100.00",
      "period": "1",
      "period_type": "months",
      "signup_button_text": "Sign Up",
      "limit_cycles": false,
      "limit_cycles_num": "2",
      "limit_cycles_action": "expire",
      "trial": false,
      "trial_days": "0",
      "trial_amount": "0.00",
      "trial_once": "1",
      "group_order": "2",
      "is_highlighted": false,
      "plan_code": "",
      "pricing_title": "Gold Membership",
      "pricing_show_price": true,
      "pricing_display": "custom",
      "custom_price": "$100 recurring yearly",
      "pricing_heading_txt": "",
      "pricing_footer_txt": "",
      "pricing_button_txt": "Sign Up",
      "pricing_button_position": "footer",
      "pricing_benefits": [
        ""
      ],
      "register_price_action": "custom",
      "register_price": "$100 recurring yearly",
      "thank_you_page_enabled": false,
      "thank_you_page_type": "message",
      "thank_you_message": "",
      "thank_you_page_id": "0",
      "custom_login_urls_enabled": false,
      "custom_login_urls_default": "",
      "custom_login_urls": [],
      "expire_type": "none",
      "expire_after": "1",
      "expire_unit": "days",
      "expire_fixed": "2019-04-23",
      "tax_exempt": false,
      "allow_renewal": false,
      "access_url": "",
      "disable_address_fields": false,
      "simultaneous_subscriptions": "1",
      "use_custom_template": false,
      "custom_template": "template-sitemap.php",
      "customize_payment_methods": "1",
      "custom_payment_methods": [
        "peum51-1tc"
      ],
      "customize_profile_fields": false,
      "custom_profile_fields": [],
      "cannot_purchase_message": "You don't have access to purchase this item."
    },
    "member": {
      "id": 56,
      "email": "zapier@test.com",
      "username": "zapiertest",
      "nicename": "zapiertest",
      "url": "",
      "message": "",
      "registered_at": "2019-04-18 16:47:14",
      "first_name": "zapier",
      "last_name": "test",
      "display_name": "zapiertest"
    },
    "id": "69",
    "subscr_id": "cus_EuSIHGllVD3168",
    "gateway": {
      "name": "Stripe",
      "label": "My Stripe gateway",
      "use_label": true,
      "icon": "http://yourdomain.com/wp-content/plugins/memberpress/images/checkout/cards.png",
      "use_icon": true,
      "desc": "Pay with your credit card via Stripe",
      "use_desc": true,
      "id": "peum51-1tc",
      "has_spc_form": true,
      "settings": {
        "gateway": "MeprStripeGateway",
        "id": "peum51-1tc",
        "label": "My Stripe gateway",
        "use_label": true,
        "use_icon": true,
        "use_desc": true,
        "email": "",
        "sandbox": false,
        "force_ssl": false,
        "debug": false,
        "test_mode": "on",
        "use_stripe_checkout": false,
        "churn_buster_enabled": false,
        "churn_buster_uuid": "",
        "api_keys": {
          "test": {
            "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
          },
          "live": {
            "public": "",
            "secret": ""
          }
        },
        "saved": "1",
        "public_key": "pk_test_99NqpKsIsKWcjE2cgvKViV99",
        "secret_key": "sk_test_99WXy9TgeQGH47NMkNSnSd99"
      },
      "capabilities": [
        "process-credit-cards",
        "process-payments",
        "process-refunds",
        "create-subscriptions",
        "cancel-subscriptions",
        "update-subscriptions",
        "suspend-subscriptions",
        "resume-subscriptions",
        "send-cc-expirations"
      ]
    },
    "price": "100.00",
    "period": "1",
    "period_type": "months",
    "limit_cycles": "0",
    "limit_cycles_num": "2",
    "limit_cycles_action": "expire",
    "prorated_trial": "0",
    "trial": "0",
    "trial_days": "0",
    "trial_amount": "0.00",
    "status": "active",
    "created_at": "2019-04-18 16:47:19",
    "total": "100.00",
    "tax_rate": "0.000",
    "tax_amount": "0.00",
    "tax_desc": "",
    "tax_class": "standard",
    "cc_last4": "1111",
    "cc_exp_month": "10",
    "cc_exp_year": "2020",
    "token": "",
    "tax_compound": "0",
    "tax_shipping": "1",
    "response": null
  }
}

Course Started

Description

Sent when a user views the course for the first time.

Sample Response

{
  "event": "mpca-course-started",
  "type": "member",
  "data": {
    "id": 1160,
    "email": "john@email.com",
    "username": "johndoe",
    "nicename": "johndoe",
    "registered_at": "2021-07-20 18:15:18",
    "display_name": "johndoe",
    "course": {
      "id": 1627,
      "title": "Test Course",
      "started": "2021-07-21 13:01:45",
      "completed": "2021-07-21 13:02:01"
    }
  }
}

Course Completed

Description

Sent when a user completes the course.

Sample Response

{
  "event": "mpca-course-completed",
  "type": "member",
  "data": {
    "id": 1160,
    "email": "john@email.com",
    "username": "johndoe",
    "nicename": "johndoe",
    "registered_at": "2021-07-20 18:15:18",
    "display_name": "johndoe",
    "course": {
      "id": 1627,
      "title": "Test Course",
      "started": "2021-07-21 13:01:45",
      "completed": "2021-07-21 13:02:01"
    }
  }
}

Lesson Started

Description

Sent when a user views the lesson for the first time.

Sample Response

{
  "event": "mpca-lesson-started",
  "type": "member",
  "data": {
    "id": 1160,
    "email": "john@email.com",
    "username": "johndoe",
    "nicename": "johndoe",
    "registered_at": "2021-07-20 18:15:18",
    "display_name": "johndoe",
    "course": {
      "id": 1627,
      "title": "Test Course",
      "started": "2021-07-21 13:01:45",
      "completed": "2021-07-21 13:02:01"
    },
    "lesson": {
      "id": 1324,
      "title": "Test Lesson",
      "started": "2021-07-21 13:01:52",
      "completed": "2021-07-21 13:01:54"
    }
  }
}

Lesson Completed

Description

Sent when a user completed the lesson.

Sample Response

{
  "event": "mpca-lesson-completed",
  "type": "member",
  "data": {
    "id": 1160,
    "email": "john@email.com",
    "username": "johndoe",
    "nicename": "johndoe",
    "registered_at": "2021-07-20 18:15:18",
    "display_name": "johndoe",
    "course": {
      "id": 1627,
      "title": "Test Course",
      "started": "2021-07-21 13:01:45",
      "completed": "2021-07-21 13:02:01"
    },
    "lesson": {
      "id": 1324,
      "title": "Test Lesson",
      "started": "2021-07-21 13:01:52",
      "completed": "2021-07-21 13:01:54"
    }
  }
}

Quiz Attempted

Description

Sent when a user attempts the quiz.

Sample Response

{
  "event": "mpca-quiz-attempt-completed",
  "type": "member",
  "data": {
    "id": 1160,
    "email": "john@email.com",
    "username": "johndoe",
    "nicename": "johndoe",
    "registered_at": "2021-07-20 18:15:18",
    "display_name": "johndoe",
    "attempt": {
      "id": 10,
      "attempt_no": 1,
      "points_possible": 1,
      "points_scored": 1,
      "score": "100%",
      "date_attempt": "2021-07-21 13:02:01"
    },
    "course": {
      "id": 1627,
      "title": "Test Course",
      "started": "2021-07-21 13:01:45",
      "completed": "2021-07-21 13:02:01"
    },
    "quiz": {
      "id": 1490,
      "title": "Test Quiz"
    }
  }
}