ProductGroup/List

List product groups for a brand.

Parameters
Parameter Type Required Description
product_group_id string optional Specificy a 'product_group_id' to get details for a specific product group.
GET https://api.recurringstack.com/{format}/ProductGroup/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('ProductGroup/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <productgroup product_group_id="5c31a8ce-e9f9-4a2d-8822-5e87f5a3bb51" brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-03-02 21:54:36" status="1">
      <name>Hosting Subscriptions</name>
      <description>All hosting plans are in this product group, when a web hosting package is purchased it's provisioned instantly using the order_action_url.</description>
      <status>1</status>
      <action_urls>
         <order_action_url>https://superhosting.in/actions_cripts/order.asp</order_action_url>
         <renew_action_url/>
         <swap_action_url/>
         <status_action_url/>
         <cancel_action_url/>
      </action_urls>
      <variables>
         <VAR1 TYPE="TEXT" OPTIONS="" DESCRIPTION="The domain name to provision on WHMCS." SWAPABLE="Y" PROMPT="Y" CATEGORY="Domain Information">Domain Name</VAR1>
         <VAR2 TYPE="TEXT" OPTIONS="" DESCRIPTION="The account ID on cPanel." SWAPABLE="N" PROMPT="" CATEGORY="Account Linking">HostingID</VAR2>
      </variables>
   </productgroup>
</recurringstack>

{
    "productgroup": {
        "@attributes": {
            "product_group_id": "5c31a8ce-e9f9-4a2d-8822-5e87f5a3bb51",
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-03-02 21:54:36",
            "status": "1"
        },
        "name": "Hosting Subscriptions",
        "description": "All hosting plans are in this product group, when a web hosting package is purchased it's provisioned instantly using the order_action_url.",
        "status": "1",
        "action_urls": {
            "order_action_url": "https:\/\/superhosting.in\/actions_cripts\/order.asp",
            "renew_action_url": {},
            "swap_action_url": {},
            "status_action_url": {},
            "cancel_action_url": {}
        },
        "variables": {
            "VAR1": "Domain Name",
            "VAR2": "HostingID"
        }
    }
}

API Simulator

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

ProductGroup/Create

Create and associate a new product group for a brand.

Variables are infromation stored on subscriptions in the product group. Ten variable slots are offered (VAR1 - VAR10). For example, if a hosting company wanted to collect & store the customers domain name at the time a subscription is created you could name the "VAR1" field "Domain Name". Variables must be posted to the API in JSON format.

Example Variable Format:
{"name": "Domain Name","prompt": "Y","type": "TEXT","options": "","description": "Enter the domain name for your hosting package.","swapable": "Y","category": "Domain Info"}

Learn more about variables and action Url's.

Parameters
Parameter Type Required Description
name string required The name of the product group.
description string required A short description of the product group.
action_url string optional A 'Url' where RecurringStack will post all order variables when events occur on subscriptions for a product in the product group. The 'action_url' will be notified for the following events: 'new_subscription'; 'renew_subscription'; 'swap_subscription'; 'status_subscription'; and 'cancel_subscrption'.
VAR1 string optional The value of variable 1 in the proper variable format.
VAR2 string optional The value of variable 2 in the proper variable format.
VAR3 string optional The value of variable 3 in the proper variable format.
VAR4 string optional The value of variable 4 in the proper variable format.
VAR5 string optional The value of variable 5 in the proper variable format.
VAR6 string optional The value of variable 6 in the proper variable format.
VAR7 string optional The value of variable 7 in the proper variable format.
VAR8 string optional The value of variable 8 in the proper variable format.
VAR9 string optional The value of variable 9 in the proper variable format.
VAR10 string optional The value of variable 10 in the proper variable format.
POST https://api.recurringstack.com/{format}/ProductGroup/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('name' => "",'description' => "",'action_url' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "");
try { $response = $rstack->request('ProductGroup/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0"?>
<recurringstack>
  <productgroup product_group_id="c62f23f1-055f-4cfa-8c5e-d45fbaae30ec" brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-03-28 13:44:48" status="1">
    <name>Shared Hosting Packages</name>
    <description>All shared hosting products and components belong to this product group.</description>
    <action_url>https://hostingcompany.com/file_on_your_server_for_events.asp</action_url>
    <status>1</status>
    <variables>
      <VAR1 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the domain name for your hosting package." SWAPABLE="Y" PROMPT="Y" CATEGORY="Domain Info">Domain_Name</VAR1>
    </variables>
  </productgroup>
</recurringstack>

{
    "productgroup": {
        "@attributes": {
            "product_group_id": "c62f23f1-055f-4cfa-8c5e-d45fbaae30ec",
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-03-28 13:44:48",
            "status": "1"
        },
        "name": "Shared Hosting Packages",
        "description": "All shared hosting products and components belong to this product group.",
        "action_url": "https:\/\/hostingcompany.com\/file_on_your_server_for_events.asp",
        "status": "1",
        "variables": {
            "VAR1": "Domain_Name"
        }
    }
}

API Simulator

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

ProductGroup/Update

Update an existing product group.

Parameters
Parameter Type Required Description
product_group_id string required The 'product_group_id' of the product group you want to update.
name string optional The name of the product group.
description string optional A short description of the product group.
action_url string optional A 'Url' where RecurringStack will post all order variables when events occur on subscriptions for a product in the product group. The 'action_url' will be notified for the following events: 'new_subscription'; 'renew_subscription'; 'swap_subscription'; 'status_subscription'; and 'cancel_subscrption'.
VAR1 string optional The value of variable 1 in the proper variable format.
VAR2 string optional The value of variable 2 in the proper variable format.
VAR3 string optional The value of variable 3 in the proper variable format.
VAR4 string optional The value of variable 4 in the proper variable format.
VAR5 string optional The value of variable 5 in the proper variable format.
VAR6 string optional The value of variable 6 in the proper variable format.
VAR7 string optional The value of variable 7 in the proper variable format.
VAR8 string optional The value of variable 8 in the proper variable format.
VAR9 string optional The value of variable 9 in the proper variable format.
VAR10 string optional The value of variable 10 in the proper variable format.
PATCH https://api.recurringstack.com/{format}/ProductGroup/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_group_id' => "",'name' => "",'description' => "",'action_url' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "");
try { $response = $rstack->request('ProductGroup/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0"?>
<recurringstack>
  <productgroup product_group_id="c62f23f1-055f-4cfa-8c5e-d45fbaae30ec" brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-03-28 13:44:48" status="1">
    <name>Shared Hosting Packages</name>
    <description>All shared hosting products and components belong to this product group.</description>
    <action_url>https://hostingcompany.com/file_on_your_server_for_events.asp</action_url>
    <status>1</status>
    <variables>
      <VAR1 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the domain name for your hosting package." SWAPABLE="Y" PROMPT="Y" CATEGORY="Domain Info">Domain_Name</VAR1>
    </variables>
  </productgroup>
</recurringstack>

{
    "productgroup": {
        "@attributes": {
            "product_group_id": "c62f23f1-055f-4cfa-8c5e-d45fbaae30ec",
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-03-28 13:44:48",
            "status": "1"
        },
        "name": "Shared Hosting Packages",
        "description": "All shared hosting products and components belong to this product group.",
        "action_url": "https:\/\/hostingcompany.com\/file_on_your_server_for_events.asp",
        "status": "1",
        "variables": {
            "VAR1": "Domain_Name"
        }
    }
}

API Simulator

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

ProductGroup/Suspend

Temporarily suspend a product group.

While suspended, customers with subscriptions to products within the group will not be billed and new subscriptions for the products will not be accepted.

Parameters
Parameter Type Required Description
product_group_id string required The 'product_group_id' you want to suspend.
PATCH https://api.recurringstack.com/{format}/ProductGroup/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_group_id' => "");
try { $response = $rstack->request('ProductGroup/Suspend','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <productgroup product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98" creation_date="2022-03-03 13:05:58" status="2"/>
</recurringstack>

{
    "productgroup": {
        "@attributes": {
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98",
            "creation_date": "2022-03-03 13:05:58",
            "status": "2"
        }
    }
}

API Simulator

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

ProductGroup/Delete

Utilize this service to delete an existing product group.

Although this action is reversable using the 'ProductGoup/Restore' service, any customers with subscriptions to products in the product group will not have their subscription restored and will need to subscribe to any previous subscription again.

Parameters
Parameter Type Required Description
product_group_id string required The 'product_group_id' you wish to delete.
DELETE https://api.recurringstack.com/{format}/ProductGroup/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_group_id' => "");
try { $response = $rstack->request('ProductGroup/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <productgroup product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98" creation_date="2022-03-03 13:05:58" deletion_date="2022-03-04 08:58:24" status="3"/>
</recurringstack>

{
    "productgroup": {
        "@attributes": {
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98",
            "creation_date": "2022-03-03 13:05:58",
            "deletion_date": "2022-03-04 08:58:24",
            "status": "3"
        }
    }
}

API Simulator

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

ProductGroup/Restore

Restore a product group from suspended or deleted status.

Parameters
Parameter Type Required Description
product_group_id string required The 'product_group_id' of the product group you want to restore.
PATCH https://api.recurringstack.com/{format}/ProductGroup/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_group_id' => "");
try { $response = $rstack->request('ProductGroup/Restore','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <productgroup product_group_id="e4d23994-d6e2-45a8-91b0-d882b248dc98" creation_date="2022-03-03 13:05:58" status="1"/>
</recurringstack>

{
    "productgroup": {
        "@attributes": {
            "product_group_id": "e4d23994-d6e2-45a8-91b0-d882b248dc98",
            "creation_date": "2022-03-03 13:05:58",
            "status": "1"
        }
    }
}

API Simulator

Initiate a live call to the ProductGroup/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.