Plan Benefit PBM Co-Pays

Create PlanBenefitPBM

Creates a new PlanBenefitPBM

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
plan_ID
required
string [ 1 .. 20 ] characters

References the PlanBenefits.Plan_ID value in parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

References the PlanBenefits.Benefit_Code value in parent table.

pbM_Type
required
string [ 1 .. 8 ] characters

User-defined type of pharmacy benefit copay. This information is pulled into the Member SPD matrix on the Member screen.

co_Pay_Amount
number or null <double>

Amount of Copay that the Member is responsible for.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/benefits/{benefitCode}/pbm-co-pays
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "pbM_Type": "string",
  • "co_Pay_Amount": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenefitPBM

Lists all PlanBenefitPBM for the given planID and benefitCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/benefits/{benefitCode}/pbm-co-pays
Request samples 
Response samples 
No sample
Get PlanBenefitPBM
Gets PlanBenefitPBM


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
pBMType
required
string
PBM Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/pbm-co-pays/{pBMType}
Request samples 
Response samples 
No sample
Update PlanBenefitPBM
Updates a specific PlanBenefitPBM.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
pBMType
required
string
PBM Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
plan_ID
required
string  [ 1 .. 20 ] characters 
References the PlanBenefits.Plan_ID value in parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the PlanBenefits.Benefit_Code value in parent table.


 
pbM_Type
required
string  [ 1 .. 8 ] characters 
User-defined type of pharmacy benefit copay. This information is pulled into the Member SPD matrix on the Member screen.


 
co_Pay_Amount
number or null <double> 
Amount of Copay that the Member is responsible for.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/benefits/{benefitCode}/pbm-co-pays/{pBMType}
Request samples 
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "pbM_Type": "string",
  • "co_Pay_Amount": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanBenefitPBM
Deletes an PlanBenefitPBM


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
pBMType
required
string
PBM Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/pbm-co-pays/{pBMType}
Request samples 
Create or Update Batch PlanBenefitPBM
Create or Update multiple PlanBenefitPBM 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
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the PlanBenefits.Plan_ID value in parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the PlanBenefits.Benefit_Code value in parent table.


 
pbM_Type
required
string  [ 1 .. 8 ] characters 
User-defined type of pharmacy benefit copay. This information is pulled into the Member SPD matrix on the Member screen.


 
co_Pay_Amount
number or null <double> 
Amount of Copay that the Member is responsible for.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/benefits/{benefitCode}/pbm-co-pays-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}