POST api/ActionService/IsSubscriptionUnderUpgrade

Documentation for 'IsSubscriptionUnderUpgrade'.

Request Information

Parameters

Name	Description	Additional information
request	Documentation for 'request'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "StripeCustomerId": "sample string 2",
  "StripeSubscriptionId": "sample string 3",
  "StripePlanId": "sample string 4",
  "StartedOn": "2026-01-11T19:31:32.4195561+00:00",
  "PeriodStartedOn": "2026-01-11T19:31:32.4195561+00:00",
  "PeriodEndsOn": "2026-01-11T19:31:32.4195561+00:00",
  "CancelledOn": "2026-01-11T19:31:32.4195561+00:00",
  "Active": 5,
  "StripeStatus": "sample string 6",
  "Amount": 7.0,
  "IsComplimentary": true
}

application/xml, text/xml

Sample:

<StripeSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Musician.Subscription">
  <Active>5</Active>
  <Amount>7</Amount>
  <CancelledOn>2026-01-11T19:31:32.4195561+00:00</CancelledOn>
  <IsComplimentary>true</IsComplimentary>
  <PeriodEndsOn>2026-01-11T19:31:32.4195561+00:00</PeriodEndsOn>
  <PeriodStartedOn>2026-01-11T19:31:32.4195561+00:00</PeriodStartedOn>
  <StartedOn>2026-01-11T19:31:32.4195561+00:00</StartedOn>
  <StripeCustomerId>sample string 2</StripeCustomerId>
  <StripePlanId>sample string 4</StripePlanId>
  <StripeStatus>sample string 6</StripeStatus>
  <StripeSubscriptionId>sample string 3</StripeSubscriptionId>
  <UserId>1</UserId>
</StripeSubscriptionModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedMediaTypeFormatterTracer' to write type 'StripeSubscriptionModel'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "Message": {
    "value": true
  }
}

application/xml, text/xml

Sample:

<ResponseBaseOfGenericBooleanResponseVxd1ES9A xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.MessageBase">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Musician">
    <d2p1:value>true</d2p1:value>
  </Message>
  <status>sample string 1</status>
</ResponseBaseOfGenericBooleanResponseVxd1ES9A>