/ 
Net-FreshBooks-API-0.24
River stage zero No dependents
/ Net::FreshBooks::API::Recurring::AutoBill

NAME

Net::FreshBooks::API::Recurring::AutoBill - Adds AutoBill support to FreshBooks Recurring Items

VERSION

version 0.24

SYNOPSIS

Autobill objects can be created via a recurring item:

my $autobill = $recurring_item->autobill;

If you want options, you can also do it the hard way:

my $autobill = Net::FreshBooks::API::Recurring::AutoBill->new;
... set autobill params ...
$recurring_item->autobill( $autobill );

If you like lots of arrows:

$recurring_item->autobill->card->expiration->month(12);

In summary:

my $autobill = $recurring_item->autobill;
$autobill->gateway_name('PayPal Payflow Pro');
$autobill->card->name('Tim Toady');
$autobill->card->number('4111 1111 1111 1111');
$autobill->card->expiration->month(12);
$autobill->card->expiration->year(2015);

$recurring_item->create;

gateway name

Case insensitive gateway name from Gateway list (Must be auto-bill enabled).

$autobill->gateway_name('PayPal Payflow Pro');

card

Returns a Net::FreshBooks::API::Recurring::AutoBill::Card object

my $cardholder_name = $autobill->card->name;

# This syntax follows the format of the XML request

$autobill->card->name('Tim Toady');
$autobill->card->number('4111 1111 1111 1111');
$autobill->card->expiration->month(12);
$autobill->card->expiration->year(2015);

# This alternate syntax is less verbose
$autobill->card->name('Tim Toady');
$autobill->card->number('4111 1111 1111 1111');
$autobill->card->month(12);
$autobill->card->year(2015);

CAVEATS

To delete a recurring item's autobill status, autobill should explicitly be set to an empty string. This will send an empty autobill element to FreshBooks, which is the correct syntax for deleting existing autobill info. This only makes sense in the context of an update. If you are creating a new recurring item without autobill, just don't touch the AutoBill object and it will "do the right thing".

$recurring_item->autobill( '' ); # delete an autobill profile
$recurring_item->update;

If you are updating autobill for a recurring item, you must update the credit card number, or the request will fail. This is because, while FreshBooks requires all autobill elements to be present, FreshBooks returns only the last 4 digits of the card number when the item is fetched. So, the only way to establish the actual card number is for you to provide it.

my $item = $freshbooks->recurring_item->get({ recurring_id => $id });
$item->autobill->card->number( $new_number );
$item->update;

AUTHORS

  • Edmund von der Burg <evdb@ecclestoad.co.uk>

  • Olaf Alders <olaf@wundercounter.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Edmund von der Burg & Olaf Alders.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.