BokaMera.API.Host

UpdateVossSubscriptionScheduledChange

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
PUT	/voss/subscriptions/{SubscriptionId}/scheduledChanges/{Id}	Update voss subscription scheduled change	Update a pending subscription scheduled change in the VOSS System. Already executed scheduled changes cannot be updated.

**UpdateVossSubscriptionScheduledChange** Parameters:
Name	Parameter	Data Type	Required	Description
SubscriptionId	path	Guid	Yes	The subscription id
Id	path	Guid	Yes	The subscription scheduled change id
Type	body	TypeEnum	Yes	Controls when the scheduled change will be executed: <br />AtSubscriptionBillingPeriodEnd - after the currently latest subscription billing period ends <br />AtBindingPeriodEnd - after the currently latest subscription binding period ends
VersionId	body	Guid?	No	Optional package version id; if omitted the current version of the subscription package is used
PackageId	body	Guid?	No	The id of a package which will be active after the scheduled change is executed; if provided the tier id and plan id have to be provided as well
TierId	body	Guid?	No	The id of a tier which will be active after the scheduled change is executed; can be omitted if PlanId is provided instead
PlanId	body	Guid?	No	The id of a plan which will be active after the scheduled change is executed; can be omitted if TierId is provided instead
PeriodIterationCount	body	int?	No	How many periods (counting from the latest period) must pass before the scheduled change is executed; if omitted the change is executed on the latest period end

**TypeEnum** Enum:
AtSubscriptionBillingPeriodEnd
AtBindingPeriodEnd

**SubscriptionScheduledChangeResult** Parameters:
Name	Parameter	Data Type	Required
Type	form	TypeEnum	No
Status	form	StatusEnum	No
Id	form	Guid	No
Package	form	SubscriptionScheduledChangePackageResult	Yes
Tier	form	SubscriptionScheduledChangeTierResult	Yes
Plan	form	SubscriptionScheduledChangePlanResult	Yes
ScheduledDate	form	DateTime	No
SalesInformation	form	SubscriptionScheduledChangeSalesInformationResult	Yes

**StatusEnum** Enum:
Active
Terminated

**SubscriptionScheduledChangePackageResult** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
VersionId	form	Guid	No
Name	form	string	Yes

**SubscriptionScheduledChangeTierResult** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid	No
Name	form	string	Yes

**SubscriptionScheduledChangePlanResult** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid	No
Name	form	string	Yes

**SubscriptionScheduledChangeSalesInformationResult** Parameters:
Name	Parameter	Data Type	Required	Description
SalesPersonId	form	string	Yes
SalesDepartmentId	form	string	Yes

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /voss/subscriptions/{SubscriptionId}/scheduledChanges/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateVossSubscriptionScheduledChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <PackageId>00000000-0000-0000-0000-000000000000</PackageId>
  <PeriodIterationCount>0</PeriodIterationCount>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <TierId>00000000-0000-0000-0000-000000000000</TierId>
  <Type>AtSubscriptionBillingPeriodEnd</Type>
  <VersionId>00000000-0000-0000-0000-000000000000</VersionId>
</UpdateVossSubscriptionScheduledChange>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SubscriptionScheduledChangeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
  <id>00000000-0000-0000-0000-000000000000</id>
  <package i:nil="true" />
  <plan i:nil="true" />
  <salesInformation i:nil="true" />
  <scheduledDate>0001-01-01T00:00:00</scheduledDate>
  <status>Pending</status>
  <tier i:nil="true" />
  <type>AtSubscriptionBillingPeriodEnd</type>
</SubscriptionScheduledChangeResult>