Overview
Error Handling

Methods

API Documentation (API Version bleed)

Billing/

DESCRIPTION

This section contains methods for obtaining various general billing related information.

advancedDisplay

URL:

https://api.liquidweb.com/bleed/Billing/advancedDisplay

Description:

DEPRECATED METHOD (There is no longer an alternative to "advanced display"). Indicates if user has the advanced invoices display enabled or not.

Parameters:

No Values Defined

Returns:

FieldType
enabledA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

balance

URL:

https://api.liquidweb.com/bleed/Billing/balance

Description:

Parameters:

No Values Defined

Returns:

FieldTypeNotes
availableA positive monetary value, such as $.05, 0.05, or 5.00
balanceA positive monetary value, such as $.05, 0.05, or 5.00
creditA positive monetary value, such as $.05, 0.05, or 5.00
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
cyclesAn array of a valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
dueA positive monetary value, such as $.05, 0.05, or 5.00
last_payment_dateA valid date in YYYY-MM-DD format.* Optional
next_bill_dateA valid date in YYYY-MM-DD format.
next_datesAn array of associative arrays containing
 
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
next_dateA valid date in YYYY-MM-DD format.
overdueA positive monetary value, such as $.05, 0.05, or 5.00
payment_methodA valid payment method (check, credit_card, ach, paypal, paypal_agreement).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

changeMonthlyBillDay

URL:

https://api.liquidweb.com/bleed/Billing/changeMonthlyBillDay

Description:

Parameters:

ParameterTypeNotes
change

A boolean value (0 or 1).

whether to just check eligibility and return gap invoice amount or actually make the change

* Optional
  • Defaults to: 0
day

A number between 1 and 28

day of month

* Required

Returns:

FieldTypeNotes
amountA monetary value, such as -$.05, 0.05, or -5.00* Optional
invoiceA positive integer value (i.e. 1 and up).* Optional
messageA string permitting tabs, carriage returns and newlines* Optional
next_bill_dateA valid date in YYYY-MM-DD format.* Optional
stateA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

paymentsTransition

URL:

https://api.liquidweb.com/bleed/Billing/paymentsTransition

Description:

Parameters:

No Values Defined

Returns:

FieldType
transitionedA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

paymethod

URL:

https://api.liquidweb.com/bleed/Billing/paymethod

Description:

Parameters:

No Values Defined

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
credit_card_expA valid month/year in MM/YYYY format.* Required if:
  • payment_method is set to 'credit_card'
credit_card_numA credit card number with only the last four digits exposed, preceded by any number of X's (i.e. XXXXXXXXXXXX1234).* Required if:
  • payment_method is set to 'credit_card'
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
payment_methodA valid payment method (check, credit_card, ach, paypal, paypal_agreement).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

updatePaymethod

URL:

https://api.liquidweb.com/bleed/Billing/updatePaymethod

Description:

Parameters:

ParameterType
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
payment_methodThe value: 'check'

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
credit_card_expA valid month/year in MM/YYYY format.* Required if:
  • payment_method is set to 'credit_card'
credit_card_numA credit card number with only the last four digits exposed, preceded by any number of X's (i.e. XXXXXXXXXXXX1234).* Required if:
  • payment_method is set to 'credit_card'
cycleA valid billing cycle (monthly, quarterly, biannually, yearly, or biennially).
payment_methodA valid payment method (check, credit_card, ach, paypal, paypal_agreement).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types