Extend User

Extend user

Extend a membership will set the renewal date to one year from the current date and will set the user status to ‘Active’.

HTTP Response Values

    HTTP - 200 - Successful renewal
    HTTP - 404 - User Id supplied could not be found

[PATCH] /v2/users/{{identifier}}}/renew/

Route Parameter	Description
identifier	The identifier of the user - use lookup Apis, to get User Id

Extending a membership is done by PATCHing to the following JSON body to the endpoint:

{
    "RenewDate" : {{UTC Date Time}}}
}

Field	Description
RenewDate	UTC Date Time (optional - defaults to a year from now)

A successful response looks like:

{
    "ResultDetails": "User subscription renewed successfully",
    "MemberUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
     "User": {
        "RenewalDate": "2025-05-27",
        "API": "Members",
        "JoinDate": "2024-04-25",
        "loginUrl": "https://test.myezrewards.com/slug??iframe=vgnppl6vhJpUq1q2EaPV",
        "level": "Basic",
        "LastName": "lastName",
        "Status": "Active",
        "FirstName": "FirstName",
        "EmailAddress": "email@ez-loyalty.com",
        "identifier": 15006401
    }
}