GET api/Subscription

Get details of user's current subscription

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

UserSubscriptionModel

Name	Description	Type	Additional information
UserSubscriptionPlanId	Subscription Plan ID	globally unique identifier	None.
UserSubscriptionPlanPriceId	Subscription Plan Price ID	globally unique identifier	None.
StartDate	Start Date of the user's subscription	date	None.
EndDate	End date of the user's subscription	date	None.
StripeCustomerId	User's Stripe Customer ID	string	None.
AutoRenewal	Whether or not user has auto renewal on (according to Adapty)	boolean	None.
Renewal	User's plan renewal	UserSubscriptionRenewal	None.
Name	Subscription Plan Name	string	None.
MaxStorage	Maximum aggregate storage	integer	None.
MaxFileSize	Maximum individual file size	integer	None.
MaxVillages	Max # of Villages	integer	None.
MaxVillagers	Max # of Villagers per Village	integer	None.
MaxJournalPhotos	Max # of Photos per Journal Entry	integer	None.
PremiumFeatures	Bitmask of premium features	PremiumFeatures	None.
Active	Whether or not the subscription plan is active (disabled plans should not be visible to the user unless it's the user's current plan)	boolean	None.
Tier	Subscription Tier	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "UserSubscriptionPlanId": "464fbce9-52f8-4715-8e48-04e35124e006",
  "UserSubscriptionPlanPriceId": "129c5ed6-2b0c-4280-882c-b1a3bba7ebe0",
  "StartDate": "2025-06-03T03:57:40.674+00:00",
  "EndDate": "2025-06-03T03:57:40.674+00:00",
  "StripeCustomerId": "sample string 5",
  "AutoRenewal": true,
  "Renewal": 0,
  "Name": "sample string 7",
  "MaxStorage": 8,
  "MaxFileSize": 9,
  "MaxVillages": 10,
  "MaxVillagers": 11,
  "MaxJournalPhotos": 12,
  "PremiumFeatures": 0,
  "Active": true,
  "Tier": 14
}

application/xml, text/xml

Sample:

<UserSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Active>true</Active>
  <MaxFileSize>9</MaxFileSize>
  <MaxJournalPhotos>12</MaxJournalPhotos>
  <MaxStorage>8</MaxStorage>
  <MaxVillagers>11</MaxVillagers>
  <MaxVillages>10</MaxVillages>
  <Name>sample string 7</Name>
  <PremiumFeatures>None</PremiumFeatures>
  <Tier>14</Tier>
  <AutoRenewal>true</AutoRenewal>
  <EndDate>2025-06-03T03:57:40.6743437+00:00</EndDate>
  <Renewal>None</Renewal>
  <StartDate>2025-06-03T03:57:40.6743437+00:00</StartDate>
  <StripeCustomerId>sample string 5</StripeCustomerId>
  <UserSubscriptionPlanId>464fbce9-52f8-4715-8e48-04e35124e006</UserSubscriptionPlanId>
  <UserSubscriptionPlanPriceId>129c5ed6-2b0c-4280-882c-b1a3bba7ebe0</UserSubscriptionPlanPriceId>
</UserSubscriptionModel>