Overview
Error Handling

Methods

API Documentation (API Version bleed)

Billing/Credit/

DESCRIPTION

This section contains methods for viewing account credits.

details

URL:

https://api.liquidweb.com/bleed/Billing/Credit/details

Description:

Provides details of a given account credit

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldTypeNotes
accnt

A valid account number, up to 6 digits in length.

Account the credit is associated with

balance

A monetary value, such as -$.05, 0.05, or -5.00

The amount of funds left on credit

comments

A string permitting tabs, carriage returns and newlines

Optional comments explaining the circumstances of the credit

* Optional
created_date

A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.

Date / time credit was created

id

A positive integer value (i.e. 1 and up).

A unique id for a credit.

original_amount

A monetary value, such as -$.05, 0.05, or -5.00

The amount of funds left on credit

reason

A string of text, containing no newlines or other control characters.

A valid reason for the credit

transactionsAn array of associative arrays containing * Optional
 
actA single word, consisting of only letters and digits.
amountA monetary value, such as -$.05, 0.05, or -5.00
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discount_credit_idA positive integer value (i.e. 1 and up).* Optional
idA positive integer value (i.e. 1 and up).
invoice_idA positive integer value (i.e. 1 and up).* Optional
valid_afterA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
valid_untilA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Billing/Credit/list

Description:

List credits on the account

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
order_byAn associative array containing the fields:
 
fieldOne of: 'balance', 'created_date', 'id', 'original_amount'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
accnt

A valid account number, up to 6 digits in length.

Account the credit is associated with

balance

A monetary value, such as -$.05, 0.05, or -5.00

The amount of funds left on credit

comments

A string permitting tabs, carriage returns and newlines

Optional comments explaining the circumstances of the credit

* Optional
created_date

A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.

Date / time credit was created

id

A positive integer value (i.e. 1 and up).

A unique id for a credit.

original_amount

A monetary value, such as -$.05, 0.05, or -5.00

The amount of funds left on credit

reason

A string of text, containing no newlines or other control characters.

A valid reason for the credit

transactionsAn array of associative arrays containing * Optional
 
actA single word, consisting of only letters and digits.
amountA monetary value, such as -$.05, 0.05, or -5.00
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
discount_credit_idA positive integer value (i.e. 1 and up).* Optional
idA positive integer value (i.e. 1 and up).
invoice_idA positive integer value (i.e. 1 and up).* Optional
valid_afterA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
valid_untilA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

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