Premium Payments on Subscribers

Create PremPaymentSubscriber

Creates a new PremPaymentSubscriber

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premPaymentKey
required
integer <int32>

PremPayment Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premPayment_Key
required
integer <int32>
subscriber_ID
required
string [ 1 .. 9 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
payment_Amount
number or null <double>
payment_Posted
number or null <double>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/premium-payments/{premPaymentKey}/subscriber-payments
Request samples
{
  • "premPayment_Key": 0,
  • "subscriber_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payment_Amount": 0.1,
  • "payment_Posted": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremPaymentSubscriber

Lists all PremPaymentSubscriber for the given premPaymentKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premPaymentKey
required
integer <int32>

PremPayment Key

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/premium-payments/{premPaymentKey}/subscriber-payments
Request samples 
Response samples 
No sample
Get PremPaymentSubscriber
Gets PremPaymentSubscriber


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premPaymentKey
required
integer <int32> 
PremPayment Key


 
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-payments/{premPaymentKey}/subscriber-payments/{subscriberID}
Request samples 
Response samples 
No sample
Update PremPaymentSubscriber
Updates a specific PremPaymentSubscriber.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premPaymentKey
required
integer <int32> 
PremPayment Key


 
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premPayment_Key
required
integer <int32> 
 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
payment_Amount
number or null <double> 
 
payment_Posted
number or null <double> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/premium-payments/{premPaymentKey}/subscriber-payments/{subscriberID}
Request samples 
{
  • "premPayment_Key": 0,
  • "subscriber_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payment_Amount": 0.1,
  • "payment_Posted": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremPaymentSubscriber
Deletes an PremPaymentSubscriber


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premPaymentKey
required
integer <int32> 
PremPayment Key


 
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-payments/{premPaymentKey}/subscriber-payments/{subscriberID}
Request samples 
Create or Update Batch PremPaymentSubscriber
Create or Update multiple PremPaymentSubscriber 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
premPaymentKey
required
integer <int32> 
PremPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
premPayment_Key
required
integer <int32> 
 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
payment_Amount
number or null <double> 
 
payment_Posted
number or null <double> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/premium-payments/{premPaymentKey}/subscriber-payments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}