Membership

A Membership represents an entered membership, that has a MembershipType. A Membership can e.g. be used to get benefits or to get access to the museum.

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"bd4a0997-39db-41d9-883a-cdfa83e2101f"
createdAtstringTimestamp when the membership was created"2024-01-15T09:30:00.000Z"
updatedAtstringTimestamp when the membership was last updated"2024-01-15T09:30:00.000Z"
validFromstring (YYYY-MM-DD)nullDate for when the membership starts2024-04-05
validTostring (YYYY-MM-DD)nullDate for when the membership will expire. Including the date2025-04-05
activebooleanWhether the membership is valid or not. This is a convenience property that is calculated from validFrom and validTotrue
autoRenewbooleanfalseShows whether the membership will be auto renewedtrue
autoRenewedbooleanfalseWhether this membership was created by an automatic renewaltrue
previousMembershipIdstring (UUIDv4)nullId of the previous membership this one renews. If set, this membership is a renewal"bd4a0997-39db-41d9-883a-cdfa83e2101f"
renewalbooleanfalseWhether this membership is a renewal. Convenience property derived from previousMembershipIdtrue
preferredRenewalMembershipTypeIdstring (UUIDv4)nullThis field can be used to determine which membership type should be used for the renewal"bd4a0997-39db-41d9-883a-cdfa83e2101f"
membershipTypeobjectNested membership type. This is a subset: id, title, cycle, price, optional renewalPrice (only when renewal price is enabled), and origin (the membership's origin, not a field on MembershipType itself).{ "id": "...", "title": "Yearly", "cycle": "YEARLY", "price": 54000, "origin": "WEB" }
customerIdstring (UUIDv4)A reference to the Customer who holds the membership"bd4a0997-39db-41d9-883a-cdfa83e2101f"
secondaryCustomerIdstring (UUIDv4)nullA reference to a secondary Customer on the membership (e.g. partner memberships)"bd4a0997-39db-41d9-883a-cdfa83e2101f"
payerIdstring (UUIDv4)nullA reference to the Customer who paid for the membership, when someone other than the holder did (e.g. a parent paying for a child's membership). See Holder, partner and payer below"bd4a0997-39db-41d9-883a-cdfa83e2101f"
orderOrdernullThe order this membership was purchased on, if any. Includes id and salesChannelType{ "id": "...", "salesChannelType": "WEB" }
changeLogarray[]A list of MembershipChangeLogItem. This will only be available on /memberships/:membershipId[]
extensionsarray[]A list of MembershipExtension: the extensions chosen on this membership, in the membership type's order. Only extensions with at least one chosen product are listed[]

Holder, partner and payer

A membership can refer to up to three customers:

  • customerId: the holder, who uses the membership.
  • secondaryCustomerId: the partner on a partner membership.
  • payerId: the customer who paid, when someone other than the holder did. In Loby, the payer's customer page lists these memberships under Paid.

From a customer, Get Customer and List Customers return memberships, the memberships the customer holds, and paidMemberships, the memberships the customer paid for. Memberships where the customer is only the partner are not listed on the customer. List Memberships returns every membership with all three references, but its filter cannot select by them.

Set the payer with payerId on Create Membership. Change or remove it with payerId on Update Membership. Renewals made in Loby keep the payer. Create Membership does not copy it from previousMembershipId, so pass payerId again when you create a renewal.

Membership Extension

A MembershipExtension is an extension on the membership type (for example "Castles") with the products the member chose from it. An extension can include a number of units in the membership price. The cheapest chosen units are the included ones.

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier of the extension"8c1f2a3e-5b6d-4e7f-9a0b-1c2d3e4f5a6b"
titlestring""Title of the extension"Castles"
descriptionstring""Description of the extension"Choose the castles you want access to"
includedQuantitynumber0How many units the extension includes in the membership price1
quantitynumberTotal units chosen across the extension's products2
paidQuantitynumberChosen units that are not included (quantity minus the included units)1
productsarray[]A list of MembershipExtensionProduct[]

Membership Extension Product

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Id of the chosen product"2f6e4b1a-9c3d-4a8e-b7f5-0d1c2e3f4a5b"
titlestring""Title shown for the product in the extension, falling back to the product name"Kronborg"
descriptionstring""Description shown for the product in the extension, falling back to the product description""
quantitynumberUnits of this product chosen1
includedQuantitynumberUnits of this product included in the membership price1
paidQuantitynumberUnits of this product that are not included0
pricenumber0The product's current price per unit in lowest unit (cents for EUR, øre for DKK). This is not necessarily what the member paid. Look at the order for that5000
Copy
"extensions": [ { "id": "8c1f2a3e-5b6d-4e7f-9a0b-1c2d3e4f5a6b", "title": "Castles", "description": "", "includedQuantity": 1, "quantity": 2, "paidQuantity": 1, "products": [ { "id": "2f6e4b1a-9c3d-4a8e-b7f5-0d1c2e3f4a5b", "title": "Kronborg", "description": "", "quantity": 1, "includedQuantity": 1, "paidQuantity": 0, "price": 5000 }, { "id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d", "title": "Frederiksborg", "description": "", "quantity": 1, "includedQuantity": 0, "paidQuantity": 1, "price": 5000 } ] } ]

Membership Change Log Item

A MembershipChangeLogItem represents a change log item for a membership.

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"e4ee88c7-c5a1-4cf2-8794-741b7f1e2ad5"
datestring (ISO 8601)Timestamp of when the change occurred"2025-02-07 12:02:56.048Z"
typestringType of change that occurred. Can be SET_AUTO_RENEW, SET_ORIGINAL, etc."SET_AUTO_RENEW"
propsobject{}Properties that were changed in this log entry{ "autoRenew": false }
actorobjectnullInformation about who made the change{ "customerId": "b4495211-9623-41ae-bd6a-9c5aa67c6344" }
‹ Previous
Membership Type
Next ›
Giftcard