The createMember API call is used to create a free or paid member on your membership site. It can also be use to change an existing members membership level. If the email address passed is associated with an existing member and the membership level ID passed is different then the one associated with their account, then MemberMouse will change their membership level and automatically cancel any active subscriptions associated with the current membership.



Sample Request URL


http://{Your_API_URL}?q=/createMember



Input Parameters


ParameterDescriptionRequired
apikeyAPI key from MemberMouse API CredentialsYes
apisecretAPI secret from MemberMouse API CredentialsYes
membership_level_idMembership level ID to assign to the new member's accountYes
product_idEach paid membership level you create in MemberMouse will have a default product associated with it. If this field is left blank then the default product will be used to place the order. You can optionally pass a valid product ID that's associated with the membership level here to charge a different price for the membership level then the default product.No
emailEmail address of the new memberYes
usernameUsername for the new member. If this is not provided the member's email address will be used as their username.No
first_nameFirst name of the new memberNo
last_nameLast name of the new memberNo
passwordThe password you want to set for the new member. If this is not provided, MemberMouse with automatically generate a password for the new member.No
phonePhone number of the new memberNo
billing_addressbilling address of the new memberConditional (No if membership level is free)
billing_citybilling city of the new member.Conditional (No if membership level is free)
billing_statebilling state of the new memberConditional (No if membership level is free)
billing_zipbilling zip code of the new memberConditional (No if membership level is free)
billing_countrybilling country of the new member (2-digit ISO country code)Conditional (No if membership level is free)
credit_numberNew member's credit card numberConditional (No if membership level is free)
exp_monthExpiration month of the new member's credit card (2 digits)Conditional (No if membership level is free)
exp_yearExpiration year of the new member's credit card (4 digits)Conditional (No if membership level is free)
security_codeSecurity code (CVV) of the new member's credit cardConditional (No if membership level is free)
shipping_same_as_billingThis can be set to YES or NO. If set to YES you do not need to provide shipping address information. NO is the default value.Conditional (No if membership level is free)
shipping_methodShipping method code of the shipping method you want to apply to the order. You can find shipping method codes on the shipping methods screen in MemberMouse.Conditional (No if membership level is free or shipping address is the same as billing address)
shipping_addressshipping address of the new memberConditional (No if membership level is free or shipping address is the same as billing address)
shipping_cityshipping city of the new memberConditional (No if membership level is free or shipping address is the same as billing address)
shipping_stateshipping state of the new memberConditional (No if membership level is free or shipping address is the same as billing address)
shipping_zipshipping zip code of the new memberConditional (No if membership level is free or shipping address is the same as billing address)
shipping_countryshipping country of the new member (2-digit ISO country code)Conditional (No if membership level is free or shipping address is the same as billing address)
affiliate_idAffiliate ID to create with the orderNo
sub_affiliate_idSub-affiliate ID to credit with the orderNo
coupon_codeValid coupon code that you want applied to the orderNo
custom_field_[ID#]You can pass custom field data to the API by passing one or more parameters in the form custom_field_[ID#] where [ID#] would be replaced with the ID of the custom field as defined in MemberMouse. For example, if the custom field ID is 4, then you would pass data for that custom field by including the parameter custom_field_4.No


Response Codes


  • 200 - Success

  • 409 - Unable to create new member



Response Data


ParameterDescription
member_idThe ID of the new member in MemberMouse
emailThe new member's email
usernameThe new member's username
passwordThe new member's password
confirmation_urlThe URL for the confirmation page associated with the purchase. It has a transaction key attached to it so that MemberMouse SmartTags will work on this confirmation page.