Finance

Get customer billing (blocking) info

Get customer billing infoGet customer billing (blocking) info.

For daily prepaid customers will be returned the following fields:

  • howManyDaysLeft

  • paymentPerPeriod

  • paymentPerDay

  • deposit

  • services_name

  • blocking_date

For monthly prepaid customers will be returned the following fields:

  • howManyMonthsLeft

  • howManyDaysLeft

  • blockInNextBillingCycle

  • paymentPerMonth

  • paymentPerDay

  • deposit

  • services_name

  • blocking_date

  • service

For recurring paid customers will be returned the following fields:

  • blockingEnabled

  • blockInNextBillingCycle

  • status

  • lowBalance

  • howManyDaysLeft

  • blocking_date

  • deposit

  • blockInNextBillingCycle

  • is_already_blocked

  • is_already_disabled

get/portal/services/billing-info

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/portal/services/billing-info
  • Auth: HTTP basic

Query parameters

format_valuesboolean required
Example:true

Return output values in system format.

Response

howManyMonthsLeftnumber

Money for payment are left for N months. Only for prepaid monthly customers.

howManyDaysLeftnumber

Money for payment are left for N days

paymentPerMonthnumber

Price per month for all services. Only for prepaid monthly customers.

paymentPerDaynumber

Price per day for all services

depositnumber

Current customer account balance

blocking_datestring

Prepaid expiration date. Only for prepaid monthly customers.

Example response

{
  "howManyMonthsLeft": 1,
  "howManyDaysLeft": 28,
  "paymentPerMonth": 175.67,
  "paymentPerDay": 6.2739,
  "deposit": 235.09,
  "blocking_date": "2019-03-25"
}

Changes

No recorded changes to this operation across all 1 revision of this API.