PUT api/Subscription/Downgrade

Downgrade subscription by identifying villages and villagers to keep. Any village not in the villages list will be cancelled. Any villager not in the villagers list for a village will be Revoked.

Request Information

URI Parameters

None.

Body Parameters

DowngradeSubscriptionModel

Name	Description	Type	Additional information
ActiveVillages	List of Villages	Collection of DowngradeSubscriptionVillageModel	None.

Request Formats

application/json, text/json

Sample:

{
  "ActiveVillages": [
    {
      "VillageId": "28f5a5d2-a4c6-4c4a-b373-60bb39ebc971",
      "ActiveVillagers": [
        "d2651f41-f5e2-4a6a-b53a-6d508e65fb21",
        "f0a603eb-9619-4659-a21a-d6d19ea83b36"
      ]
    },
    {
      "VillageId": "28f5a5d2-a4c6-4c4a-b373-60bb39ebc971",
      "ActiveVillagers": [
        "d2651f41-f5e2-4a6a-b53a-6d508e65fb21",
        "f0a603eb-9619-4659-a21a-d6d19ea83b36"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<DowngradeSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <ActiveVillages>
    <DowngradeSubscriptionVillageModel>
      <ActiveVillagers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>d2651f41-f5e2-4a6a-b53a-6d508e65fb21</d4p1:guid>
        <d4p1:guid>f0a603eb-9619-4659-a21a-d6d19ea83b36</d4p1:guid>
      </ActiveVillagers>
      <VillageId>28f5a5d2-a4c6-4c4a-b373-60bb39ebc971</VillageId>
    </DowngradeSubscriptionVillageModel>
    <DowngradeSubscriptionVillageModel>
      <ActiveVillagers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>d2651f41-f5e2-4a6a-b53a-6d508e65fb21</d4p1:guid>
        <d4p1:guid>f0a603eb-9619-4659-a21a-d6d19ea83b36</d4p1:guid>
      </ActiveVillagers>
      <VillageId>28f5a5d2-a4c6-4c4a-b373-60bb39ebc971</VillageId>
    </DowngradeSubscriptionVillageModel>
  </ActiveVillages>
</DowngradeSubscriptionModel>

multipart/form-data

Sample:

Failed to generate the sample for media type 'multipart/form-data'. Cannot use formatter 'MultipartMediaTypeFormatter' to write type 'DowngradeSubscriptionModel'.

Response Information

Resource Description

Collection of VillageViewModel

Name	Description	Type	Additional information
Id	The unique ID of this Village:Villager mapping (For invitations, this is the Invitation ID)	globally unique identifier	None.
VillageId	Village's Unique ID	globally unique identifier	None.
VillagerId	Villager's Unique ID (For invitations, this will always be Guid.Empty)	globally unique identifier	None.
Members	Number of members in the village	integer	None.
Role	User's role in the village	UserVillageRole	None.
RoleName	User's role in the village, long form	string	None.
Features	The features which are enabled for the village	VillageFeatures	None.
OwnerId	Village Owner's ID	globally unique identifier	None.
IsDemoVillage	If true, the village is a demo village and can be reset	boolean	None.
BusinessId	For business villages, the ID of the business	globally unique identifier	None.
BusinessName	For Business villages, the name of the business	string	None.
BusinessRole	For business villages, the role of the user in the business		None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "4d889b04-0d12-492a-b5ad-a230d22f03fd",
    "VillageId": "902b4110-c10f-4a76-aef0-1dc3e440cb7d",
    "VillagerId": "3845f300-5ed1-45c5-9b38-14ce8ae3434a",
    "Members": 4,
    "Role": 0,
    "RoleName": "Revoked",
    "Features": 0,
    "OwnerId": "7b43b45b-9153-4e29-b39d-01a34cf2cc9a",
    "IsDemoVillage": true,
    "BusinessId": "1be16025-93e6-4340-a726-d7aa1f7e087d",
    "BusinessName": "sample string 7",
    "BusinessRole": 1,
    "CandidateId": "92466d13-eb07-453f-be1e-a79edb6a5e45",
    "TransferRequest": {
      "Id": "b269920b-065e-4652-900a-e21591b8a5a0",
      "CandidateId": "a7ebfbc4-1d0c-4962-ac23-28ffd2ae0726",
      "Candidate": "sample string 3",
      "RequestedBy": "sample string 4",
      "VillageId": "73961481-57c3-41c2-b72a-a961c0494d6b",
      "VillageName": "sample string 6"
    },
    "TotalFileSize": 8,
    "Subscription": {
      "MaxFileSize": 1,
      "MaxStorage": 2,
      "MaxJournalPhotos": 3,
      "PremiumFeatures": 0,
      "Cancelled": true,
      "SubscriptionStartDate": "2025-06-03T04:13:07.022+00:00",
      "ExpirationDate": "2025-06-03T04:13:07.022+00:00",
      "Expired": false,
      "MaxVillagers": 7
    },
    "Created": "2025-06-03T04:13:07.022+00:00",
    "Updated": "2025-06-03T04:13:07.022+00:00",
    "FirstName": "sample",
    "LastName": "string 13",
    "Name": "sample string 13",
    "DOB": "2025-06-03",
    "Address": {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Zip": "sample string 5",
      "Country": "sample string 6"
    },
    "TimeZone": "sample string 14"
  },
  {
    "Id": "4d889b04-0d12-492a-b5ad-a230d22f03fd",
    "VillageId": "902b4110-c10f-4a76-aef0-1dc3e440cb7d",
    "VillagerId": "3845f300-5ed1-45c5-9b38-14ce8ae3434a",
    "Members": 4,
    "Role": 0,
    "RoleName": "Revoked",
    "Features": 0,
    "OwnerId": "7b43b45b-9153-4e29-b39d-01a34cf2cc9a",
    "IsDemoVillage": true,
    "BusinessId": "1be16025-93e6-4340-a726-d7aa1f7e087d",
    "BusinessName": "sample string 7",
    "BusinessRole": 1,
    "CandidateId": "92466d13-eb07-453f-be1e-a79edb6a5e45",
    "TransferRequest": {
      "Id": "b269920b-065e-4652-900a-e21591b8a5a0",
      "CandidateId": "a7ebfbc4-1d0c-4962-ac23-28ffd2ae0726",
      "Candidate": "sample string 3",
      "RequestedBy": "sample string 4",
      "VillageId": "73961481-57c3-41c2-b72a-a961c0494d6b",
      "VillageName": "sample string 6"
    },
    "TotalFileSize": 8,
    "Subscription": {
      "MaxFileSize": 1,
      "MaxStorage": 2,
      "MaxJournalPhotos": 3,
      "PremiumFeatures": 0,
      "Cancelled": true,
      "SubscriptionStartDate": "2025-06-03T04:13:07.022+00:00",
      "ExpirationDate": "2025-06-03T04:13:07.022+00:00",
      "Expired": false,
      "MaxVillagers": 7
    },
    "Created": "2025-06-03T04:13:07.022+00:00",
    "Updated": "2025-06-03T04:13:07.022+00:00",
    "FirstName": "sample",
    "LastName": "string 13",
    "Name": "sample string 13",
    "DOB": "2025-06-03",
    "Address": {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Zip": "sample string 5",
      "Country": "sample string 6"
    },
    "TimeZone": "sample string 14"
  }
]

application/xml, text/xml

Sample:

<ArrayOfVillageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <VillageViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <DOB>2025-06-03T04:13:07.0222448+00:00</DOB>
    <FirstName>sample</FirstName>
    <LastName>string 13</LastName>
    <Name>sample string 13</Name>
    <TimeZone>sample string 14</TimeZone>
    <BusinessId>1be16025-93e6-4340-a726-d7aa1f7e087d</BusinessId>
    <BusinessName>sample string 7</BusinessName>
    <BusinessRole>Client</BusinessRole>
    <CandidateId>92466d13-eb07-453f-be1e-a79edb6a5e45</CandidateId>
    <Created>2025-06-03T04:13:07.0222448+00:00</Created>
    <Features>None</Features>
    <Id>4d889b04-0d12-492a-b5ad-a230d22f03fd</Id>
    <IsDemoVillage>true</IsDemoVillage>
    <Members>4</Members>
    <OwnerId>7b43b45b-9153-4e29-b39d-01a34cf2cc9a</OwnerId>
    <Role>Revoked</Role>
    <Subscription>
      <Cancelled>true</Cancelled>
      <ExpirationDate>2025-06-03T04:13:07.0222448+00:00</ExpirationDate>
      <MaxFileSize>1</MaxFileSize>
      <MaxJournalPhotos>3</MaxJournalPhotos>
      <MaxStorage>2</MaxStorage>
      <MaxVillagers>7</MaxVillagers>
      <PremiumFeatures>None</PremiumFeatures>
      <SubscriptionStartDate>2025-06-03T04:13:07.0222448+00:00</SubscriptionStartDate>
    </Subscription>
    <TotalFileSize>8</TotalFileSize>
    <TransferRequest>
      <Candidate>sample string 3</Candidate>
      <CandidateId>a7ebfbc4-1d0c-4962-ac23-28ffd2ae0726</CandidateId>
      <Id>b269920b-065e-4652-900a-e21591b8a5a0</Id>
      <RequestedBy>sample string 4</RequestedBy>
      <VillageId>73961481-57c3-41c2-b72a-a961c0494d6b</VillageId>
      <VillageName>sample string 6</VillageName>
    </TransferRequest>
    <Updated>2025-06-03T04:13:07.0222448+00:00</Updated>
    <VillageId>902b4110-c10f-4a76-aef0-1dc3e440cb7d</VillageId>
    <VillagerId>3845f300-5ed1-45c5-9b38-14ce8ae3434a</VillagerId>
  </VillageViewModel>
  <VillageViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <DOB>2025-06-03T04:13:07.0222448+00:00</DOB>
    <FirstName>sample</FirstName>
    <LastName>string 13</LastName>
    <Name>sample string 13</Name>
    <TimeZone>sample string 14</TimeZone>
    <BusinessId>1be16025-93e6-4340-a726-d7aa1f7e087d</BusinessId>
    <BusinessName>sample string 7</BusinessName>
    <BusinessRole>Client</BusinessRole>
    <CandidateId>92466d13-eb07-453f-be1e-a79edb6a5e45</CandidateId>
    <Created>2025-06-03T04:13:07.0222448+00:00</Created>
    <Features>None</Features>
    <Id>4d889b04-0d12-492a-b5ad-a230d22f03fd</Id>
    <IsDemoVillage>true</IsDemoVillage>
    <Members>4</Members>
    <OwnerId>7b43b45b-9153-4e29-b39d-01a34cf2cc9a</OwnerId>
    <Role>Revoked</Role>
    <Subscription>
      <Cancelled>true</Cancelled>
      <ExpirationDate>2025-06-03T04:13:07.0222448+00:00</ExpirationDate>
      <MaxFileSize>1</MaxFileSize>
      <MaxJournalPhotos>3</MaxJournalPhotos>
      <MaxStorage>2</MaxStorage>
      <MaxVillagers>7</MaxVillagers>
      <PremiumFeatures>None</PremiumFeatures>
      <SubscriptionStartDate>2025-06-03T04:13:07.0222448+00:00</SubscriptionStartDate>
    </Subscription>
    <TotalFileSize>8</TotalFileSize>
    <TransferRequest>
      <Candidate>sample string 3</Candidate>
      <CandidateId>a7ebfbc4-1d0c-4962-ac23-28ffd2ae0726</CandidateId>
      <Id>b269920b-065e-4652-900a-e21591b8a5a0</Id>
      <RequestedBy>sample string 4</RequestedBy>
      <VillageId>73961481-57c3-41c2-b72a-a961c0494d6b</VillageId>
      <VillageName>sample string 6</VillageName>
    </TransferRequest>
    <Updated>2025-06-03T04:13:07.0222448+00:00</Updated>
    <VillageId>902b4110-c10f-4a76-aef0-1dc3e440cb7d</VillageId>
    <VillagerId>3845f300-5ed1-45c5-9b38-14ce8ae3434a</VillagerId>
  </VillageViewModel>
</ArrayOfVillageViewModel>