DunningRule/List

List all dunning rules for one or more product groups.

Parameters

Parameter	Type	Required	Description
product_group_id	string	optional	Specificy a 'product_group_id' to get dunning rules from a specific product group.

GET https://api.recurringstack.com/{format}/DunningRule/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('product_group_id' => "");
try { $response = $rstack->request('DunningRule/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack>
  <dunningrule rule_id="8ea57fad-d3cd-4760-8148-a376d2bf8eb8" product_group_id="08452e87-214e-44c7-ae1a-c23822c7449f" creation_date="2023-10-04 21:43:26" status="1">
    <name>First Dunning Rule</name>
    <description/>
    <overdue_days>7</overdue_days>
    <overdue_amount>15.00</overdue_amount>
    <enforcement_action>SUSPEND</enforcement_action>
    <post_url/>
    <status>1</status>
  </dunningrule>
</recurringstack>

{
    "dunningrule": {
        "@attributes": {
            "rule_id": "8ea57fad-d3cd-4760-8148-a376d2bf8eb8",
            "product_group_id": "08452e87-214e-44c7-ae1a-c23822c7449f",
            "creation_date": "2023-10-04 21:43:26",
            "status": "1"
        },
        "name": "First Dunning Rule",
        "description": {},
        "overdue_days": "7",
        "overdue_amount": "15.00",
        "enforcement_action": "SUSPEND",
        "post_url": {},
        "status": "1"
    }
}

API Simulator

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

product_group_id

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

DunningRule/Create

Create a new dunning rule. Dunning rules determine when a subscription is suspended or deleted based on the status of past-due invoices linked to the subscription.

Dunning rules do not apply to manually created or non-subscription linked invoices.

All dunning rules must be linked to a product group.

A single product group can have multiple dunning rules and if both rules match they will both execute at the same time (ie. you can have a 'POST' and a 'SUSPEND' rule on the same overdue day).

enforcement_action can be one of SUSPEND, DELETE, REMIND, or POST.

SUSPEND : Suspends the subscription associated with the invoice ('status' = 2).

DELETE : Delete or cancel the subscription associated with the invoice ('status' = 3).

REMIND : Sends the 'Invoice/Reminder' notification to the customer associated with the invoice.

POST : Sends a POST request to the specified 'post_url' containing the 'invoice_id', 'customer_account_id', 'outstanding_balance', and 'overdue_days' parameters.

Parameters

Parameter	Type	Required	Description
product_group_id	string	required	Specificy a 'product_group_id' to link with the dunning rule. The new rule will apply to subscriptions utilizing products in this product group only.
name	string	required	A name of your choosing for the dunning rule.
description	string	required	A description of the rule of at least 15 characters for your reference
overdue_days	string	required	The days an invoice on the subscription must be overdue before this rule takes effect. This must be an exact match for the overdue days (ie. with an 'overdue_days' value of 5 an invoice overdue 5 days would match the rule while an invoice overdue 6 days would not).
overdue_amount	string	required	The total unpaid amount due on a specific invoice for this rule to take effect in full dollar format (ie. 20.00)
enforcement_action	string	required	The action to take when the rule is matched; valid choices are 'SUSPEND'; 'DELETE'; 'REMIND'; 'POST'.
post_url	string	optional	If the 'enforcement_action' is 'POST' provide the fully qualified url where the POST request should be directed.

POST https://api.recurringstack.com/{format}/DunningRule/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('product_group_id' => "",'name' => "",'description' => "",'overdue_days' => "",'overdue_amount' => "",'enforcement_action' => "",'post_url' => "");
try { $response = $rstack->request('DunningRule/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="482041">
	<dunningrule rule_id="8ea57fad-d3cd-4760-8148-a376d2bf8eb8" product_group_id="08452e87-214e-44c7-ae1a-c23822c7449f" creation_date="2023-10-04 14:52:18" status="1">
		<name>First Dunning Rule</name>
		<description>Suspends subscriptions after 7 days of past due payments.</description>
		<overdue_days>7</overdue_days>
		<overdue_amount>15.00</overdue_amount>
		<enforcement_action>SUSPEND</enforcement_action>
		<post_url/>
		<status>1</status>
	</dunningrule>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "482041"
    },
    "dunningrule": {
        "@attributes": {
            "rule_id": "8ea57fad-d3cd-4760-8148-a376d2bf8eb8",
            "product_group_id": "08452e87-214e-44c7-ae1a-c23822c7449f",
            "creation_date": "2023-10-04 14:52:18",
            "status": "1"
        },
        "name": "First Dunning Rule",
        "description": "Suspends subscriptions after 7 days of past due payments.",
        "overdue_days": "7",
        "overdue_amount": "15.00",
        "enforcement_action": "SUSPEND",
        "post_url": {},
        "status": "1"
    }
}

API Simulator

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

product_group_id

name

description

overdue_days

overdue_amount

enforcement_action

post_url

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

DunningRule/Update

Update an existing dunning rule.

Parameters

Parameter	Type	Required	Description
rule_id	string	required	The 'rule_id' of the rule you wish to update.
product_group_id	string	required	Specificy a 'product_group_id' to link with the dunning rule. The new rule will apply to subscriptions utilizing products in this product group only
name	string	required	A name of your choosing for the dunning rule.
description	string	required	A description of the rule of at least 15 characters for your reference
overdue_days	string	required	The days an invoice on the subscription must be overdue before this rule takes effect.
overdue_amount	string	required	The total overdue amount of a specific invoice due for this rule to take effect in full dollar format (ie. 25.50)
enforcement_action	string	required	The action to take when the rule is matched; valid choices are 'SUSPEND'; 'DELETE'; 'REMIND'; 'POST'.
post_url	string	optional	If the 'enforcement_action' is 'POST' provide the fully qualified url where the POST request should be directed.

PATCH https://api.recurringstack.com/{format}/DunningRule/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('rule_id' => "",'product_group_id' => "",'name' => "",'description' => "",'overdue_days' => "",'overdue_amount' => "",'enforcement_action' => "",'post_url' => "");
try { $response = $rstack->request('DunningRule/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="482041">
	<dunningrule rule_id="8ea57fad-d3cd-4760-8148-a376d2bf8eb8" product_group_id="08452e87-214e-44c7-ae1a-c23822c7449f" creation_date="2023-10-04 14:52:18" status="1">
		<name>First Dunning Rule Update</name>
		<description>Suspends subscriptions after 7 days of past due payments.</description>
		<overdue_days>7</overdue_days>
		<overdue_amount>15.00</overdue_amount>
		<enforcement_action>SUSPEND</enforcement_action>
		<post_url/>
		<status>1</status>
	</dunningrule>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "482041"
    },
    "dunningrule": {
        "@attributes": {
            "rule_id": "8ea57fad-d3cd-4760-8148-a376d2bf8eb8",
            "product_group_id": "08452e87-214e-44c7-ae1a-c23822c7449f",
            "creation_date": "2023-10-04 14:52:18",
            "status": "1"
        },
        "name": "First Dunning Rule Update",
        "description": "Suspends subscriptions after 7 days of past due payments.",
        "overdue_days": "7",
        "overdue_amount": "15.00",
        "enforcement_action": "SUSPEND",
        "post_url": {},
        "status": "1"
    }
}

API Simulator

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

rule_id

product_group_id

name

description

overdue_days

overdue_amount

enforcement_action

post_url

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

DunningRule/Delete

Deletes an pre-existing dunning rule.

Parameters

Parameter	Type	Required	Description
rule_id	string	required	The 'rule_id' of the rule you wish to delete.

DELETE https://api.recurringstack.com/{format}/DunningRule/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('rule_id' => "");
try { $response = $rstack->request('DunningRule/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="482043">
  <dunningrule rule_id="8ea57fad-d3cd-4760-8148-a376d2bf8eb8" creation_date="2023-10-04 14:52:18" deletion_date="2023-10-04 21:48:42" status="3"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "482043"
    },
    "dunningrule": {
        "@attributes": {
            "rule_id": "8ea57fad-d3cd-4760-8148-a376d2bf8eb8",
            "creation_date": "2023-10-04 14:52:18",
            "deletion_date": "2023-10-04 21:48:42",
            "status": "3"
        }
    }
}

API Simulator

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

rule_id

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`