curl --request GET \
--url https://api.letsdothis.com/v0/membership-policies/{policyId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.letsdothis.com/v0/membership-policies/{policyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.letsdothis.com/v0/membership-policies/{policyId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"schemeId": "<string>",
"offeringId": "<string>",
"offeringPriceId": "<string>",
"price": {
"id": "<string>",
"offeringId": "<string>",
"isCurrent": true,
"createdAt": "<string>",
"purchaseType": "ONE_TIME",
"amount": {
"value": 123,
"currencyCode": "<string>"
},
"fee": {
"value": 123,
"currencyCode": "<string>"
},
"orderProcessingFee": {
"value": 123,
"currencyCode": "<string>"
},
"total": {
"value": 123,
"currencyCode": "<string>"
},
"billingInterval": "day",
"billingIntervalCount": 123,
"detailsAvailable": true,
"retiredAt": "<string>"
},
"offering": {
"id": "<string>",
"schemeId": "<string>",
"tier": {
"id": "<string>",
"title": "<string>",
"description": "<string>"
},
"plan": {
"id": "<string>",
"title": "<string>",
"numberOfAdults": 123,
"numberOfChildren": 123,
"maxChildAge": 123,
"maxTotalMembers": 123,
"primaryMemberType": "<string>",
"enforceAgeLimits": true,
"description": "<string>"
},
"benefits": [
{
"title": "<string>",
"type": "PRICE_ADJUSTMENT",
"restrictions": {
"eventIds": [
"<string>"
],
"eventOccurrenceIds": [
"<string>"
],
"raceIds": [
"<string>"
],
"ticketSlugs": [
"<string>"
],
"bookingItemIds": [
"<string>"
]
},
"adjustmentType": "ABSOLUTE_PRICE",
"amount": {
"value": 123,
"currencyCode": "<string>"
},
"percentage": 123,
"maxUses": 123,
"discountAppliesToBookingFee": true,
"resetsOnRenewal": true
}
],
"benefitsMarkdown": "<string>"
},
"billingCard": {
"last4": "<string>"
},
"billingCardState": "NOT_REQUESTED",
"status": "ACTIVE",
"entitled": true,
"paymentFailed": true,
"blockingReasons": [
"ORGANIZER_OFFBOARDED"
],
"frozenReason": "PAYMENT_FAILED",
"expiresAt": "<string>",
"renewalDate": "<string>",
"cancelAtDate": "<string>",
"autoRenew": true
}{
"code": "MEMBERSHIP_INVALID_REQUEST",
"statusCode": 400,
"message": "<string>"
}{
"code": "MEMBERSHIP_RESOURCE_NOT_FOUND",
"statusCode": 404,
"message": "<string>"
}Get a membership dashboard
Returns a membership policy with its price, plan, benefits and status.
How to use it
- Check that your signed-in member holds this policy before calling.
- Set
includeCard=trueto add the last four digits of the card, when there is one.
curl --request GET \
--url https://api.letsdothis.com/v0/membership-policies/{policyId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.letsdothis.com/v0/membership-policies/{policyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.letsdothis.com/v0/membership-policies/{policyId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"schemeId": "<string>",
"offeringId": "<string>",
"offeringPriceId": "<string>",
"price": {
"id": "<string>",
"offeringId": "<string>",
"isCurrent": true,
"createdAt": "<string>",
"purchaseType": "ONE_TIME",
"amount": {
"value": 123,
"currencyCode": "<string>"
},
"fee": {
"value": 123,
"currencyCode": "<string>"
},
"orderProcessingFee": {
"value": 123,
"currencyCode": "<string>"
},
"total": {
"value": 123,
"currencyCode": "<string>"
},
"billingInterval": "day",
"billingIntervalCount": 123,
"detailsAvailable": true,
"retiredAt": "<string>"
},
"offering": {
"id": "<string>",
"schemeId": "<string>",
"tier": {
"id": "<string>",
"title": "<string>",
"description": "<string>"
},
"plan": {
"id": "<string>",
"title": "<string>",
"numberOfAdults": 123,
"numberOfChildren": 123,
"maxChildAge": 123,
"maxTotalMembers": 123,
"primaryMemberType": "<string>",
"enforceAgeLimits": true,
"description": "<string>"
},
"benefits": [
{
"title": "<string>",
"type": "PRICE_ADJUSTMENT",
"restrictions": {
"eventIds": [
"<string>"
],
"eventOccurrenceIds": [
"<string>"
],
"raceIds": [
"<string>"
],
"ticketSlugs": [
"<string>"
],
"bookingItemIds": [
"<string>"
]
},
"adjustmentType": "ABSOLUTE_PRICE",
"amount": {
"value": 123,
"currencyCode": "<string>"
},
"percentage": 123,
"maxUses": 123,
"discountAppliesToBookingFee": true,
"resetsOnRenewal": true
}
],
"benefitsMarkdown": "<string>"
},
"billingCard": {
"last4": "<string>"
},
"billingCardState": "NOT_REQUESTED",
"status": "ACTIVE",
"entitled": true,
"paymentFailed": true,
"blockingReasons": [
"ORGANIZER_OFFBOARDED"
],
"frozenReason": "PAYMENT_FAILED",
"expiresAt": "<string>",
"renewalDate": "<string>",
"cancelAtDate": "<string>",
"autoRenew": true
}{
"code": "MEMBERSHIP_INVALID_REQUEST",
"statusCode": 400,
"message": "<string>"
}{
"code": "MEMBERSHIP_RESOURCE_NOT_FOUND",
"statusCode": 404,
"message": "<string>"
}Authorizations
Path Parameters
Query Parameters
Response
The policy with its price, plan, benefits and status.
ACTIVE grants access. CANCELLED_RUNNING has renewal canceled but keeps access until the policy ends. FROZEN is not entitled for now but has not lapsed: with frozenReason PAYMENT_FAILED, a renewal payment failed; with a null frozenReason, the renewal payment is still pending rather than failed, and the membership is active again once it is paid. ENDED has ended, including after Stripe cancels the subscription for non-payment, or is blocked for another reason. Use entitled for access decisions.
ACTIVE, CANCELLED_RUNNING, FROZEN, ENDED Whether the member has access now. A failed renewal does not remove access before the paid period ends, nor before the end of any renewal access grace the scheme sets. Without one, access can continue briefly after the paid period while renewal payment is pending. Other blockers can deny access immediately.
True once a renewal payment has failed, and still true after a membership ends that way. Access continues until the paid period ends, and through any renewal access grace the scheme sets, so this can be true while entitled is still true. After that the status is FROZEN while the renewal is still being retried, or ENDED once Stripe has cancelled the subscription; on a scheme that sets a renewal access grace, even of 0 days, no sooner than 7 days after the paid period ends.
When the subscription next renews, which is when its current billing period ends. It is the next renewal even when that renewal is free, as when a scheme gives late joiners their next period free, so it can be earlier than the first renewal the member pays for. Null when the policy has no subscription. autoRenew and cancelAtDate say whether it will renew.
Was this page helpful?

