Skip to content

Create SubscriberPremRateSplit

Request

Creates a new SubscriberPremRateSplit

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
subscriberPremRateSplit_Keyinteger, (int32)required

Unqiue identiferi for each Premium Rate split configured for this subscriber. Note: This field is marked as NOT NULL in the database and therefore required by the API.

amountnumber, (double)required

Specifies the amount of the rate split. Note: This field is marked as NOT NULL in the database and therefore required by the API.

amount_Pctbooleanrequired

Identifies that the rate split is a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Datestring, (date-time)required

Date when the associated rate split becomes/became effective. 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.

invoice_Levelstring, = 1 charactersrequired

Identifies at which level the rate split will be invoiced.

premRate_Keyinteger, (int32)required

References PremRate.PremRate_Key value on the referenced record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

split_Rulestring or null, <= 16 characters

Identifies the rule, or how, the the rate split will be applied.

subscriber_IDstring, [ 1 .. 9 ] charactersrequired

References Subscribers.Subscriber_ID value on the parent record.

term_Datestring or null, (date-time)

Date when the associated rate split expires/expired.

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}/premium-rate-splits' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "subscriberPremRateSplit_Key": 0,
    "amount": 0.1,
    "amount_Pct": true,
    "effective_Date": "2019-08-24T14:15:22Z",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "invoice_Level": "s",
    "premRate_Key": 0,
    "split_Rule": "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": { … }
}