Skip to content

Create GroupContractPlanPremium

Request

Creates a new GroupContractPlanPremium

Security
apiKeyAuth and bearerAuth
Path
groupIDstringrequired

Group ID

divisionIDstringrequired

Division ID

coverageStartstring, (date-time)required

Coverage Start

planIDstringrequired

Plan ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
groupContractPlanPremium_Keyinteger, (int32)required

No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adultbooleanrequired

No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_Frominteger or null, (int32)

No longer in use. Replaced by Premium Billing module.

age_Thruinteger or null, (int32)

No longer in use. Replaced by Premium Billing module.

applies_Tostring or null, <= 8 characters

No longer in use. Replaced by Premium Billing module.

billing_Basisstring, = 1 charactersrequired

No longer in use. Replaced by Premium Billing module.

childbooleanrequired

No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coverage_Startstring, (date-time)required

No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.

division_IDstring, [ 1 .. 20 ] charactersrequired

No longer in use. Replaced by Premium Billing module.

entry_Datestring, (date-time)

No longer in use. Replaced by Premium Billing module.

entry_Userstring or null, <= 20 characters

No longer in use. Replaced by Premium Billing module.

group_IDstring, [ 1 .. 20 ] charactersrequired

No longer in use. Replaced by Premium Billing module.

maximumnumber or null, (double)

No longer in use. Replaced by Premium Billing module.

plan_IDstring, [ 1 .. 20 ] charactersrequired

No longer in use. Replaced by Premium Billing module.

premiumnumber or null, (double)

No longer in use. Replaced by Premium Billing module.

sexstring or null, <= 1 characters

No longer in use. Replaced by Premium Billing module.

tierstring or null, <= 2 characters

No longer in use. Replaced by Premium Billing module.

update_Datestring, (date-time)

No longer in use. Replaced by Premium Billing module.

update_Userstring or null, <= 20 characters

No longer in use. Replaced by Premium Billing module.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/premiums' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "groupContractPlanPremium_Key": 0,
    "adult": true,
    "age_From": 0,
    "age_Thru": 0,
    "applies_To": "string",
    "billing_Basis": "s",
    "child": true,
    "coverage_Start": "2019-08-24T14:15:22Z",
    "division_ID": "string",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "group_ID": "string",
    "maximum": 0.1,
    "plan_ID": "string",
    "premium": 0.1,
    "sex": "s",
    "tier": "st",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}