Membership Object

idA unique ID for this membership. Required
Read Only
importIdA unique value that does not change.Required
Read Only
membershipStandingThe standing of the membership (active, lapsed)Required
membershipJoinedDateThe date the current membership term began. Optional


The date the current membership term began.Optional
membershipExpirationDateThe date the current membership term will expire.Required
acmeMembershipNumberThe membership number generated by ACME upon creation.Read Only
externalMembershipIdCorresponds to an external Membership Number. Can be specified in the Checkout API for a Membership purchase.Read Only
externalIdID from external source (such as the CRM system). Must be unique per membership version. Can be specified in the Checkout API for a Membership purchase.Read Only
membershipCategoryMembership Level NameRead Only
categoryIdMembership Level IdRead Only
offeringNameMembership Offering NameRead Only
offeringIdMembership Offering IDRead Only
pricePointIdPrice Point ID for the membership purchaseRead Only
isGiftBoolean to denote if the membership purchase is a giftRead Only
auxiliaryMembershipBoolean to denote auxiliary membershipRead Only
membershipLevelCollectionNameName of the Auxiliary group, if applicableRead Only
membershipLevelCollectionIdID of the Auxiliary group, if applicableRead Only
cardholders[]The list of cardholders for this membership.Required
Must send at least the primary card
cardholders[x].idMembership Cardholder IDRequired
Read Only
cardholders[x].constituentImportIdThe Constituent Import ID for the customer associated with the cardholder. 
  • Required for existing cardholders that are customers. Ensure this matches the correct customer record.
  • When not provided, a new customer will be created and associated to the membership. Use this for new cardholders on a membership.
< Depends on if new or existing cardholder
cardholders[x].customerIdThe ACME Database ID of the CustomerRead Only
cardholders[x].cardTypeThe type of card holder, one of (primary or secondary)Required
Case sensitive (must be 'primary' or 'secondary')
cardholders[x].cardStatusValid card status are:
  • new
  • active
  • dropped 
  • lapsed
  • noMembership
  • replaced
cardholders[x].expirationDateCardholder expiration date. Validation will ensure that is is not after the membership expiration dateRequired

cardholders[x].startDateCardholder start date.Optional
cardholders[x].firstNameThe member's first name.Optional**
cardholders[x].lastNameThe member's last name.Optional**
cardholders[x].nameThe name on the card.
  • Optional for members that are customers - will be populated by First Name + Last Name if not provided.
  • Required for Name on Card only cardholders.
< Depends on type of cardholder
cardholders[x].emailThe member's email address.Optional**
cardholders[x].phoneNumberThe member's phone number.Optional**
cardholders[x].addressIdID of the member's address.Optional**
cardholders[x].streetAddress1The member's street address.Optional**
cardholders[x].streetAddress2The member's extended street address.Optional**
cardholders[x].cityThe member's city.Optional**
cardholders[x].stateThe member's state.Optional**
cardholders[x].zipCodeThe member's ZIP or Postal Code.Optional**
cardholders[x].countryThe member's country.Optional**
cardholders[x].membershipIdThe ID of the membership.Read Only
cardholders[x].customerExternalIdCustomer ID from external source (e.g. CRM system)Optional
cardholders[x].acmeCustomerNumberThe Customer Number that ACME assigns.Read Only
cardholders[x].cardImportIdThe import id for this card.Read Only
cardholders[x].barcodeThe value on the barcode.Optional
cardholders[x].acmeBarcodeACME's barcode for the cardholderRead Only
cardholders[x].orgNamethe name of the organization when this membership is an organization membership.Read Only
cardholders[x].orgNameOrganization NameRead Only
cardholders[x].orgIdOrganization IDRead Only
cardholders[x].deceasedBoolean value to denote deceasedOptional
cardholders[x].primaryCardBoolean value to denote the card is the primaryRead Only
cardholders[x].solicitationCodesList of Solicitation messages for the membersRead Only
cardholders[x].printCountTotal Membership card printedRead Only
cardholders[x].printStatusLimit events to those that support the specified print status. Valid print status are:
  • printed
  • notPrinted
  • doNotPrint
  • lost
Read Only
cardholders[x].orgImportIdorganization ID from importRead Only
cardholders[x].excludeCardOnMemberCreationboolean value to exclude card while member creationRead Only
entitlements[ ]List of entitlements. Fields is only populated if entitlements were imported with the membership
entitlements[x].idUnique ID for this entitlement. (READ ONLY)
entitlements[x].benefitThe name of the benefit.
entitlements[x].memberIdMembership ID
entitlements[x].visitorIdn/a. ACME internal only field - do not use
entitlements[x].countThe number of these benefits the member has.
entitlements[x].importIdThe import id for this entitlement.
entitlements[x].commentA comment about the benefit.
organizationIdOrganization Id

organizationNameOrganization Name
updatedOnUpdated on dateRead Only
updatedByUser id that last updated the record, matching the users the tenant has.  Will show the ACME system user in the case the operation was done by ACME (ie - changing the standing from active to lapsed)Read Only

** These optional fields must be provided to retain their current value.

Membership Info Object

membershipCategoryId (Required)
The published ID of the selected membership category
membershipOfferingId (Required)
The ID of the selected membership offering


pricePointId (Required)
The ID of the selected price point
membershipCards[ ] (Required for checkout: Primary Cardholder)

A list of membership cards. The number of cards may not exceed the limit specified on the offering in backoffice. Requires one primary cardholder with first name, last name, and one of: email, address, or phone number. 

For a full list of membership card fields see Membership Cards. Do not include a constituent import id field unless a matching customer already exists. 

isGift (Boolean)
If the membership is a gift, mark as true. If so, gifterInfo is required.
  • true
  • false
gifterInfo (Required when isGift is true)

A Customer object representing the gift giver. 

You may either search for an existing customer and use that object, or create a new customer for the gifter.  

In order to create a new customer you must populate Customer Source, First, Last and one of (email, address, phone).  


If the membership is a gift, setting this flag will send a correspondence to the gift recipient.

Setting the flag to False will result in the email going to the gift giver

Setting the flag to True will result in the email going to the gift recipient (This is the default behavior if no flag value is set)

  • true
  • false

If the membership is a gift, the gift giver can add a message for the recipient which appears on the member card email, if configured to send in Backoffice.

Note: The gift membership is only used in sending the email at the time of purchase and is not stored in ACME.

Donated in honor of your birthday! Hope you have a wonderful day.
isAutorenew (Boolean)

If the membership offering is configured as Auto Renew Optional, setting this flag to true will opt the member into Auto Renew and generate a subscription. 

The default value is false, which will not opt the user into Auto Renew and will not create a subscription.

  • true
  • false

Entitlement Result Object

POST /v2/b2c/entitlements/validate

valid (Boolean)
False means there is a violation in the shopping cart.
  • true
  • false
messages[ ]
List of short descriptions (string format) of violations.
results[ ]
List of detailed results of the validation
violations[ ] 
List of detailed descriptions (Entitlements Result Summary) of the violations