MemberPress

App · 25 actions

Run your WordPress membership site: add and update members, give them memberships, record and refund payments, cancel or expire subscriptions, make coupons, and start workflows when members sign up, pay, renew or cancel.

Actions

ActionWhat it does
Add memberAdd a member (a WordPress user), and give them a membership if you choose one.
Cancel subscriptionStop a subscription's future payments.
Create couponCreate a coupon for some memberships: a percent or amount off every payment or only the first, with a usage limit or expiry if you like.
Create membershipCreate a membership (a plan members buy): one-time or recurring, with a trial, a payment limit or an end date if you like.
Create subscriptionRecord a recurring subscription for a member, such as one billed elsewhere.
Create transactionRecord a payment for a member, such as one taken elsewhere.
Delete couponDelete a coupon so it can no longer be used.
Delete memberDelete a member's WordPress account for good.
Delete membershipDelete a membership.
Delete subscriptionDelete a subscription record.
Delete transactionDelete a payment record.
Expire subscriptionEnd a subscription's access now, by expiring its payments that haven't run out yet.
Get memberGet a member with their active memberships, address, profile fields and payment counts.
Get membershipGet a membership's price, billing period, trial and access settings.
Get subscriptionGet a subscription with its status, price, billing period, member and membership.
Get transactionGet a payment with its amount, status, member, membership and when the access it gives ends.
List access rulesList the rules that decide which pages, posts and files each membership can see, with any drip or expiry settings.
List couponsList coupons with their discounts, limits and memberships, or find one by its code.
List membersList members, or find them by email address or username.
List membershipsList the memberships (plans) for sale, with their prices and billing.
List subscriptionsList recurring subscriptions, filtered by member, membership or coupon.
List transactionsList payments, filtered by member, membership, subscription, coupon, status or payment method.
Refund transactionRefund a payment through its payment gateway, and cancel its subscription too if you choose.
Update memberChange a member's email, username, name or address.
Update membershipChange a membership's name, price, billing or access settings.

Add member

Add a member (a WordPress user), and give them a membership if you choose one. MemberPress can email them a link to set their password.

Inputs

EmailemailtextRequired
The new member's email address.
Usernameusernametext
Their WordPress username. Leave empty to use their email address.
First namefirst_nametext
The member's first name.
Last namelast_nametext
The member's last name.
Address line 1address1text
Street address.
Address line 2address2text
Apartment, suite or unit.
Citycitytext
City or town.
Statestatetext
State, province or region.
ZIP or postal codezip_codetext
ZIP or postal code.
Countrycountrytext
Two-letter country code, such as US or GB.
Email a link to set a passwordsend_password_emailtrue/false
Send MemberPress's set-password email, so they can log in.
Membershipmembership_idtext
Give them this membership, recorded as a free, complete payment. Leave empty to add them with no membership.
Membership endsmembership_expires_atdate and time
When that membership ends. Leave empty for access that never ends.
Send welcome emailsend_welcome_emailtrue/false
Send the membership's welcome email. Only with a membership.

Outputs

memberobject
The new member
Example output
{
  "member": {
    "active_membership_titles": "Gold Membership",
    "active_memberships": [
      {
        "id": 15,
        "title": "Gold Membership"
      }
    ],
    "active_transaction_count": 2,
    "address": {
      "city": "Springfield",
      "country": "US",
      "line1": "123 Main St",
      "line2": "",
      "state": "UT",
      "zip": "84111"
    },
    "display_name": "jobloggs",
    "email": "jo@example.com",
    "expired_transaction_count": 0,
    "first_name": "Jo",
    "full_name": "Jo Bloggs",
    "id": 56,
    "last_name": "Bloggs",
    "login_count": 1,
    "profile": {
      "mepr_company_name": "Acme"
    },
    "registered_at": "2026-04-18T16:47:14Z",
    "subscription_count": 1,
    "username": "jobloggs"
  }
}

Cancel subscription

Stop a subscription's future payments. The member keeps access until their last payment's time runs out.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's ID, from 'List subscriptions' or an earlier step.

Outputs

messagetext
MemberPress's own confirmation
subscriptionobject
The cancelled subscription
Example output
{
  "message": "The subscription was successfully cancelled.",
  "subscription": {
    "cc_exp_month": "10",
    "cc_exp_year": "2030",
    "cc_last4": "1111",
    "coupon_id": 0,
    "created_at": "2026-04-18T16:47:19Z",
    "gateway": "manual",
    "id": 69,
    "limit_cycles": false,
    "limit_cycles_num": 2,
    "member_email": "jo@example.com",
    "member_id": 56,
    "member_name": "Jo Bloggs",
    "member_username": "jobloggs",
    "membership_id": 15,
    "membership_title": "Gold Membership",
    "period": 1,
    "period_type": "months",
    "price": "100.00",
    "status": "cancelled",
    "subscr_id": "mp-sub-5cb8a8f6a1b2c",
    "tax_amount": "0.00",
    "total": "100.00",
    "trial": false,
    "trial_amount": "0.00",
    "trial_days": 0
  }
}

Create coupon

Create a coupon for some memberships: a percent or amount off every payment or only the first, with a usage limit or expiry if you like.

Inputs

Membershipsmembership_idslistRequired
The memberships the coupon can be used on.
Discountdiscount_amountnumberRequired
How much it takes off: a percent, or an amount.At least 0.
Discount typediscount_typetext
Percent off or an amount off. Defaults to percent.One of: percent (Percent off), dollar (Amount off).
Codecoupon_codetext
The code members enter: letters, numbers, - and _. MemberPress makes one if empty.
Applies todiscount_modetext
Every payment, only the first payment of a subscription, or a new trial in place of the membership's. Defaults to every payment.One of: standard (Every payment), first-payment (First payment only), trial-override (Replace the trial).
First payment discount typefirst_payment_discount_typetext
With 'First payment only': percent or amount off.One of: percent (Percent off), dollar (Amount off).
First payment discountfirst_payment_discount_amountnumber
With 'First payment only': how much the first payment is reduced.At least 0.
Trial daystrial_daysnumber
With 'Replace the trial': how long the trial lasts.At least 0.
Trial pricetrial_amountnumber
With 'Replace the trial': what the trial costs.At least 0.
Usage limitusage_limitnumber
How many times it can be used. Leave empty for no limit.At least 1.
Expiresexpires_atdate and time
When it stops working. Leave empty to never expire.

Outputs

couponobject
The new coupon
Example output
{
  "coupon": {
    "coupon_code": "B2XJTM2YQB",
    "created_at": "2026-04-10T18:05:53Z",
    "discount_amount": "15.00",
    "discount_mode": "standard",
    "discount_type": "percent",
    "expires_at": "",
    "id": 275,
    "should_expire": false,
    "status": "publish",
    "trial_amount": "0.00",
    "trial_days": 0,
    "usage_count": 0,
    "usage_limit": 0,
    "valid_memberships": [
      {
        "id": 15,
        "title": "Gold Membership"
      }
    ]
  }
}

Create membership

Create a membership (a plan members buy): one-time or recurring, with a trial, a payment limit or an end date if you like.

Inputs

NametitletextRequired
The membership's name, shown on its sign-up page.
Pricepricenumber
The price per billing period, such as 25 or 9.99. Defaults to 0.At least 0.
Billingperiod_typetext
Charge once (lifetime) or every few weeks, months or years. Defaults to a one-time payment.One of: lifetime (One-time payment (lifetime)), weeks, months, years.
Billing everyperiodnumber
How many of those weeks, months or years between payments, such as 3 for quarterly. Defaults to 1.From 1 to 365.
Trialtrialtrue/false
Start recurring memberships with a trial period.
Trial daystrial_daysnumber
How long the trial lasts.At least 0.
Trial pricetrial_amountnumber
What the trial costs.At least 0.
Limit paymentslimit_cyclestrue/false
Stop charging after a number of payments.
Number of paymentslimit_cycles_numnumber
With limited payments: how many to take.At least 1.
After the last paymentlimit_cycles_actiontext
With limited payments: whether access ends or lasts for life.One of: expire (Access ends when the last payment expires), lifetime (Access for life).
Group IDgroup_idtext
The ID of the MemberPress group to put it in, for upgrade paths.
Access endsexpire_typetext
For one-time payments: never, after a time, or on a date.One of: none (Never expires), delay (Expires after a time), fixed (Expires on a date).
Access lastsexpire_afternumber
With 'after a time': how many units access lasts.At least 1.
Access lasts unitexpire_unittext
With 'after a time': days, weeks, months or years.One of: days, weeks, months, years.
Access ends onexpire_fixeddate
With 'on a date': the date access ends.
Sign-up button textsignup_button_texttext
The text on the registration form's button. Defaults to Sign Up.
Access pageaccess_urltext
The address of the page members of it can use.

Outputs

membershipobject
The new membership
Example output
{
  "membership": {
    "access_url": "",
    "created_at": "2026-08-30T16:10:22Z",
    "expire_after": 1,
    "expire_fixed": "",
    "expire_type": "none",
    "expire_unit": "days",
    "group_id": 17,
    "id": 15,
    "limit_cycles": false,
    "limit_cycles_action": "expire",
    "limit_cycles_num": 2,
    "modified_at": "2026-09-01T21:03:22Z",
    "period": 1,
    "period_type": "months",
    "price": "100.00",
    "signup_button_text": "Sign Up",
    "status": "publish",
    "title": "Gold Membership",
    "trial": false,
    "trial_amount": "0.00",
    "trial_days": 0
  }
}

Create subscription

Record a recurring subscription for a member, such as one billed elsewhere. Price and billing default to the membership's.

Inputs

Member IDmember_idtextRequired
The member's ID, from 'List members' or an earlier step.
Membershipmembership_idtextRequired
The membership they subscribe to.
Statusstatustext
Defaults to active.One of: active, pending, suspended (Paused), cancelled.
Pricepricenumber
The price per billing period before tax. Defaults to the membership's.At least 0.
Totaltotalnumber
The price per billing period with tax. Defaults to the price.At least 0.
Billingperiod_typetext
Every few weeks, months or years. Defaults to the membership's.One of: weeks, months, years.
Billing everyperiodnumber
How many weeks, months or years between payments. Defaults to the membership's.From 1 to 365.
Payment method IDgatewaytext
The payment method's ID from MemberPress > Settings > Payments. Defaults to manual.
Subscription numbersubscr_idtext
The payment gateway's own subscription ID, so its payments are matched to this one. MemberPress makes one if empty.
Couponcoupon_idtext
The coupon used, if any.
Trialtrialtrue/false
Whether it starts with a trial.
Trial daystrial_daysnumber
How long the trial lasts.At least 0.
Trial pricetrial_amountnumber
What the trial costs.At least 0.
Limit paymentslimit_cyclestrue/false
Stop charging after a number of payments.
Number of paymentslimit_cycles_numnumber
With limited payments: how many to take.At least 1.
After the last paymentlimit_cycles_actiontext
With limited payments: whether access ends or lasts for life.One of: expire (Access ends when the last payment expires), lifetime (Access for life).
Started atcreated_atdate and time
When it started. Defaults to now.

Outputs

subscriptionobject
The new subscription
Example output
{
  "subscription": {
    "cc_exp_month": "10",
    "cc_exp_year": "2030",
    "cc_last4": "1111",
    "coupon_id": 0,
    "created_at": "2026-04-18T16:47:19Z",
    "gateway": "manual",
    "id": 69,
    "limit_cycles": false,
    "limit_cycles_num": 2,
    "member_email": "jo@example.com",
    "member_id": 56,
    "member_name": "Jo Bloggs",
    "member_username": "jobloggs",
    "membership_id": 15,
    "membership_title": "Gold Membership",
    "period": 1,
    "period_type": "months",
    "price": "100.00",
    "status": "active",
    "subscr_id": "mp-sub-5cb8a8f6a1b2c",
    "tax_amount": "0.00",
    "total": "100.00",
    "trial": false,
    "trial_amount": "0.00",
    "trial_days": 0
  }
}

Create transaction

Record a payment for a member, such as one taken elsewhere. A complete transaction gives them the membership until it ends.

Inputs

Member IDmember_idtextRequired
The member's ID, from 'List members' or an earlier step.
Membershipmembership_idtextRequired
The membership the payment is for.
Amountamountnumber
The amount before tax, such as 25 or 9.99. Defaults to 0.At least 0.
Taxtax_amountnumber
The tax charged.At least 0.
Tax ratetax_ratenumber
The tax rate in percent.From 0 to 100.
Totaltotalnumber
The amount including tax. Defaults to the amount plus tax.At least 0.
Statusstatustext
Complete gives the member access. Defaults to complete.One of: complete, pending, failed, refunded, confirmed (Confirmed (a subscription's sign-up)).
Payment method IDgatewaytext
The payment method's ID from MemberPress > Settings > Payments. Defaults to manual.
Transaction numbertrans_numtext
Your own reference, such as the payment's ID elsewhere. MemberPress makes one if empty.
Subscription IDsubscription_idtext
The subscription this payment belongs to, if any.
Couponcoupon_idtext
The coupon used, if any.
Paid atcreated_atdate and time
When it was paid. Defaults to now.
Access endsexpires_atdate and time
When the access it gives ends. Leave empty for access that never ends.
Send welcome emailsend_welcome_emailtrue/false
Send the membership's welcome email, if they haven't had one.
Send receiptsend_receipt_emailtrue/false
Email the member a receipt.

Outputs

transactionobject
The new transaction
Example output
{
  "transaction": {
    "amount": "100.00",
    "coupon_id": 0,
    "created_at": "2026-04-18T16:47:21Z",
    "expires_at": "2026-05-18T23:59:59Z",
    "gateway": "manual",
    "id": 199,
    "member_email": "jo@example.com",
    "member_id": 56,
    "member_name": "Jo Bloggs",
    "member_username": "jobloggs",
    "membership_id": 15,
    "membership_title": "Gold Membership",
    "status": "complete",
    "subscription_id": 69,
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "total": "100.00",
    "trans_num": "ch_1EQdOLJT1LHvX6IL",
    "txn_type": "payment"
  }
}

Delete coupon

Delete a coupon so it can no longer be used.

Inputs

Couponcoupon_idtextRequired
The coupon to delete.

Outputs

coupon_codetext
The deleted coupon's code
coupon_idnumber
The ID of the coupon deleted
deletedtrue/false
Always true once deleted
Example output
{
  "coupon_code": "B2XJTM2YQB",
  "coupon_id": 275,
  "deleted": true
}

Delete member

Delete a member's WordPress account for good. This can't be undone.

Inputs

Member IDmember_idtextRequired
The member's ID, from 'List members' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
emailtext
The deleted member's email
member_idnumber
The ID of the member deleted
Example output
{
  "deleted": true,
  "email": "jo@example.com",
  "member_id": 56
}

Delete membership

Delete a membership. Members who have it lose access to what it protects.

Inputs

Membershipmembership_idtextRequired
The membership to delete.

Outputs

deletedtrue/false
Always true once deleted
membership_idnumber
The ID of the membership deleted
titletext
The deleted membership's name
Example output
{
  "deleted": true,
  "membership_id": 15,
  "title": "Gold Membership"
}

Delete subscription

Delete a subscription record. It doesn't cancel billing at the payment gateway: cancel it first.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's ID, from 'List subscriptions' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
subscription_idnumber
The ID of the subscription deleted
Example output
{
  "deleted": true,
  "subscription_id": 69
}

Delete transaction

Delete a payment record. Access it gave ends; no money moves.

Inputs

Transaction IDtransaction_idtextRequired
The transaction's ID, from 'List transactions' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
transaction_idnumber
The ID of the transaction deleted
Example output
{
  "deleted": true,
  "transaction_id": 199
}

Expire subscription

End a subscription's access now, by expiring its payments that haven't run out yet.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's ID, from 'List subscriptions' or an earlier step.

Outputs

messagetext
MemberPress's own confirmation
subscriptionobject
The expired subscription
Example output
{
  "message": "This subscription is now expired.",
  "subscription": {
    "cc_exp_month": "10",
    "cc_exp_year": "2030",
    "cc_last4": "1111",
    "coupon_id": 0,
    "created_at": "2026-04-18T16:47:19Z",
    "gateway": "manual",
    "id": 69,
    "limit_cycles": false,
    "limit_cycles_num": 2,
    "member_email": "jo@example.com",
    "member_id": 56,
    "member_name": "Jo Bloggs",
    "member_username": "jobloggs",
    "membership_id": 15,
    "membership_title": "Gold Membership",
    "period": 1,
    "period_type": "months",
    "price": "100.00",
    "status": "active",
    "subscr_id": "mp-sub-5cb8a8f6a1b2c",
    "tax_amount": "0.00",
    "total": "100.00",
    "trial": false,
    "trial_amount": "0.00",
    "trial_days": 0
  }
}

Get member

Get a member with their active memberships, address, profile fields and payment counts.

Inputs

Member IDmember_idtextRequired
The member's ID, from 'List members' or an earlier step.

Outputs

memberobject
The member
Example output
{
  "member": {
    "active_membership_titles": "Gold Membership",
    "active_memberships": [
      {
        "id": 15,
        "title": "Gold Membership"
      }
    ],
    "active_transaction_count": 2,
    "address": {
      "city": "Springfield",
      "country": "US",
      "line1": "123 Main St",
      "line2": "",
      "state": "UT",
      "zip": "84111"
    },
    "display_name": "jobloggs",
    "email": "jo@example.com",
    "expired_transaction_count": 0,
    "first_name": "Jo",
    "full_name": "Jo Bloggs",
    "id": 56,
    "last_name": "Bloggs",
    "login_count": 1,
    "profile": {
      "mepr_company_name": "Acme"
    },
    "registered_at": "2026-04-18T16:47:14Z",
    "subscription_count": 1,
    "username": "jobloggs"
  }
}

Get membership

Get a membership's price, billing period, trial and access settings.

Inputs

Membershipmembership_idtextRequired
The membership to get.

Outputs

membershipobject
The membership
Example output
{
  "membership": {
    "access_url": "",
    "created_at": "2026-08-30T16:10:22Z",
    "expire_after": 1,
    "expire_fixed": "",
    "expire_type": "none",
    "expire_unit": "days",
    "group_id": 17,
    "id": 15,
    "limit_cycles": false,
    "limit_cycles_action": "expire",
    "limit_cycles_num": 2,
    "modified_at": "2026-09-01T21:03:22Z",
    "period": 1,
    "period_type": "months",
    "price": "100.00",
    "signup_button_text": "Sign Up",
    "status": "publish",
    "title": "Gold Membership",
    "trial": false,
    "trial_amount": "0.00",
    "trial_days": 0
  }
}

Get subscription

Get a subscription with its status, price, billing period, member and membership.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's ID, from 'List subscriptions' or an earlier step.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "cc_exp_month": "10",
    "cc_exp_year": "2030",
    "cc_last4": "1111",
    "coupon_id": 0,
    "created_at": "2026-04-18T16:47:19Z",
    "gateway": "manual",
    "id": 69,
    "limit_cycles": false,
    "limit_cycles_num": 2,
    "member_email": "jo@example.com",
    "member_id": 56,
    "member_name": "Jo Bloggs",
    "member_username": "jobloggs",
    "membership_id": 15,
    "membership_title": "Gold Membership",
    "period": 1,
    "period_type": "months",
    "price": "100.00",
    "status": "active",
    "subscr_id": "mp-sub-5cb8a8f6a1b2c",
    "tax_amount": "0.00",
    "total": "100.00",
    "trial": false,
    "trial_amount": "0.00",
    "trial_days": 0
  }
}

Get transaction

Get a payment with its amount, status, member, membership and when the access it gives ends.

Inputs

Transaction IDtransaction_idtextRequired
The transaction's ID, from 'List transactions' or an earlier step.

Outputs

transactionobject
The transaction
Example output
{
  "transaction": {
    "amount": "100.00",
    "coupon_id": 0,
    "created_at": "2026-04-18T16:47:21Z",
    "expires_at": "2026-05-18T23:59:59Z",
    "gateway": "manual",
    "id": 199,
    "member_email": "jo@example.com",
    "member_id": 56,
    "member_name": "Jo Bloggs",
    "member_username": "jobloggs",
    "membership_id": 15,
    "membership_title": "Gold Membership",
    "status": "complete",
    "subscription_id": 69,
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "total": "100.00",
    "trans_num": "ch_1EQdOLJT1LHvX6IL",
    "txn_type": "payment"
  }
}

List access rules

List the rules that decide which pages, posts and files each membership can see, with any drip or expiry settings.

Inputs

Searchsearchtext
Only rules matching this text.
Pagepagenumber
Which page to get, from 1. Defaults to 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. MemberPress's default is 10.From 1 to 100.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so the next page may have more
pagenumber
The page number returned
per_pagenumber
The page size asked for
ruleslist
The access rules
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 10,
  "rules": [
    {
      "created_at": "2026-02-20T17:34:06Z",
      "drip_after": "registers",
      "drip_amount": 0,
      "drip_enabled": false,
      "drip_unit": "days",
      "expires_after": "registers",
      "expires_amount": 0,
      "expires_enabled": false,
      "expires_unit": "days",
      "id": 227,
      "modified_at": "2026-02-20T17:34:06Z",
      "rule_content": "225",
      "rule_type": "single_page",
      "status": "publish",
      "title": "A Single Page: Members area"
    }
  ]
}

List coupons

List coupons with their discounts, limits and memberships, or find one by its code.

Inputs

Codecodetext
Only the coupon with this code.
Searchsearchtext
Only coupons matching this text.
Pagepagenumber
Which page to get, from 1. Defaults to 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. MemberPress's default is 10.From 1 to 100.

Outputs

countnumber
How many came back on this page
couponslist
The coupons
has_moretrue/false
True when the page was full, so the next page may have more
pagenumber
The page number returned
per_pagenumber
The page size asked for
Example output
{
  "count": 1,
  "coupons": [
    {
      "coupon_code": "B2XJTM2YQB",
      "created_at": "2026-04-10T18:05:53Z",
      "discount_amount": "15.00",
      "discount_mode": "standard",
      "discount_type": "percent",
      "expires_at": "",
      "id": 275,
      "should_expire": false,
      "status": "publish",
      "trial_amount": "0.00",
      "trial_days": 0,
      "usage_count": 0,
      "usage_limit": 0,
      "valid_memberships": [
        {
          "id": 15,
          "title": "Gold Membership"
        }
      ]
    }
  ],
  "has_more": false,
  "page": 1,
  "per_page": 10
}

List members

List members, or find them by email address or username. Gets one page; to see more, run it again with the next page number.

Inputs

Email or usernamesearchtext
Only members whose email address or username matches this.
Pagepagenumber
Which page to get, from 1. Defaults to 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. MemberPress's default is 10.From 1 to 100.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so the next page may have more
memberslist
The members
pagenumber
The page number returned
per_pagenumber
The page size asked for
Example output
{
  "count": 1,
  "has_more": false,
  "members": [
    {
      "active_membership_titles": "Gold Membership",
      "active_memberships": [
        {
          "id": 15,
          "title": "Gold Membership"
        }
      ],
      "active_transaction_count": 2,
      "address": {
        "city": "Springfield",
        "country": "US",
        "line1": "123 Main St",
        "line2": "",
        "state": "UT",
        "zip": "84111"
      },
      "display_name": "jobloggs",
      "email": "jo@example.com",
      "expired_transaction_count": 0,
      "first_name": "Jo",
      "full_name": "Jo Bloggs",
      "id": 56,
      "last_name": "Bloggs",
      "login_count": 1,
      "profile": {
        "mepr_company_name": "Acme"
      },
      "registered_at": "2026-04-18T16:47:14Z",
      "subscription_count": 1,
      "username": "jobloggs"
    }
  ],
  "page": 1,
  "per_page": 10
}

List memberships

List the memberships (plans) for sale, with their prices and billing.

Inputs

Searchsearchtext
Only memberships matching this text.
Group IDgroup_idtext
Only memberships in this group.
Pagepagenumber
Which page to get, from 1. Defaults to 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. MemberPress's default is 10.From 1 to 100.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so the next page may have more
membershipslist
The memberships
pagenumber
The page number returned
per_pagenumber
The page size asked for
Example output
{
  "count": 1,
  "has_more": false,
  "memberships": [
    {
      "access_url": "",
      "created_at": "2026-08-30T16:10:22Z",
      "expire_after": 1,
      "expire_fixed": "",
      "expire_type": "none",
      "expire_unit": "days",
      "group_id": 17,
      "id": 15,
      "limit_cycles": false,
      "limit_cycles_action": "expire",
      "limit_cycles_num": 2,
      "modified_at": "2026-09-01T21:03:22Z",
      "period": 1,
      "period_type": "months",
      "price": "100.00",
      "signup_button_text": "Sign Up",
      "status": "publish",
      "title": "Gold Membership",
      "trial": false,
      "trial_amount": "0.00",
      "trial_days": 0
    }
  ],
  "page": 1,
  "per_page": 10
}

List subscriptions

List recurring subscriptions, filtered by member, membership or coupon. Gets one page at a time.

Inputs

Member IDmember_idtext
Only this member's.
Membershipmembership_idtext
Only subscriptions to this membership.
Couponcoupon_idtext
Only those that used this coupon.
Searchsearchtext
Only subscriptions matching this text.
Pagepagenumber
Which page to get, from 1. Defaults to 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. MemberPress's default is 10.From 1 to 100.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so the next page may have more
pagenumber
The page number returned
per_pagenumber
The page size asked for
subscriptionslist
The subscriptions
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 10,
  "subscriptions": [
    {
      "cc_exp_month": "10",
      "cc_exp_year": "2030",
      "cc_last4": "1111",
      "coupon_id": 0,
      "created_at": "2026-04-18T16:47:19Z",
      "gateway": "manual",
      "id": 69,
      "limit_cycles": false,
      "limit_cycles_num": 2,
      "member_email": "jo@example.com",
      "member_id": 56,
      "member_name": "Jo Bloggs",
      "member_username": "jobloggs",
      "membership_id": 15,
      "membership_title": "Gold Membership",
      "period": 1,
      "period_type": "months",
      "price": "100.00",
      "status": "active",
      "subscr_id": "mp-sub-5cb8a8f6a1b2c",
      "tax_amount": "0.00",
      "total": "100.00",
      "trial": false,
      "trial_amount": "0.00",
      "trial_days": 0
    }
  ]
}

List transactions

List payments, filtered by member, membership, subscription, coupon, status or payment method. Gets one page at a time.

Inputs

Member IDmember_idtext
Only this member's.
Membershipmembership_idtext
Only payments for this membership.
Subscription IDsubscription_idtext
Only this subscription's payments.
Couponcoupon_idtext
Only those that used this coupon.
Statusstatustext
Only transactions with this status.One of: complete, pending, failed, refunded, confirmed (Confirmed (a subscription's sign-up)).
Payment method IDgatewaytext
Only this payment method, by the ID on MemberPress > Settings > Payments.
Searchsearchtext
Only transactions matching this text.
Pagepagenumber
Which page to get, from 1. Defaults to 1.At least 1.
Page sizeper_pagenumber
How many to return, 1 to 100. MemberPress's default is 10.From 1 to 100.

Outputs

countnumber
How many came back on this page
has_moretrue/false
True when the page was full, so the next page may have more
pagenumber
The page number returned
per_pagenumber
The page size asked for
transactionslist
The transactions
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "per_page": 10,
  "transactions": [
    {
      "amount": "100.00",
      "coupon_id": 0,
      "created_at": "2026-04-18T16:47:21Z",
      "expires_at": "2026-05-18T23:59:59Z",
      "gateway": "manual",
      "id": 199,
      "member_email": "jo@example.com",
      "member_id": 56,
      "member_name": "Jo Bloggs",
      "member_username": "jobloggs",
      "membership_id": 15,
      "membership_title": "Gold Membership",
      "status": "complete",
      "subscription_id": 69,
      "tax_amount": "0.00",
      "tax_rate": "0.000",
      "total": "100.00",
      "trans_num": "ch_1EQdOLJT1LHvX6IL",
      "txn_type": "payment"
    }
  ]
}

Refund transaction

Refund a payment through its payment gateway, and cancel its subscription too if you choose. The money goes back to the member.

Inputs

Transaction IDtransaction_idtextRequired
The transaction's ID, from 'List transactions' or an earlier step.
Also cancel the subscriptioncancel_subscriptiontrue/false
Stop the subscription this payment belongs to as well.

Outputs

messagetext
MemberPress's own confirmation
refundedtrue/false
Always true once refunded
subscription_cancelledtrue/false
Whether its subscription was cancelled too
transactionobject
The refunded transaction
Example output
{
  "message": "The transaction was successfully refunded.",
  "refunded": true,
  "subscription_cancelled": false,
  "transaction": {
    "amount": "100.00",
    "coupon_id": 0,
    "created_at": "2026-04-18T16:47:21Z",
    "expires_at": "2026-05-18T23:59:59Z",
    "gateway": "manual",
    "id": 199,
    "member_email": "jo@example.com",
    "member_id": 56,
    "member_name": "Jo Bloggs",
    "member_username": "jobloggs",
    "membership_id": 15,
    "membership_title": "Gold Membership",
    "status": "refunded",
    "subscription_id": 69,
    "tax_amount": "0.00",
    "tax_rate": "0.000",
    "total": "100.00",
    "trans_num": "ch_1EQdOLJT1LHvX6IL",
    "txn_type": "payment"
  }
}

Update member

Change a member's email, username, name or address. Fields left empty keep what they have.

Inputs

Member IDmember_idtextRequired
The member's ID, from 'List members' or an earlier step.
Emailemailtext
A new email address. Leave empty to keep it.
Usernameusernametext
A new username. Leave empty to keep it.
First namefirst_nametext
The member's first name.
Last namelast_nametext
The member's last name.
Address line 1address1text
Street address.
Address line 2address2text
Apartment, suite or unit.
Citycitytext
City or town.
Statestatetext
State, province or region.
ZIP or postal codezip_codetext
ZIP or postal code.
Countrycountrytext
Two-letter country code, such as US or GB.

Outputs

memberobject
The member as it is now
Example output
{
  "member": {
    "active_membership_titles": "Gold Membership",
    "active_memberships": [
      {
        "id": 15,
        "title": "Gold Membership"
      }
    ],
    "active_transaction_count": 2,
    "address": {
      "city": "Springfield",
      "country": "US",
      "line1": "123 Main St",
      "line2": "",
      "state": "UT",
      "zip": "84111"
    },
    "display_name": "jobloggs",
    "email": "jo@example.com",
    "expired_transaction_count": 0,
    "first_name": "Jo",
    "full_name": "Jo Bloggs",
    "id": 56,
    "last_name": "Bloggs",
    "login_count": 1,
    "profile": {
      "mepr_company_name": "Acme"
    },
    "registered_at": "2026-04-18T16:47:14Z",
    "subscription_count": 1,
    "username": "jobloggs"
  }
}

Update membership

Change a membership's name, price, billing or access settings. Fields left empty keep what they have.

Inputs

Membershipmembership_idtextRequired
The membership to change.
Nametitletext
A new name. Leave empty to keep it.
Pricepricenumber
The price per billing period, such as 25 or 9.99. Defaults to 0.At least 0.
Billingperiod_typetext
Charge once (lifetime) or every few weeks, months or years. Defaults to a one-time payment.One of: lifetime (One-time payment (lifetime)), weeks, months, years.
Billing everyperiodnumber
How many of those weeks, months or years between payments, such as 3 for quarterly. Defaults to 1.From 1 to 365.
Trialtrialtrue/false
Start recurring memberships with a trial period.
Trial daystrial_daysnumber
How long the trial lasts.At least 0.
Trial pricetrial_amountnumber
What the trial costs.At least 0.
Limit paymentslimit_cyclestrue/false
Stop charging after a number of payments.
Number of paymentslimit_cycles_numnumber
With limited payments: how many to take.At least 1.
After the last paymentlimit_cycles_actiontext
With limited payments: whether access ends or lasts for life.One of: expire (Access ends when the last payment expires), lifetime (Access for life).
Group IDgroup_idtext
The ID of the MemberPress group to put it in, for upgrade paths.
Access endsexpire_typetext
For one-time payments: never, after a time, or on a date.One of: none (Never expires), delay (Expires after a time), fixed (Expires on a date).
Access lastsexpire_afternumber
With 'after a time': how many units access lasts.At least 1.
Access lasts unitexpire_unittext
With 'after a time': days, weeks, months or years.One of: days, weeks, months, years.
Access ends onexpire_fixeddate
With 'on a date': the date access ends.
Sign-up button textsignup_button_texttext
The text on the registration form's button. Defaults to Sign Up.
Access pageaccess_urltext
The address of the page members of it can use.

Outputs

membershipobject
The membership as it is now
Example output
{
  "membership": {
    "access_url": "",
    "created_at": "2026-08-30T16:10:22Z",
    "expire_after": 1,
    "expire_fixed": "",
    "expire_type": "none",
    "expire_unit": "days",
    "group_id": 17,
    "id": 15,
    "limit_cycles": false,
    "limit_cycles_action": "expire",
    "limit_cycles_num": 2,
    "modified_at": "2026-09-01T21:03:22Z",
    "period": 1,
    "period_type": "months",
    "price": "100.00",
    "signup_button_text": "Sign Up",
    "status": "publish",
    "title": "Gold Membership",
    "trial": false,
    "trial_amount": "0.00",
    "trial_days": 0
  }
}

On this page