GET /v2/memberships/b2b/checkout/validate
Gets the updated pricing and dates prior to membership checkout.
Input
action: Required. The membership action that is being performed.
- Possible values: MembershipPurchase, MembershipRenewal, MembershipUpgrade, MembershipDowngrade, MembershipCancel, MembershipPostTermRenewal, MembershipRejoin, MembershipRenewalUpgrade, MembershipPostTermRenewalUpgrade, MembershipRejoinUpgrade, MembershipPostTermRenewalDowngrade, MembershipRejoinDowngrade, MembershipRenewalDowngrade
- NOTE: To find out which values are applicable for a specific membership, use the eligible options API.
levelId: optional. The membership level ID that is associated with the membership that is to be checked out.
offeringId: optional. The membership offering that is being checkout out.
pricepointId: optional. The pricepoint ID tied to the membership offering.
membershipId: optional. The ID of an existing membership.
For actions other than MembershipPurchase, the membershipId is required
Returns
Returns a MembershipCheckoutValidationResult object. Throws a MEMBERSHIPID_DNE if the membership action is anything other than MembershipPurchase and membershipId is not passed.
Sample Request:
HEADERS:
x-acme-session: XXXX
x-acme-api-version: 1
Content-Type: application/json
Field | Type | Description | Notes |
|---|---|---|---|
expirationDate | String (ISO8601) | the expiration date computed by the rules engine | |
startDate | String (ISO8601) | the start date computed by the rules engine | |
transactionDate | String (ISO8601) | ||
retailPrice | Double | ||
price | Double | The price computed by the rules engine. | |
| now | String (ISO8601) | ||
| externalMembership | boolean |
1 2 3 4 5 6 7 8 9 | { "expirationDate": "2017-07-06T20:13:29-07:00", "startDate": "2016-07-06T20:13:29-07:00", "transactionDate": "2016-07-06T20:13:29-07:00", "retailPrice": 150, "price": 120, "now": "2016-07-06T20:13:29-07:00", "externalMembership" : false} |