Product/List

Search products for a brand. Provide a 'product_id' to find a specific product (including a deleted one).

Parameters
Parameter Type Required Description
product_id string optional Provide 'product_id' to list details on a specific product.
product_group_id string optional Provide a 'product_group_id' to return products associated with a specific product group.
custom_field_1 string optional Search using the value of custom field 1.
custom_field_2 string optional Search using the the value of custom field 2.
GET https://api.recurringstack.com/{format}/Product/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_id' => "",'product_group_id' => "",'custom_field_1' => "",'custom_field_2' => "");
try { $response = $rstack->request('Product/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d" creation_date="2022-03-09 18:14:32" prompt_for_variables="Y" status="1">
      <name>Something</name>
      <description>Something new</description>
      <pricing>
         <setup_fee>10.00</setup_fee>
         <recurring_price>14589.00</recurring_price>
         <tax_exempt>Y</tax_exempt>
         <trial has_trial="Y">
            <interval>15</interval>
            <price>1000.00</price>
         </trial>
         <discount>
            <auto_pay_discount>Y</auto_pay_discount>
            <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
         </discount>
      </pricing>
      <cycle>
         <expiration_interval friendly_expiration_interval="10 Day(s)">10</expiration_interval>
      </cycle>
      <custom_field_1>Field 1</custom_field_1>
      <custom_field_2>Field 2</custom_field_2>
      <status>1</status>
   </product>
</recurringstack>

{
    "product": {
        "@attributes": {
            "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d",
            "creation_date": "2022-03-09 18:14:32",
            "prompt_for_variables": "Y",
            "status": "1"
        },
        "name": "Something",
        "description": "Something new",
        "pricing": {
            "setup_fee": "10.00",
            "recurring_price": "14589.00",
            "tax_exempt": "Y",
            "trial": {
                "@attributes": {
                    "has_trial": "Y"
                },
                "interval": "15",
                "price": "1000.00"
            },
            "discount": {
                "auto_pay_discount": "Y",
                "auto_pay_discount_amount": "5.00"
            }
        },
        "cycle": {
            "expiration_interval": "10"
        },
        "custom_field_1": "Field 1",
        "custom_field_2": "Field 2",
        "status": "1"
    }
}

API Simulator

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

Product/Create

Create a product.

Parameters
Parameter Type Required Description
product_group_id string required The Product Group the product will belong to.
name string required The product name.
description string required A short description of the product.
expiration_interval string required A numerical interval represented in days for the length a subscription to this product will run before it expires. For a subscription that never renews (a one-time purchase) provide a value of zero (eg. 0)
setup_fee string required The intial setup or activation fee for the product in full dollar amount (eg. 5.00 or 0.00). This fee will be charged in addition to any setup fee charged for any components.
recurring_price string required The recurring price of the product in full dollar amount (eg. 10.50).
trial string required Wether or not a trial period is offered for subscriptions to this product; acceptable values are 'Y' for yes and 'N' for no.
trial_interval string optional A numerical interval represented in days for the trial period for a subscription to this product.
trial_price string optional The price of the trial for a subscription to this product in full dollar amount. To offer a free trial provide a value of '0.00'.
auto_pay_discount string required 'Y' or 'N' if the product is eligibile for a discount when payment is processed automatically.
auto_pay_discount_amount string optional The amount of the automatic payment discount in full dollar amount (eg. 10.50). Required if 'auto_pay_discount' is set to 'Y'.
prompt_for_variables string required If the customer should be prompted for the variables in the product group at the time a subscription is created for this product; 'Y' for yes and 'N' for no. Only variables with 'Prompt' set to 'Y' will be prompted.
tax_exempt string required 'Y' or 'N' if the subscription is tax exampt. If the customer 'Account' is tax exempt this will be disregarded.
custom_field_1 string optional A custom field for your records.
custom_field_2 string optional A custom field for your records.
POST https://api.recurringstack.com/{format}/Product/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' => "",'expiration_interval' => "",'setup_fee' => "",'recurring_price' => "",'trial' => "",'trial_interval' => "",'trial_price' => "",'auto_pay_discount' => "",'auto_pay_discount_amount' => "",'prompt_for_variables' => "",'tax_exempt' => "",'custom_field_1' => "",'custom_field_2' => "");
try { $response = $rstack->request('Product/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d" creation_date="2022-03-09 18:14:32" prompt_for_variables="Y" status="1">
      <name>Full System Access</name>
      <description>You'll get full access to the system with this package.</description>
      <pricing>
         <setup_fee>0.00</setup_fee>
         <recurring_price>50.00</recurring_price>
         <tax_exempt>Y</tax_exempt>
         <trial has_trial="Y">
            <interval>7</interval>
            <price>1.00</price>
         </trial>
         <discount>
            <auto_pay_discount>Y</auto_pay_discount>
            <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
         </discount>
      </pricing>
      <cycle>
         <expiration_interval friendly_expiration_interval="30 Day(s)">30</expiration_interval>
      </cycle>
      <custom_field_1/>
      <custom_field_2/>
      <status>1</status>
   </product>
</recurringstack>

{
    "product": {
        "@attributes": {
            "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d",
            "creation_date": "2022-03-09 18:14:32",
            "prompt_for_variables": "Y",
            "status": "1"
        },
        "name": "Full System Access",
        "description": "You'll get full access to the system with this package.",
        "pricing": {
            "setup_fee": "0.00",
            "recurring_price": "50.00",
            "tax_exempt": "Y",
            "trial": {
                "@attributes": {
                    "has_trial": "Y"
                },
                "interval": "7",
                "price": "1.00"
            },
            "discount": {
                "auto_pay_discount": "Y",
                "auto_pay_discount_amount": "5.00"
            }
        },
        "cycle": {
            "expiration_interval": "30"
        },
        "custom_field_1": {},
        "custom_field_2": {},
        "status": "1"
    }
}

API Simulator

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

Product/Update

Update a product.

'product_group_id' can't be changed after the product is created.

Parameters
Parameter Type Required Description
product_id string required The 'product_id' of the product you want to edit.
name string required The product name.
description string required A short description of the product.
expiration_interval string required A numerical interval represented in days for the length a subscription to this product will run before it expires. For a subscription that never renews (a one-time purchase) provide a value of zero (eg. 0)
setup_fee string required The intial setup or activation fee for the product in full dollar amount (eg. 5.00 or 0.00). This fee will be charged in addition to any setup fee charged for any components.
recurring_price string required The recurring price of the product in full dollar amount (eg. 10.50).
trial string required Whether or not a trial period is offered for subscriptions to this product; acceptable values are 'Y' for yes and 'N' for no.
trial_interval string optional A numerical interval represented in days for the trial period for a subscription to this product.
trial_price string optional The price of the trial for a subscription to this product in full dollar amount. To offer a free trial provide a value of '0.00'.
auto_pay_discount string required 'Y' or 'N' if the product is eligibile for a discount when payment is processed automatically.
auto_pay_discount_amount string optional The amount of the automatic payment discount in full dollar amount (eg. 10.50). Required if 'auto_pay_discount' is set to 'Y'.
prompt_for_variables string required If the customer should be prompted for the variables in the product group at the time a subscription is created for this product; 'Y' for yes and 'N' for no. Only variables with 'Prompt' set to 'Y' will be prompted.
tax_exempt string required 'Y' or 'N' if the subscription is tax exampt. If the customer 'Account' is tax exempt this will be disregarded.
custom_field_1 string optional A custom field for your records.
custom_field_2 string optional A custom field for your records.
PATCH https://api.recurringstack.com/{format}/Product/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('product_id' => "",'name' => "",'description' => "",'expiration_interval' => "",'setup_fee' => "",'recurring_price' => "",'trial' => "",'trial_interval' => "",'trial_price' => "",'auto_pay_discount' => "",'auto_pay_discount_amount' => "",'prompt_for_variables' => "",'tax_exempt' => "",'custom_field_1' => "",'custom_field_2' => "");
try { $response = $rstack->request('Product/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d" creation_date="2022-03-09 18:14:32" prompt_for_variables="Y" status="1">
      <name>Something</name>
      <description>Something new</description>
      <pricing>
         <setup_fee>10.00</setup_fee>
         <recurring_price>14589.00</recurring_price>
         <tax_exempt>Y</tax_exempt>
         <trial has_trial="Y">
            <interval>15</interval>
            <price>1000.00</price>
         </trial>
         <discount>
            <auto_pay_discount>Y</auto_pay_discount>
            <auto_pay_discount_amount>5.00</auto_pay_discount_amount>
         </discount>
      </pricing>
      <cycle>
         <expiration_interval friendly_expiration_interval="10 Day(s)">10</expiration_interval>
      </cycle>
      <custom_field_1>Field 1</custom_field_1>
      <custom_field_2>Field 2</custom_field_2>
      <status>1</status>
   </product>
</recurringstack>

{
    "product": {
        "@attributes": {
            "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d",
            "creation_date": "2022-03-09 18:14:32",
            "prompt_for_variables": "Y",
            "status": "1"
        },
        "name": "Something",
        "description": "Something new",
        "pricing": {
            "setup_fee": "10.00",
            "recurring_price": "14589.00",
            "tax_exempt": "Y",
            "trial": {
                "@attributes": {
                    "has_trial": "Y"
                },
                "interval": "15",
                "price": "1000.00"
            },
            "discount": {
                "auto_pay_discount": "Y",
                "auto_pay_discount_amount": "5.00"
            }
        },
        "cycle": {
            "expiration_interval": "10"
        },
        "custom_field_1": "Field 1",
        "custom_field_2": "Field 2",
        "status": "1"
    }
}

API Simulator

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

Product/Suspend

Suspend a product.

A product placed in suspend cannot be part of a new subscription. Existing subscriptions will continue to be billed for the product. To remove the product from existing subscriptions use 'Product/Delete' instead.

Parameters
Parameter Type Required Description
product_id string required The 'product_id' of the product you want to suspend.
PATCH https://api.recurringstack.com/{format}/Product/Suspend 
//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_id' => "");
try { $response = $rstack->request('Product/Suspend','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d" creation_date="2022-03-09 18:14:32" status="2"/>
</recurringstack>

{
    "product": {
        "@attributes": {
            "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d",
            "creation_date": "2022-03-09 18:14:32",
            "status": "2"
        }
    }
}

API Simulator

Initiate a live call to the Product/Suspend service using the API simulator.

Product/Delete

Delete a product.

Deleting a product make it unavailable for new subscribcriptions and removes it from existing subscriptions. Although products can be restored up to 90 days later it will no longer be attached to subscriptions it was linked with before deletion.

Parameters
Parameter Type Required Description
product_id string required The 'product_id' you wish to delete.
DELETE https://api.recurringstack.com/{format}/Product/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('product_id' => "");
try { $response = $rstack->request('Product/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d" creation_date="2022-03-09 18:14:32" deletion_date="2022-03-10 14:16:25" status="3"/>
</recurringstack>

{
    "product": {
        "@attributes": {
            "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d",
            "creation_date": "2022-03-09 18:14:32",
            "deletion_date": "2022-03-10 14:16:25",
            "status": "3"
        }
    }
}

API Simulator

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

Product/Restore

Restore a product.

You can restore a product from suspended (2) or deleted (3) status for up to 90 days.

Parameters
Parameter Type Required Description
product_id string required The 'product_id' of the product you want to restore.
PATCH https://api.recurringstack.com/{format}/Product/Restore 
//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_id' => "");
try { $response = $rstack->request('Product/Restore','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <product product_id="96027df1-7b53-42ef-b097-b1b3d70e207d" creation_date="2022-03-09 18:14:32" deletion_date="2022-03-10 14:16:25" status="1"/>
</recurringstack>

{
    "product": {
        "@attributes": {
            "product_id": "96027df1-7b53-42ef-b097-b1b3d70e207d",
            "creation_date": "2022-03-09 18:14:32",
            "deletion_date": "2022-03-10 14:16:25",
            "status": "1"
        }
    }
}

API Simulator

Initiate a live call to the Product/Restore service using the API simulator.
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.

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
Tips on this page :
RecurringStack Documentation
RecurringStack Docs
RecurringStack Simulator API Credentials
A valid API key associated with your RecurringStack™ account.
The user key associated with your RecurringStack™ login.
The 'brand_id' associated with one of your brands.
NOTE: Your credentials will not be validated.

Sign In

Background Images

Add an image to replace the solid background color
Blurred
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Polygon & Geometric
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Abstract
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Layouts
Layouts
Transitions
Header
Additional Offcanvas New in BS v.5.0

Select the offcanvas placement.

Sidebars
Navigation
Right sidebar
Color Schemes
Light Completely bright color themes.
Dark Completely dark color themes.
Expanded Header
Fair Header
Full Header
Primary Nav
Brand
Tall Header New in v3.0
Scrollbars

Hides native scrollbars and creates custom styleable overlay scrollbars.

Offcanvas Header
Content Here

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Sapiente eos nihil earum aliquam quod in dolor, aspernatur obcaecati et at. Dicta, ipsum aut, fugit nam dolore porro non est totam sapiente animi recusandae obcaecati dolorum, rem ullam cumque. Illum quidem reiciendis autem neque excepturi odit est accusantium, facilis provident molestias, dicta obcaecati itaque ducimus fuga iure in distinctio voluptate nesciunt dignissimos rem error a. Expedita officiis nam dolore dolores ea. Soluta repellendus delectus culpa quo. Ea tenetur impedit error quod exercitationem ut ad provident quisquam omnis! Nostrum quasi ex delectus vero, facilis aut recusandae deleniti beatae. Qui velit commodi inventore.