Skip to navigation

List the alterations available for a membership card

Given a valid membership card, lists the renewals the member may buy for it — never an upgrade, a cancel or an extend, for now; cached up to 5 minutes — as products a storefront can render and add to a cart. The response is exactly what GET /api/member/alterations returns to a logged-in member; only the auth and the input differ. Name the membership by its card (cardNumber + membershipCode), or — for a member looked up with GET /api/members — by email + membershipNumber, resolved server-side the same way the member route resolves its own. Business Central decides which options apply and what each costs; each option is returned as the Medusa MEMBERSHIP_RENEW product that sells it, priced at the amount BC quoted rather than at the catalog price. Add one with a MEMBERSHIP_RENEW cart line, passing the same card number, or the same email + membershipNumber with this token. Because the response describes a named person’s membership and prices an offer against it, this endpoint requires a bearer access token in the Authorization header, in addition to the x-entria store header used by every endpoint. Obtain a token from POST /oauth/token; it must have been issued for the same store as this request.

Authentication

AuthorizationBearer

OAuth client token, for a partner backend only. A short-lived access token for endpoints that return personal data about any member. Obtain one from POST /oauth/token (RFC 7523 JWT-bearer), signing the assertion with the private key of the key pair registered for your store. Sent as Authorization: Bearer <token>. This is separate from the x-entria store header, which is still required.

Headers

x-entriastringRequired

Identifies which store this request is for. Required on every store-scoped route. It is not authentication and not a secret — it grants no privileges and is safe to send from a browser. You receive the value once your Entria backend has been created and configured. Missing header returns 400; an unknown store returns 404.

Query parameters

cardNumberstringOptional>=1 character

The membership card number printed on or encoded on the card. With membershipCode; or send email + membershipNumber instead.

membershipCodestringOptional
The membership type code the card is expected to belong to.
emailstringOptional>=1 character

The member’s email, as passed to GET /api/members. With membershipNumber.

membershipNumberstringOptional>=1 character

One of that member’s memberships, from GET /api/members. With email.

localestringOptional

BCP 47 locale code (e.g. da-DK, en-US). Defaults to DEFAULT_LOCALE env binding.

Response

The alteration options BC offers for this card, as MEMBERSHIP_RENEW products. An empty array means the membership currently has none.

skustring or null
titlestring
descriptionstring
handlestring
medialist of objects
pricedouble or null
basePricedouble or null
subscriptionboolean or null
membershipLegalTextstring or null
lifecycleActionstring
addonobject or nullOptional
validFromstring or nullOptional
validUntilstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error