Skip to content

Create MemberAccountPlanPayment

Request

Creates a new MemberAccountPlanPayment

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

memberSeqstringrequired

Member Seq

memberAccountKeyinteger, (int32)required

MemberAccount Key

planIDstringrequired

Plan ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
payment_Keyinteger, (int32)required

Unique identifier for each payment record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

memberAccount_Keyinteger, (int32)required

References the MemberAccount.MemberAccount_Key value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

plan_IDstring, [ 1 .. 20 ] charactersrequired

References the SubenrollmentPlan.Plan_ID value for this members enrollment.

transaction_Amountnumber or null, (double)

Total amount of the transaction.

transaction_Datestring or null, (date-time)

Date when the transaction occurred.

transaction_IDstring or null, <= 20 characters

Identifier assigned to the associated transaction.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/accounts/{memberAccountKey}/plans/{planID}/payments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "payment_Key": 0,
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "memberAccount_Key": 0,
    "plan_ID": "string",
    "transaction_Amount": 0.1,
    "transaction_Date": "2019-08-24T14:15:22Z",
    "transaction_ID": "string",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

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