Subscriber Plan Policies

Subscriber Policy Surrender Advanced API

Surrender an existing Policy under the Policy & Forfeiture area.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

policyNumber
required
string

Policy Number

cashValue
required
number <double>

Cash Value

header Parameters
vbasoftware-database
required
string

Target database

Responses
202

Accepted

401

Unauthorized

post/subscribers/{subscriberID}/surrender-policy/{planID}/{benefitCode}/{policyNumber}/{cashValue}
Request samples 
Create SubscriberPlanPolicy
Creates a new SubscriberPlanPolicy


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the plan.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Benefit code associated with the selected plan.


 
policy_Number
required
string  [ 1 .. 64 ] characters 
Policy number of the associated plan.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
maturity_Date
string or null <date-time> 
Date when the selected policy matures.


 
paid_Through
string or null <date-time> 
This date indicates how far out the policy has been paid up to.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


post/subscribers/{subscriberID}/plan-policies
Request samples 
{
  • "subscriber_ID": "string",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "policy_Number": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "maturity_Date": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
List SubscriberPlanPolicy
Lists all SubscriberPlanPolicy for the given subscriberID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
query Parameters
page
integer <int32> 
 Default:  1
Page


 
pageSize
integer <int32> 
 Default:  100
Page Size


 
sortBy
string
Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/plan-policies
Request samples 
Response samples 
No sample
Get SubscriberPlanPolicy
Gets SubscriberPlanPolicy


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/plan-policies/{planID}/{benefitCode}/{policyNumber}
Request samples 
Response samples 
No sample
Update SubscriberPlanPolicy
Updates a specific SubscriberPlanPolicy.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the plan.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Benefit code associated with the selected plan.


 
policy_Number
required
string  [ 1 .. 64 ] characters 
Policy number of the associated plan.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
maturity_Date
string or null <date-time> 
Date when the selected policy matures.


 
paid_Through
string or null <date-time> 
This date indicates how far out the policy has been paid up to.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/plan-policies/{planID}/{benefitCode}/{policyNumber}
Request samples 
{
  • "subscriber_ID": "string",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "policy_Number": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "maturity_Date": "2019-08-24T14:15:22Z",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberPlanPolicy
Deletes an SubscriberPlanPolicy


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/plan-policies/{planID}/{benefitCode}/{policyNumber}
Request samples 
Create or Update Batch SubscriberPlanPolicy
Create or Update multiple SubscriberPlanPolicy at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Ssubscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the plan.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Benefit code associated with the selected plan.


 
policy_Number
required
string  [ 1 .. 64 ] characters 
Policy number of the associated plan.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
maturity_Date
string or null <date-time> 
Date when the selected policy matures.


 
paid_Through
string or null <date-time> 
This date indicates how far out the policy has been paid up to.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/plan-policies-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}