GET https://api.d-tools.com/SI/Subscribe/ServicePlans?id={id}

Get a service plan for a given service plan id.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The service plan id.	string	Required

Body Parameters

None.

Response Information

Resource Description

ServicePlan

Name	Description	Type	Additional information
Contact	Contact information	ContactInfo	None.
BillingAddress	Billing address information	Address	None.
SiteAddress	Site address information	Address	None.
ServicePlanItems	Service plan items in a service plan.	Collection of ServicePlanItem	None.
ServicePlanProjectItems	Project items in a service plan.	Collection of ServicePlanProjectItem	None.
ServicePlanFeatures	Features in a service plan.	Collection of ServicePlanFeature	None.
OneTimePrice	One time price	decimal number	None.
MonthlyPrice	Monthly price	decimal number	None.
QuarterlyPrice	Quarterly price	decimal number	None.
AnnuallyPrice	Annual price	decimal number	None.
WeeklyPrice	Weekly price	decimal number	None.
BiweeklyPrice	Biweekly price	decimal number	None.
BimonthlyPrice	Bimonthly price	decimal number	None.
SemiannuallyPrice	Semiannual price	decimal number	None.
OneTimePriceTC	One time Price In transaction currency	decimal number	None.
MonthlyPriceTC	Monthly Price In transaction currency	decimal number	None.
QuarterlyPriceTC	Quarterly Price In transaction currency	decimal number	None.
AnnuallyPriceTC	Annual Price In transaction currency	decimal number	None.
WeeklyPriceTC	Weekly Price In transaction currency	decimal number	None.
BiweeklyPriceTC	Biweekly Price In transaction currency	decimal number	None.
BimonthlyPriceTC	Bimonthly Price In transaction currency	decimal number	None.
SemiannuallyPriceTC	Semiannual Price In transaction currency	decimal number	None.
OneTimePriceWithTax	One time priceWithTax	decimal number	None.
MonthlyPriceWithTax	Monthly Price With Tax	decimal number	None.
QuarterlyPriceWithTax	Quarterly Price With Tax	decimal number	None.
AnnuallyPriceWithTax	Annually priceWithTax	decimal number	None.
WeeklyPriceWithTax	Weekly Price With Tax	decimal number	None.
BiweeklyPriceWithTax	Biweekly Price With Tax	decimal number	None.
BimonthlyPriceWithTax	Bimonthly Price With Tax	decimal number	None.
SemiannuallyPriceWithTax	Semiannual Price With Tax	decimal number	None.
OneTimePriceWithTaxTC	One time Price With Tax in Transaction Currency	decimal number	None.
MonthlyPriceWithTaxTC	Monthly Price With Tax in Transaction Currency	decimal number	None.
QuarterlyPriceWithTaxTC	Quarterly Price With Tax in Transaction Currency	decimal number	None.
AnnuallyPriceWithTaxTC	Annual Price With Tax in Transaction Currency	decimal number	None.
WeeklyPriceWithTaxTC	Weekly Price With Tax in Transaction Currency	decimal number	None.
BiweeklyPriceWithTaxTC	Biweekly Price With Tax in Transaction Currency	decimal number	None.
BimonthlyPriceWithTaxTC	Bimonthly Price With Tax in Transaction Currency	decimal number	None.
SemiannuallyPriceWithTaxTC	Semiannual Price With Tax in Transaction Currency	decimal number	None.
Id	Unique Id	string	None.
Client	Client name (Rrequired)	string	None.
ClientNumber	Client number	string	None.
ClientId	ClientId	globally unique identifier	None.
ProjectId	Id of project associated to the service plan	string	None.
Project	Project name	string	None.
ProjectNumber	Project Number	string	None.
Name	Name required	string	None.
Number	Number (Required)	string	None.
Description	Description	string	None.
Start	Start date	date	None.
End	End date	date	None.
Status	Status (Required)	string	None.
MonthToMonth	Month to month	boolean	None.
PlanLength	Plan length	integer	None.
PlanLengthPeriod	Plan length period	string	None.
AutoRenew	Auto renew	boolean	None.
AllowableHours	Allowable hours	decimal number	None.
AllowableHoursFrequency	Allowable hours frequency	string	None.
CustomField1	CustomField1	string	None.
CustomField2	CustomField2	string	None.
CustomField3	CustomField3	string	None.
CustomField4	CustomField4	string	None.
CustomField5	CustomField5	string	None.
CustomField6	CustomField6	boolean	None.
CustomField7	CustomField7	boolean	None.
CustomField8	CustomField8	boolean	None.
CustomField9	CustomField9	boolean	None.
CustomField10	CustomField10	boolean	None.
CustomField11	CustomField11	date	None.
CustomField12	CustomField12	date	None.
CustomField13	CustomField13	date	None.
CustomField14	CustomField14	date	None.
CustomField15	CustomField15	date	None.
CustomField16	CustomField16	string	None.
CustomField17	CustomField17	string	None.
CustomField18	CustomField18	string	None.
CustomField19	CustomField19	string	None.
CustomField20	CustomField20	string	None.
CustomField21	CustomField21	string	None.
CustomField22	CustomField22	string	None.
CustomField23	CustomField23	string	None.
CustomField24	CustomField24	string	None.
CurrencyCode	Currency code	string	None.
CurrencyRate	Currency rate	decimal number	None.
CreatedOn	Date the service plan was created (UTC Time)	date	None.
UpdatedOn	Date the service plan was updated (UTC Time)	date	None.
CreatedBy	Service plan Created By	string	None.
UpdatedBy	Service plan Updated By	string	None.
PublishedBy	Service plan Published By	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Contact": {
    "Name": "sample string 1",
    "Title": "sample string 2",
    "Email": "sample string 3",
    "Phone": "sample string 4",
    "Mobile": "sample string 5"
  },
  "BillingAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "PostalCode": "sample string 5",
    "Country": "sample string 6",
    "Phone": "sample string 7",
    "Fax": "sample string 8"
  },
  "SiteAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "PostalCode": "sample string 5",
    "Country": "sample string 6",
    "Phone": "sample string 7",
    "Fax": "sample string 8"
  },
  "ServicePlanItems": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Frequency": "sample string 4",
      "Calculated": true,
      "Price": 1.0,
      "Taxable": true,
      "StartDate": "2024-04-29T10:43:46.2371507+00:00",
      "NumberOfPayments": 1
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Frequency": "sample string 4",
      "Calculated": true,
      "Price": 1.0,
      "Taxable": true,
      "StartDate": "2024-04-29T10:43:46.2371507+00:00",
      "NumberOfPayments": 1
    }
  ],
  "ServicePlanProjectItems": [
    {
      "Id": "sample string 1",
      "TypeId": 64,
      "SIItemId": "sample string 3",
      "Manufacturer": "sample string 4",
      "Model": "sample string 5",
      "AcctgItemName": "sample string 6",
      "Quantity": 7.0,
      "PackageName": "sample string 8",
      "PartNumber": "sample string 9",
      "Category": "sample string 10",
      "Subcategory": "sample string 11",
      "Description": "sample string 12",
      "ComponentId": "sample string 13",
      "SerialNumber": "sample string 14",
      "IPAddress": "sample string 15",
      "IPAddress2": "sample string 16",
      "MACAddress1": "sample string 17",
      "MACAddress2": "sample string 18",
      "Location": "sample string 19",
      "System": "sample string 20"
    },
    {
      "Id": "sample string 1",
      "TypeId": 64,
      "SIItemId": "sample string 3",
      "Manufacturer": "sample string 4",
      "Model": "sample string 5",
      "AcctgItemName": "sample string 6",
      "Quantity": 7.0,
      "PackageName": "sample string 8",
      "PartNumber": "sample string 9",
      "Category": "sample string 10",
      "Subcategory": "sample string 11",
      "Description": "sample string 12",
      "ComponentId": "sample string 13",
      "SerialNumber": "sample string 14",
      "IPAddress": "sample string 15",
      "IPAddress2": "sample string 16",
      "MACAddress1": "sample string 17",
      "MACAddress2": "sample string 18",
      "Location": "sample string 19",
      "System": "sample string 20"
    }
  ],
  "ServicePlanFeatures": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3"
    }
  ],
  "OneTimePrice": 1.0,
  "MonthlyPrice": 1.0,
  "QuarterlyPrice": 1.0,
  "AnnuallyPrice": 1.0,
  "WeeklyPrice": 1.0,
  "BiweeklyPrice": 1.0,
  "BimonthlyPrice": 1.0,
  "SemiannuallyPrice": 1.0,
  "OneTimePriceTC": 1.0,
  "MonthlyPriceTC": 1.0,
  "QuarterlyPriceTC": 1.0,
  "AnnuallyPriceTC": 1.0,
  "WeeklyPriceTC": 1.0,
  "BiweeklyPriceTC": 1.0,
  "BimonthlyPriceTC": 1.0,
  "SemiannuallyPriceTC": 1.0,
  "OneTimePriceWithTax": 1.0,
  "MonthlyPriceWithTax": 1.0,
  "QuarterlyPriceWithTax": 1.0,
  "AnnuallyPriceWithTax": 1.0,
  "WeeklyPriceWithTax": 1.0,
  "BiweeklyPriceWithTax": 1.0,
  "BimonthlyPriceWithTax": 1.0,
  "SemiannuallyPriceWithTax": 1.0,
  "OneTimePriceWithTaxTC": 1.0,
  "MonthlyPriceWithTaxTC": 1.0,
  "QuarterlyPriceWithTaxTC": 1.0,
  "AnnuallyPriceWithTaxTC": 1.0,
  "WeeklyPriceWithTaxTC": 1.0,
  "BiweeklyPriceWithTaxTC": 1.0,
  "BimonthlyPriceWithTaxTC": 1.0,
  "SemiannuallyPriceWithTaxTC": 1.0,
  "Id": "sample string 1",
  "Client": "sample string 2",
  "ClientNumber": "sample string 3",
  "ClientId": "b7dc0893-623d-4be2-a591-8eaf41656fe7",
  "ProjectId": "sample string 5",
  "Project": "sample string 6",
  "ProjectNumber": "sample string 7",
  "Name": "sample string 8",
  "Number": "sample string 9",
  "Description": "sample string 10",
  "Start": "2024-04-29T10:43:46.2421484+00:00",
  "End": "2024-04-29T10:43:46.2421484+00:00",
  "Status": "sample string 11",
  "MonthToMonth": true,
  "PlanLength": 1,
  "PlanLengthPeriod": "sample string 13",
  "AutoRenew": true,
  "AllowableHours": 1.0,
  "AllowableHoursFrequency": "sample string 15",
  "CustomField1": "sample string 16",
  "CustomField2": "sample string 17",
  "CustomField3": "sample string 18",
  "CustomField4": "sample string 19",
  "CustomField5": "sample string 20",
  "CustomField6": true,
  "CustomField7": true,
  "CustomField8": true,
  "CustomField9": true,
  "CustomField10": true,
  "CustomField11": "2024-04-29T10:43:46.2431493+00:00",
  "CustomField12": "2024-04-29T10:43:46.2431493+00:00",
  "CustomField13": "2024-04-29T10:43:46.2431493+00:00",
  "CustomField14": "2024-04-29T10:43:46.244149+00:00",
  "CustomField15": "2024-04-29T10:43:46.244149+00:00",
  "CustomField16": "sample string 21",
  "CustomField17": "sample string 22",
  "CustomField18": "sample string 23",
  "CustomField19": "sample string 24",
  "CustomField20": "sample string 25",
  "CustomField21": "sample string 26",
  "CustomField22": "sample string 27",
  "CustomField23": "sample string 28",
  "CustomField24": "sample string 29",
  "CurrencyCode": "sample string 30",
  "CurrencyRate": 1.0,
  "CreatedOn": "2024-04-29T10:43:46.244149+00:00",
  "UpdatedOn": "2024-04-29T10:43:46.244149+00:00",
  "CreatedBy": "sample string 31",
  "UpdatedBy": "sample string 32",
  "PublishedBy": "sample string 33"
}

application/xml, text/xml

Sample:

<ServicePlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects">
  <AllowableHours>1</AllowableHours>
  <AllowableHoursFrequency>sample string 15</AllowableHoursFrequency>
  <AutoRenew>true</AutoRenew>
  <Client>sample string 2</Client>
  <ClientId>b7dc0893-623d-4be2-a591-8eaf41656fe7</ClientId>
  <ClientNumber>sample string 3</ClientNumber>
  <CreatedBy>sample string 31</CreatedBy>
  <CreatedOn>2024-04-29T10:43:46.244149+00:00</CreatedOn>
  <CurrencyCode>sample string 30</CurrencyCode>
  <CurrencyRate>1</CurrencyRate>
  <CustomField1>sample string 16</CustomField1>
  <CustomField10>true</CustomField10>
  <CustomField11>2024-04-29T10:43:46.2431493+00:00</CustomField11>
  <CustomField12>2024-04-29T10:43:46.2431493+00:00</CustomField12>
  <CustomField13>2024-04-29T10:43:46.2431493+00:00</CustomField13>
  <CustomField14>2024-04-29T10:43:46.244149+00:00</CustomField14>
  <CustomField15>2024-04-29T10:43:46.244149+00:00</CustomField15>
  <CustomField16>sample string 21</CustomField16>
  <CustomField17>sample string 22</CustomField17>
  <CustomField18>sample string 23</CustomField18>
  <CustomField19>sample string 24</CustomField19>
  <CustomField2>sample string 17</CustomField2>
  <CustomField20>sample string 25</CustomField20>
  <CustomField21>sample string 26</CustomField21>
  <CustomField22>sample string 27</CustomField22>
  <CustomField23>sample string 28</CustomField23>
  <CustomField24>sample string 29</CustomField24>
  <CustomField3>sample string 18</CustomField3>
  <CustomField4>sample string 19</CustomField4>
  <CustomField5>sample string 20</CustomField5>
  <CustomField6>true</CustomField6>
  <CustomField7>true</CustomField7>
  <CustomField8>true</CustomField8>
  <CustomField9>true</CustomField9>
  <Description>sample string 10</Description>
  <End>2024-04-29T10:43:46.2421484+00:00</End>
  <Id>sample string 1</Id>
  <MonthToMonth>true</MonthToMonth>
  <Name>sample string 8</Name>
  <Number>sample string 9</Number>
  <PlanLength>1</PlanLength>
  <PlanLengthPeriod>sample string 13</PlanLengthPeriod>
  <Project>sample string 6</Project>
  <ProjectId>sample string 5</ProjectId>
  <ProjectNumber>sample string 7</ProjectNumber>
  <PublishedBy>sample string 33</PublishedBy>
  <Start>2024-04-29T10:43:46.2421484+00:00</Start>
  <Status>sample string 11</Status>
  <UpdatedBy>sample string 32</UpdatedBy>
  <UpdatedOn>2024-04-29T10:43:46.244149+00:00</UpdatedOn>
  <AnnuallyPrice>1</AnnuallyPrice>
  <AnnuallyPriceTC>1</AnnuallyPriceTC>
  <AnnuallyPriceWithTax>1</AnnuallyPriceWithTax>
  <AnnuallyPriceWithTaxTC>1</AnnuallyPriceWithTaxTC>
  <BimonthlyPrice>1</BimonthlyPrice>
  <BimonthlyPriceTC>1</BimonthlyPriceTC>
  <BimonthlyPriceWithTax>1</BimonthlyPriceWithTax>
  <BimonthlyPriceWithTaxTC>1</BimonthlyPriceWithTaxTC>
  <BiweeklyPrice>1</BiweeklyPrice>
  <BiweeklyPriceTC>1</BiweeklyPriceTC>
  <BiweeklyPriceWithTax>1</BiweeklyPriceWithTax>
  <BiweeklyPriceWithTaxTC>1</BiweeklyPriceWithTaxTC>
  <MonthlyPrice>1</MonthlyPrice>
  <MonthlyPriceTC>1</MonthlyPriceTC>
  <MonthlyPriceWithTax>1</MonthlyPriceWithTax>
  <MonthlyPriceWithTaxTC>1</MonthlyPriceWithTaxTC>
  <OneTimePrice>1</OneTimePrice>
  <OneTimePriceTC>1</OneTimePriceTC>
  <OneTimePriceWithTax>1</OneTimePriceWithTax>
  <OneTimePriceWithTaxTC>1</OneTimePriceWithTaxTC>
  <QuarterlyPrice>1</QuarterlyPrice>
  <QuarterlyPriceTC>1</QuarterlyPriceTC>
  <QuarterlyPriceWithTax>1</QuarterlyPriceWithTax>
  <QuarterlyPriceWithTaxTC>1</QuarterlyPriceWithTaxTC>
  <SemiannuallyPrice>1</SemiannuallyPrice>
  <SemiannuallyPriceTC>1</SemiannuallyPriceTC>
  <SemiannuallyPriceWithTax>1</SemiannuallyPriceWithTax>
  <SemiannuallyPriceWithTaxTC>1</SemiannuallyPriceWithTaxTC>
  <WeeklyPrice>1</WeeklyPrice>
  <WeeklyPriceTC>1</WeeklyPriceTC>
  <WeeklyPriceWithTax>1</WeeklyPriceWithTax>
  <WeeklyPriceWithTaxTC>1</WeeklyPriceWithTaxTC>
  <BillingAddress>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Fax>sample string 8</Fax>
    <Phone>sample string 7</Phone>
    <PostalCode>sample string 5</PostalCode>
    <State>sample string 4</State>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
  </BillingAddress>
  <Contact>
    <Email>sample string 3</Email>
    <Mobile>sample string 5</Mobile>
    <Name>sample string 1</Name>
    <Phone>sample string 4</Phone>
    <Title>sample string 2</Title>
  </Contact>
  <ServicePlanFeatures>
    <ServicePlanFeature>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </ServicePlanFeature>
    <ServicePlanFeature>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </ServicePlanFeature>
  </ServicePlanFeatures>
  <ServicePlanItems>
    <ServicePlanItem>
      <Calculated>true</Calculated>
      <Description>sample string 3</Description>
      <Frequency>sample string 4</Frequency>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <NumberOfPayments>1</NumberOfPayments>
      <Price>1</Price>
      <StartDate>2024-04-29T10:43:46.2371507+00:00</StartDate>
      <Taxable>true</Taxable>
    </ServicePlanItem>
    <ServicePlanItem>
      <Calculated>true</Calculated>
      <Description>sample string 3</Description>
      <Frequency>sample string 4</Frequency>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <NumberOfPayments>1</NumberOfPayments>
      <Price>1</Price>
      <StartDate>2024-04-29T10:43:46.2371507+00:00</StartDate>
      <Taxable>true</Taxable>
    </ServicePlanItem>
  </ServicePlanItems>
  <ServicePlanProjectItems>
    <ServicePlanProjectItem>
      <AcctgItemName>sample string 6</AcctgItemName>
      <Category>sample string 10</Category>
      <ComponentId>sample string 13</ComponentId>
      <Description>sample string 12</Description>
      <IPAddress>sample string 15</IPAddress>
      <IPAddress2>sample string 16</IPAddress2>
      <Id>sample string 1</Id>
      <Location>sample string 19</Location>
      <MACAddress1>sample string 17</MACAddress1>
      <MACAddress2>sample string 18</MACAddress2>
      <Manufacturer>sample string 4</Manufacturer>
      <Model>sample string 5</Model>
      <PackageName>sample string 8</PackageName>
      <PartNumber>sample string 9</PartNumber>
      <Quantity>7</Quantity>
      <SIItemId>sample string 3</SIItemId>
      <SerialNumber>sample string 14</SerialNumber>
      <Subcategory>sample string 11</Subcategory>
      <System>sample string 20</System>
      <TypeId>64</TypeId>
    </ServicePlanProjectItem>
    <ServicePlanProjectItem>
      <AcctgItemName>sample string 6</AcctgItemName>
      <Category>sample string 10</Category>
      <ComponentId>sample string 13</ComponentId>
      <Description>sample string 12</Description>
      <IPAddress>sample string 15</IPAddress>
      <IPAddress2>sample string 16</IPAddress2>
      <Id>sample string 1</Id>
      <Location>sample string 19</Location>
      <MACAddress1>sample string 17</MACAddress1>
      <MACAddress2>sample string 18</MACAddress2>
      <Manufacturer>sample string 4</Manufacturer>
      <Model>sample string 5</Model>
      <PackageName>sample string 8</PackageName>
      <PartNumber>sample string 9</PartNumber>
      <Quantity>7</Quantity>
      <SIItemId>sample string 3</SIItemId>
      <SerialNumber>sample string 14</SerialNumber>
      <Subcategory>sample string 11</Subcategory>
      <System>sample string 20</System>
      <TypeId>64</TypeId>
    </ServicePlanProjectItem>
  </ServicePlanProjectItems>
  <SiteAddress>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Fax>sample string 8</Fax>
    <Phone>sample string 7</Phone>
    <PostalCode>sample string 5</PostalCode>
    <State>sample string 4</State>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
  </SiteAddress>
</ServicePlan>