Subscriber Payment Methods

Create SubPaymentMethod

Creates a new SubPaymentMethod

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
sub_Payment_Method_Key
required
integer <int32>

The primary key and identifier of the record Note: This field is marked as NOT NULL in the database and therefore required by the API.

acH_Pull_Day
integer or null <int32>

Day of the month the ACH payment will be taken from the account

benefit_Code
string or null <= 10 characters

References the benefit code associated with the payment method

effective_Date
required
string <date-time>

The effective date of the payment method Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

payment_Method
required
string [ 1 .. 20 ] characters

The payment method associated with the subscriber, plan, benefit code combination

plan_ID
string or null <= 20 characters

References the plan associated with the payment method

subscriber_ID
required
string [ 1 .. 9 ] characters

References the subscriber associated with the payment method

term_Date
string or null <date-time>

The termination date of the payment method

update_Date
string <date-time>

Date 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}/payment-methods
Request samples
{
  • "sub_Payment_Method_Key": 0,
  • "acH_Pull_Day": 0,
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payment_Method": "string",
  • "plan_ID": "string",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubPaymentMethod

Lists all SubPaymentMethod 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}/payment-methods
Request samples 
Response samples 
No sample
Get SubPaymentMethod
Gets SubPaymentMethod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subPaymentMethodKey
required
integer <int32> 
Sub Payment Method Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/payment-methods/{subPaymentMethodKey}
Request samples 
Response samples 
No sample
Update SubPaymentMethod
Updates a specific SubPaymentMethod.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subPaymentMethodKey
required
integer <int32> 
Sub Payment Method Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
sub_Payment_Method_Key
required
integer <int32> 
The primary key and identifier of the record Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
acH_Pull_Day
integer or null <int32> 
Day of the month the ACH payment will be taken from the account


 
benefit_Code
string or null  <= 10 characters 
References the benefit code associated with the payment method


 
effective_Date
required
string <date-time> 
The effective date of the payment method Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


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


 
payment_Method
required
string  [ 1 .. 20 ] characters 
The payment method associated with the subscriber, plan, benefit code combination


 
plan_ID
string or null  <= 20 characters 
References the plan associated with the payment method


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References the subscriber associated with the payment method


 
term_Date
string or null <date-time> 
The termination date of the payment method


 
update_Date
string <date-time> 
Date 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}/payment-methods/{subPaymentMethodKey}
Request samples 
{
  • "sub_Payment_Method_Key": 0,
  • "acH_Pull_Day": 0,
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payment_Method": "string",
  • "plan_ID": "string",
  • "subscriber_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubPaymentMethod
Deletes an SubPaymentMethod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
subPaymentMethodKey
required
integer <int32> 
Sub Payment Method Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/payment-methods/{subPaymentMethodKey}
Request samples 
Create or Update Batch SubPaymentMethod
Create or Update multiple SubPaymentMethod 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
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
sub_Payment_Method_Key
required
integer <int32> 
The primary key and identifier of the record Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
acH_Pull_Day
integer or null <int32> 
Day of the month the ACH payment will be taken from the account


 
benefit_Code
string or null  <= 10 characters 
References the benefit code associated with the payment method


 
effective_Date
required
string <date-time> 
The effective date of the payment method Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


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


 
payment_Method
required
string  [ 1 .. 20 ] characters 
The payment method associated with the subscriber, plan, benefit code combination


 
plan_ID
string or null  <= 20 characters 
References the plan associated with the payment method


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References the subscriber associated with the payment method


 
term_Date
string or null <date-time> 
The termination date of the payment method


 
update_Date
string <date-time> 
Date 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}/payment-methods-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}