Skip to content

Create SubPaymentMethod

Request

Creates a new SubPaymentMethod

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
sub_Payment_Method_Keyinteger, (int32)required

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_Dayinteger or null, (int32)

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

benefit_Codestring or null, <= 10 characters

References the benefit code associated with the payment method

effective_Datestring, (date-time)required

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_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

payment_Methodstring, [ 1 .. 20 ] charactersrequired

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

plan_IDstring or null, <= 20 characters

References the plan associated with the payment method

subscriber_IDstring, [ 1 .. 9 ] charactersrequired

References the subscriber associated with the payment method

term_Datestring or null, (date-time)

The termination date of the payment method

update_Datestring, (date-time)

Date 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}/payment-methods' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

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