Skip to content

Renew User

lsambridge edited this page Oct 6, 2026 · 9 revisions

Renew user

Renewing a subscription will set the renewal date to the supplied date (by default one year from the current date, less one day) and will set the user status to ‘Active’. Either an EmailAddress or PartnerMemberId must be specified to identify the user that should be renewed.

HTTP Response Values

    HTTP - 200 - Successful renewal
    HTTP - 404 - Either the email address or the Partner User Id used could not be found (the response body text is ```400- NOT OK```)

[PATCH] /v2/users/renew

A renewal of a membership is created by PATCHing to the following JSON body to the endpoint:

{
    "EmailAddress": "email@ez-loyalty.com",
    "PartnerMemberId" : "1234",
    "RenewDate" : "2027-05-26T00:00:00Z"
}
Field Description
EmailAddress User's email address
PartnerMemberId Your unique identifier for this user (string) - takes precedence over EmailAddress if both are supplied
RenewDate UTC Date Time (optional - defaults to a year from now, less one day)

A successful response looks like:

{
    "RenewalDate": "2027-05-26",
    "API": "Members",
    "JoinDate": "2026-05-27",
    "LoginUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "HubLoginUrl": "https://landing.myezrewards.com/client/default/?iframe=ffe2SLrm4qrvyulsci",
    "Level": "Basic",
    "LastName": "LastName",
    "Status": "Active",
    "FirstName": "FirstName",
    "EmailAddress": "email@ez-loyalty.com",
    "Identifier": 15006401,
    "ExternalMemberId": null,
    "OrgUnits": null,
    "Action": null
}

Clone this wiki locally