GET api/Subscription/Plans

Get list of subscription plans

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of SubscriptionPlanModel

Name	Description	Type	Additional information
Id	Subscription Plan ID	globally unique identifier	None.
Prices	List of prices	Collection of SubscriptionPlanPriceModel	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:

[
  {
    "Id": "35ca6bb8-1856-423f-9350-f9db3cd8d94a",
    "Prices": [
      {
        "Id": "272ee868-58bd-4c47-a9a7-fc10d3b45ee9",
        "Renewal": 0,
        "Active": true,
        "BasePrice": 3.1,
        "VendorProductIds": [
          {
            "VendorProductId": "sample string 1",
            "VendorPriceId": "sample string 2"
          },
          {
            "VendorProductId": "sample string 1",
            "VendorPriceId": "sample string 2"
          }
        ]
      },
      {
        "Id": "272ee868-58bd-4c47-a9a7-fc10d3b45ee9",
        "Renewal": 0,
        "Active": true,
        "BasePrice": 3.1,
        "VendorProductIds": [
          {
            "VendorProductId": "sample string 1",
            "VendorPriceId": "sample string 2"
          },
          {
            "VendorProductId": "sample string 1",
            "VendorPriceId": "sample string 2"
          }
        ]
      }
    ],
    "Name": "sample string 2",
    "MaxStorage": 3,
    "MaxFileSize": 4,
    "MaxVillages": 5,
    "MaxVillagers": 6,
    "MaxJournalPhotos": 7,
    "PremiumFeatures": 0,
    "Active": true,
    "Tier": 9
  },
  {
    "Id": "35ca6bb8-1856-423f-9350-f9db3cd8d94a",
    "Prices": [
      {
        "Id": "272ee868-58bd-4c47-a9a7-fc10d3b45ee9",
        "Renewal": 0,
        "Active": true,
        "BasePrice": 3.1,
        "VendorProductIds": [
          {
            "VendorProductId": "sample string 1",
            "VendorPriceId": "sample string 2"
          },
          {
            "VendorProductId": "sample string 1",
            "VendorPriceId": "sample string 2"
          }
        ]
      },
      {
        "Id": "272ee868-58bd-4c47-a9a7-fc10d3b45ee9",
        "Renewal": 0,
        "Active": true,
        "BasePrice": 3.1,
        "VendorProductIds": [
          {
            "VendorProductId": "sample string 1",
            "VendorPriceId": "sample string 2"
          },
          {
            "VendorProductId": "sample string 1",
            "VendorPriceId": "sample string 2"
          }
        ]
      }
    ],
    "Name": "sample string 2",
    "MaxStorage": 3,
    "MaxFileSize": 4,
    "MaxVillages": 5,
    "MaxVillagers": 6,
    "MaxJournalPhotos": 7,
    "PremiumFeatures": 0,
    "Active": true,
    "Tier": 9
  }
]

application/xml, text/xml

Sample:

<ArrayOfSubscriptionPlanModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <SubscriptionPlanModel>
    <Active>true</Active>
    <MaxFileSize>4</MaxFileSize>
    <MaxJournalPhotos>7</MaxJournalPhotos>
    <MaxStorage>3</MaxStorage>
    <MaxVillagers>6</MaxVillagers>
    <MaxVillages>5</MaxVillages>
    <Name>sample string 2</Name>
    <PremiumFeatures>None</PremiumFeatures>
    <Tier>9</Tier>
    <Id>35ca6bb8-1856-423f-9350-f9db3cd8d94a</Id>
    <Prices>
      <SubscriptionPlanPriceModel>
        <Active>true</Active>
        <BasePrice>3.1</BasePrice>
        <Id>272ee868-58bd-4c47-a9a7-fc10d3b45ee9</Id>
        <Renewal>None</Renewal>
        <VendorProductIds>
          <SubscriptionPlanPriceProductModel>
            <VendorPriceId>sample string 2</VendorPriceId>
            <VendorProductId>sample string 1</VendorProductId>
          </SubscriptionPlanPriceProductModel>
          <SubscriptionPlanPriceProductModel>
            <VendorPriceId>sample string 2</VendorPriceId>
            <VendorProductId>sample string 1</VendorProductId>
          </SubscriptionPlanPriceProductModel>
        </VendorProductIds>
      </SubscriptionPlanPriceModel>
      <SubscriptionPlanPriceModel>
        <Active>true</Active>
        <BasePrice>3.1</BasePrice>
        <Id>272ee868-58bd-4c47-a9a7-fc10d3b45ee9</Id>
        <Renewal>None</Renewal>
        <VendorProductIds>
          <SubscriptionPlanPriceProductModel>
            <VendorPriceId>sample string 2</VendorPriceId>
            <VendorProductId>sample string 1</VendorProductId>
          </SubscriptionPlanPriceProductModel>
          <SubscriptionPlanPriceProductModel>
            <VendorPriceId>sample string 2</VendorPriceId>
            <VendorProductId>sample string 1</VendorProductId>
          </SubscriptionPlanPriceProductModel>
        </VendorProductIds>
      </SubscriptionPlanPriceModel>
    </Prices>
  </SubscriptionPlanModel>
  <SubscriptionPlanModel>
    <Active>true</Active>
    <MaxFileSize>4</MaxFileSize>
    <MaxJournalPhotos>7</MaxJournalPhotos>
    <MaxStorage>3</MaxStorage>
    <MaxVillagers>6</MaxVillagers>
    <MaxVillages>5</MaxVillages>
    <Name>sample string 2</Name>
    <PremiumFeatures>None</PremiumFeatures>
    <Tier>9</Tier>
    <Id>35ca6bb8-1856-423f-9350-f9db3cd8d94a</Id>
    <Prices>
      <SubscriptionPlanPriceModel>
        <Active>true</Active>
        <BasePrice>3.1</BasePrice>
        <Id>272ee868-58bd-4c47-a9a7-fc10d3b45ee9</Id>
        <Renewal>None</Renewal>
        <VendorProductIds>
          <SubscriptionPlanPriceProductModel>
            <VendorPriceId>sample string 2</VendorPriceId>
            <VendorProductId>sample string 1</VendorProductId>
          </SubscriptionPlanPriceProductModel>
          <SubscriptionPlanPriceProductModel>
            <VendorPriceId>sample string 2</VendorPriceId>
            <VendorProductId>sample string 1</VendorProductId>
          </SubscriptionPlanPriceProductModel>
        </VendorProductIds>
      </SubscriptionPlanPriceModel>
      <SubscriptionPlanPriceModel>
        <Active>true</Active>
        <BasePrice>3.1</BasePrice>
        <Id>272ee868-58bd-4c47-a9a7-fc10d3b45ee9</Id>
        <Renewal>None</Renewal>
        <VendorProductIds>
          <SubscriptionPlanPriceProductModel>
            <VendorPriceId>sample string 2</VendorPriceId>
            <VendorProductId>sample string 1</VendorProductId>
          </SubscriptionPlanPriceProductModel>
          <SubscriptionPlanPriceProductModel>
            <VendorPriceId>sample string 2</VendorPriceId>
            <VendorProductId>sample string 1</VendorProductId>
          </SubscriptionPlanPriceProductModel>
        </VendorProductIds>
      </SubscriptionPlanPriceModel>
    </Prices>
  </SubscriptionPlanModel>
</ArrayOfSubscriptionPlanModel>