Get Upgrade Options | NaviPartner | NP Retail API Documentation

1 import requests 2 3 url = "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./membership/cdef7890-abcd-0123-1234-567890abcdef/upgradeOptions" 4 5 headers = {"x-np-api-key": "<NaviPartner API Key>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "membership": { 3 "autoRenewalActivated": false, 4 "blocked": false, 5 "communityCode": "RIVERLAND", 6 "issueDate": "2024-09-17", 7 "membershipCode": "GOLD", 8 "membershipId": "cdef7890-abcd-0123-1234-567890abcdef", 9 "membershipNumber": "MS-DEMO-00152", 10 "options": [ 11 { 12 "optionId": "21111111-abcd-1234-5678-1234567890ac", 13 "itemNumber": "UPGRADE-12346", 14 "lifecycleAction": "upgrade", 15 "description": "Upgrade to PLATINUM Membership for the remaining period", 16 "targetMembershipCode": "PLATINUM", 17 "periodStart": "2024-10-08", 18 "periodEnd": "2025-09-16", 19 "amount": 80, 20 "amountInclVat": 100, 21 "memberCardinality": 2, 22 "presentationOrder": 0 23 } 24 ], 25 "customerNumber": "D000188", 26 "validFromDate": "2024-09-17", 27 "validUntilDate": "2025-09-16" 28 } 29 }

Retrieve a list of available upgrade options for a membership. Each upgrade option is represented by an itemNumber, which includes predefined details such as the upgraded benefits and any pricing adjustments. The optionId returned from this endpoint can be used as a parameter in the upgradeMembership endpoint to execute the upgrade.

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

membershipIdUUIDRequired

Unique identifier for a membership.

Response

This endpoint returns an object.

membershipobject

The MembershipLifecycleEntriesDTO is a composite type representing the timeline of a membership. It includes details when the membership was activated, renewed, upgraded, or extended.

Authentication

Path parameters

Headers

Response