GET v1/Payment/Plan?LineOfBusiness={LineOfBusiness}&StateCode={StateCode}&ProductType={ProductType}&UniversalAccountNumber={UniversalAccountNumber}&EffectiveDate={EffectiveDate}&IsRenewal={IsRenewal}&IsMortgageeBilling={IsMortgageeBilling}&IsAgencyBilling={IsAgencyBilling}

Payment Plan Options

Request Information

URI Parameters

Name	Description	Type	Additional information
LineOfBusiness	Line of business prefix	string	Required
StateCode	State code	string	Required
ProductType	Product type prefix (Use 'N/A' if product types are not used)	string	None.
UniversalAccountNumber	Universal account number (Optional)	string	None.
EffectiveDate	Effective date (Optional)	date	None.
IsRenewal	Is renewal policy (Optional)	boolean	Default value is False
IsMortgageeBilling	Is under mortgagee billing (Optional)	boolean	Default value is False
IsAgencyBilling	Is under agency billing (Optional)	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of PaymentPlanDTO

Name	Description	Type	Additional information
NumberOfInstallments	Number of installments	integer	None.
Description	Bill plan description	string	None.
Id	Primary Id	integer	None.
WarningMessages	List of warning messages encountered while servicing request	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "NumberOfInstallments": 1,
    "Description": "sample string 2",
    "Id": 3
  },
  {
    "NumberOfInstallments": 1,
    "Description": "sample string 2",
    "Id": 3
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentPlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <PaymentPlanDTO>
    <Id>3</Id>
    <Description>sample string 2</Description>
    <NumberOfInstallments>1</NumberOfInstallments>
  </PaymentPlanDTO>
  <PaymentPlanDTO>
    <Id>3</Id>
    <Description>sample string 2</Description>
    <NumberOfInstallments>1</NumberOfInstallments>
  </PaymentPlanDTO>
</ArrayOfPaymentPlanDTO>