Invoice/List

List all invoices connected to a specific brand or provide any of the search criteria to narrow your results. The maximum number of returned results is 50. If a 'customer_account_id' or 'subscription_id' are provided a maximum of 400 results is returned.

Status Ledger:
0 - Unpaid
1 - Paid
2 - Partially Paid
3 - Deleted

Parameters

Parameter	Type	Required	Description
invoice_id	string	optional	Provide a 'invoice_id' to find a specific invoice.
customer_account_id	string	optional	Provide a 'customer_account_id' to list invoices connected to a specific customer.
subscription_id	string	optional	The 'subscription_id' linked to the invoice.
custom_field_1	string	optional	The value of 'customer_field_1'.
custom_field_2	string	optional	The value of 'customer_field_2'.

GET https://api.recurringstack.com/{format}/Invoice/List

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('invoice_id' => "",'customer_account_id' => "",'subscription_id' => "",'custom_field_1' => "",'custom_field_2' => "");
try { $response = $rstack->request('Invoice/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>

false

API Simulator

Initiate a live call to the Invoice/List service using the API simulator.

invoice_id

customer_account_id

subscription_id

custom_field_1

custom_field_2

Your API credentials are missing, click "Set Credentials" to set them.

Invoice/Create

Create a manual invoice. This service allows you to send invoices to customers for services outside of any subscription.

Invoices for subscriptions are automatically generated two days before the subscription payment is due. Creating invoices using this service should only be done to bill for products/services outside of any ongoing subscription.

attached_items must be provided in the following JSON format:

Example JSON:
[{"item_name":"Programming Services Base Charge","item_price":"25.00","tax_exempt":"N"},{"item_name":"25 Hours of Programming","item_price":"250.00","tax_exempt":"Y"}]

Parameters

Parameter	Type	Required	Description
customer_account_id	string	required	The customer account you want to link the invoice to.
attached_items	string	optional	A list of items and their associated price you wish to add to the invoice in JSON format.
due_date	string	required	The date the invoice payment is due. Valid date format is M/D/YYYY.
custom_field_1	string	optional	A custom field for your records.
custom_field_2	string	optional	A custom field for your records.
auto_subscription_id	string	optional	This is for testing only.

POST https://api.recurringstack.com/{format}/Invoice/Create

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('customer_account_id' => "",'attached_items' => "",'due_date' => "",'custom_field_1' => "",'custom_field_2' => "",'auto_subscription_id' => "");
try { $response = $rstack->request('Invoice/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="478804">
   <invoice invoice_id="662ae294-f1f9-41d3-a652-81d153d3e53c" creation_date="2022-05-31 17:35:04"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "478804"
    },
    "invoice": {
        "@attributes": {
            "invoice_id": "662ae294-f1f9-41d3-a652-81d153d3e53c",
            "creation_date": "2022-05-31 17:35:04"
        }
    }
}

API Simulator

Initiate a live call to the Invoice/Create service using the API simulator.

customer_account_id

attached_items

due_date

custom_field_1

custom_field_2

auto_subscription_id

Your API credentials are missing, click "Set Credentials" to set them.

Invoice/Update

Update an existing invoice.

Invoices which are automatically generated by RecurringStack™ for a subscription can not be updated using this service.

Parameters

Parameter	Type	Required	Description
invoice_id	string	required	The 'invoice_id' you wish to update.
customer_account_id	string	required	The customer account you want to link the invoice to.
attached_items	string	optional	A list of items and their associated price you wish to add to the invoice in JSON format.
due_date	string	required	The date the invoice payment is due. Valid date format is M/D/YYYY.

PATCH https://api.recurringstack.com/{format}/Invoice/Update

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('invoice_id' => "",'customer_account_id' => "",'attached_items' => "",'due_date' => "");
try { $response = $rstack->request('Invoice/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="478911">
   <invoice invoice_id="39185e32-0d12-4371-b570-6761bfea2a21"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "478911"
    },
    "invoice": {
        "@attributes": {
            "invoice_id": "39185e32-0d12-4371-b570-6761bfea2a21"
        }
    }
}

API Simulator

Initiate a live call to the Invoice/Update service using the API simulator.

invoice_id

customer_account_id

attached_items

due_date

Your API credentials are missing, click "Set Credentials" to set them.

Invoice/Delete

Delete a previously created invoice. This function works for invoices automatically generated for subscriptions and manual created invoices.

This action is not reversable.

Parameters

Parameter	Type	Required	Description
invoice_id	string	required	The 'invoice_id" of the invoice you wish to delete.
customer_account_id	string	required	The customer account the invoice you wish to delete is associated with.

DELETE https://api.recurringstack.com/{format}/Invoice/Delete

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('invoice_id' => "",'customer_account_id' => "");
try { $response = $rstack->request('Invoice/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="478921">
   <invoice invoice_id="39185e32-0d12-4371-b570-6761bfea2a21" creation_date="2022-06-13 18:31:36" deletion_date="2022-06-14 15:13:16" status="3"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "478921"
    },
    "invoice": {
        "@attributes": {
            "invoice_id": "39185e32-0d12-4371-b570-6761bfea2a21",
            "creation_date": "2022-06-13 18:31:36",
            "deletion_date": "2022-06-14 15:13:16",
            "status": "3"
        }
    }
}

API Simulator

Initiate a live call to the Invoice/Delete service using the API simulator.

invoice_id

customer_account_id

Your API credentials are missing, click "Set Credentials" to set them.

Invoice/Reminder

Send the 'Invoice/Reminder' notification to a customer.

The 'Invoice/Reminder' notification must be setup to utilize this service.

Parameters

Parameter	Type	Required	Description
customer_account_id	string	required	The customer account the invoice is linked to.
invoice_id	string	required	The 'invoice_id' you wish to send the reminder email about.
bypass_overdue	string	optional	Normally the API checks if the invoice is at least a day overdue. To bypass this check provide a 'Y' value.

POST https://api.recurringstack.com/{format}/Invoice/Reminder

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('customer_account_id' => "",'invoice_id' => "",'bypass_overdue' => "");
try { $response = $rstack->request('Invoice/Reminder','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="482272">
	<invoice invoice_id="dd9c909f-c146-4682-bf76-7d4e3b7e8796" creation_date="2023-10-06 17:15:01" status="0"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "482272"
    },
    "invoice": {
        "@attributes": {
            "invoice_id": "dd9c909f-c146-4682-bf76-7d4e3b7e8796",
            "creation_date": "2023-10-06 17:15:01",
            "status": "0"
        }
    }
}

API Simulator

Initiate a live call to the Invoice/Reminder service using the API simulator.

customer_account_id

invoice_id

bypass_overdue

Your API credentials are missing, click "Set Credentials" to set them.

Your content here

Lorem ipsum dolor sit amet consectetur adipisicing elit. Qui, natus temporibus voluptate corporis possimus ab aut cumque.

Homepage

Quick Tips

You may remove all ID or Class names which contain _dm-, they are only used for demonstration.

Boxed Layout

Fluid Layout	Remove the `.boxed-layout` and `.centered-layout` classes from the `body`.
Centered Layout	Add a class `.centered-layout` to the `body`.
Boxed Layout	Add a class `.boxed-layout` to the `body`.
Boxed Layout with background image	Add background image to the `body`. <body class="boxed-layout" style='background-image: url("path_to_img/image.jpg");'> .. .. </body> Or it could be in your own class. .bg-img { background-image: url("path_to_img/image.jpg"); } <body class="boxed-layout bg-img"> .. .. </body>

Color Schemes

Replace the current Bootstrap CSS and Nifty CSS path with the new path of the CSS color schemes you wish to use.

This is where you can change the color scheme of your app / website.

<head>
    ...
    <title>My Project</title>
    ...

    <!-- STYLESHEETS -->
    <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--- -->

    <!-- Bootstrap CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/bootstrap.min.css">

    <!-- Nifty CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/nifty.min.css">

</head>

Header

Sticky header	Add a class `.hd--sticky` to the `#root`.
Expanded header	Add a class `.hd--expanded` to the `#root`.
Expanded header with overlapping content.	Add a class `.overlapping` to the `#content > .content__header`.
Disable rounded header.	Add a class `.rounded-0` to the `#content > .content__header`.

Navigation

Max navigation by default	Add a class `.mn--max` to the `#root`.
Min navigation by default	Add a class `.mn--min` to the `#root`.
OffCanvas navigation with PUSH mode by default	Add a class `.mn--push` to the `#root`.
OffCanvas navigation with SLIDE mode by default	Add a class `.mn--slide` to the `#root`.
OffCanvas navigation with REVEAL mode by default	Add a class `.mn--slide` to the `#root`.
Sticky navigation	Add a class `.mn--sticky` to the `#root`.
Create a ToggleButton for navigation	Add a class `.nav-toggler` to the button. Example :

Sidebar

Disable sidebar backdrop	Add a class `.sb--bd-0` to the `#root`.
Static position	Add a class `.sb--static` to the `#root`.
Stuck sidebar as the default mode	Add a class `.sb--stuck` to the `#root`.
Unite sidebar as the default mode	Add a class `.sb--unite` to the `#root`.
Pinned sidebar as the default mode	Add a class `.sb--pinned` to the `#root`.
Toggle visibility	Toggle the class `.sb--show` in the `#root`.
Create a ToggleButton for Sidebar	Add a class `.sidebar-toggler` to the button. Example :

Animations

Add the following class to the body to change the animation transition.

Transition function name	Class name
In Quart	`.in-quart`
Out Quart	`.out-quart`
In Back	`.in-back`
Out Back	`.out-back`
In Out Back	`.in-out-back`
easeInOutBack	`.easeInOutBack`
steps	`.steps`
jumping	`.jumping`
rubber	`.rubber`