Overview
Error Handling

Methods

API Documentation (API Version bleed)

Account/Paymethod/

DESCRIPTION

This section contains methods to fetch and update an account's payment information.

NOTE: DEPRECATED. The methods here are more billing related than account related and have been moved to the billing section =cut

our @FIELDS = qw(accnt cycle payment_method credit_card_num credit_card_exp card_code);

balance

URL:

https://api.liquidweb.com/bleed/Account/Paymethod/balance

Description:

When you destroy servers or turn off optional features, money is added to your balance to either pay for new servers or cover part of your next bill. This method allows you to determine how much balance you have available.

A second field, due, is the amount of charges in your account that have not yet been reconciled. Usually charges are reconciled on your billing date.

**NOTE** DEPRECATED. Moved to billing.

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

get

URL:

https://api.liquidweb.com/bleed/Account/Paymethod/get

Description:

Returns the current payment configuration for the logged in account.

Only the last 4 digits of the credit card number are returned, for obvious security reasons.

**NOTE** DEPRECATED. Moved to billing.

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

update

URL:

https://api.liquidweb.com/bleed/Account/Paymethod/update

Description:

Updates the current payment configuration for the logged in account.

**NOTE** DEPRECATED. Moved to billing.

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