Brand/List

List all of the brands connected to your RecurringStack™ account. Depending on your subscription, one RecurringStack™ account can support up to ten different brands.

Parameters
Parameter Type Required Description
search_brand_id string optional The ID number of a specific brand; omit to get all brands.
limit string optional The amount of brands to return. Default is all.
GET https://api.recurringstack.com/{format}/Brand/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('search_brand_id' => "",'limit' => "");
try { $response = $rstack->request('Brand/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <brand brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-16 13:16:56" status="1">
      <name>RecurringStack</name>
      <description>Account management and subscription billing made easy.</description>
      <logo_url>https://recurringstack.com/assets/img/logo.png</logo_url>
      <support>
         <email/>
         <link>https://app.recurringstack.com/tickets</link>
         <phone/>
      </support>
      <social_media>
         <facebook/>
         <twitter>https://twitter.com/hawktgroup</twitter>
         <youtube/>
         <instagram/>
      </social_media>
      <website>
         <website_url>https://recurringstack.com</website_url>
         <login_url>https://app.recurringstack.com</login_url>
      </website>
      <policys>
         <terms_url>https://RecurringStack.com/terms</terms_url>
         <privacy_url>https://RecurringStack.com/terms</privacy_url>
      </policys>
      <status>1</status>
   </brand>
</recurringstack>

{
    "brand": {
        "@attributes": {
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-02-16 13:16:56",
            "status": "1"
        },
        "name": "RecurringStack",
        "description": "Account management and subscription billing made easy.",
        "logo_url": "https:\/\/recurringstack.com\/assets\/img\/logo.png",
        "support": {
            "email": {},
            "link": "https:\/\/app.recurringstack.com\/tickets",
            "phone": {}
        },
        "social_media": {
            "facebook": {},
            "twitter": "https:\/\/twitter.com\/hawktgroup",
            "youtube": {},
            "instagram": {}
        },
        "website": {
            "website_url": "https:\/\/recurringstack.com",
            "login_url": "https:\/\/app.recurringstack.com"
        },
        "policys": {
            "terms_url": "https:\/\/RecurringStack.com\/terms",
            "privacy_url": "https:\/\/RecurringStack.com\/terms"
        },
        "status": "1"
    }
}

API Simulator

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

Brand/Create

Create a new brand or company.

Parameters
Parameter Type Required Description
name string required The name of the brand.
description string required A short description of the brand for your reference and meta tags.
logo_url string required The Url to the brands logo; valid file types are GIF PNG JPG and JPEG.
website_url string optional The Url to the brands web site if available.
website_login_url string optional The login Url for memebers of the brand if available.
support_email string optional A valid email address where customers can receive support.
support_link string optional Full Url link to an online support system if available.
support_phone string optional A support phone number if available.
terms_url string optional Full Url to the terms of service for the brand.
privacy_url string optional Full Url to the privacy policy for the brand.
social_media_facebook string optional Full Url to the brands Facebook profile if available.
social_media_twitter string optional Full Url to the brands Twitter profile if available.
social_media_youtube string optional Full Url to the brands YouTube profile if available.
social_media_instagram string optional Full Url to the brands Instagram profile if available.
POST https://api.recurringstack.com/{format}/Brand/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' => "",'logo_url' => "",'website_url' => "",'website_login_url' => "",'support_email' => "",'support_link' => "",'support_phone' => "",'terms_url' => "",'privacy_url' => "",'social_media_facebook' => "",'social_media_twitter' => "",'social_media_youtube' => "",'social_media_instagram' => "");
try { $response = $rstack->request('Brand/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <brand brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-16 13:16:56" status="1">
      <name>RecurringStack</name>
      <description>Account management and subscription billing made easy.</description>
      <logo_url>https://recurringstack.com/assets/img/logo.png</logo_url>
      <support>
         <email/>
         <link>https://app.recurringstack.com/tickets</link>
         <phone/>
      </support>
      <social_media>
         <facebook/>
         <twitter>https://twitter.com/hawktgroup</twitter>
         <youtube/>
         <instagram/>
      </social_media>
      <website>
         <website_url>https://recurringstack.com</website_url>
         <login_url>https://app.recurringstack.com</login_url>
      </website>
      <policys>
         <terms_url>https://RecurringStack.com/terms</terms_url>
         <privacy_url>https://RecurringStack.com/terms</privacy_url>
      </policys>
      <status>1</status>
   </brand>
</recurringstack>

{
    "brand": {
        "@attributes": {
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-02-16 13:16:56",
            "status": "1"
        },
        "name": "RecurringStack",
        "description": "Account management and subscription billing made easy.",
        "logo_url": "https:\/\/recurringstack.com\/assets\/img\/logo.png",
        "support": {
            "email": {},
            "link": "https:\/\/app.recurringstack.com\/tickets",
            "phone": {}
        },
        "social_media": {
            "facebook": {},
            "twitter": "https:\/\/twitter.com\/hawktgroup",
            "youtube": {},
            "instagram": {}
        },
        "website": {
            "website_url": "https:\/\/recurringstack.com",
            "login_url": "https:\/\/app.recurringstack.com"
        },
        "policys": {
            "terms_url": "https:\/\/RecurringStack.com\/terms",
            "privacy_url": "https:\/\/RecurringStack.com\/terms"
        },
        "status": "1"
    }
}

API Simulator

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

Brand/Update

Update an existing brand. Only pass the parameters you wish to update.

Parameters
Parameter Type Required Description
update_brand_id string required The 'brand_id' you want to update.
name string optional The name of the brand.
description string optional A short description of the brand for your reference and meta tags.
logo_url string optional The Url to the brands logo; valid file types are GIF PNG JPG and JPEG.
website_url string optional The Url to the brands web site if available.
website_login_url string optional The login Url for memebers of the brand if available.
support_email string optional A valid email address where customers can receive support.
support_link string optional Full Url link to an online support system if available.
support_phone string optional A support phone number if available.
terms_url string optional Full Url to the terms of service for the brand.
privacy_url string optional Full Url to the privacy policy for the brand.
social_media_facebook string optional Full Url to the brands Facebook profile if available.
social_media_twitter string optional Full Url to the brands Twitter profile if available.
social_media_youtube string optional Full Url to the brands YouTube profile if available.
social_media_instagram string optional Full Url to the brands Instagram profile if available.
PATCH https://api.recurringstack.com/{format}/Brand/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('update_brand_id' => "",'name' => "",'description' => "",'logo_url' => "",'website_url' => "",'website_login_url' => "",'support_email' => "",'support_link' => "",'support_phone' => "",'terms_url' => "",'privacy_url' => "",'social_media_facebook' => "",'social_media_twitter' => "",'social_media_youtube' => "",'social_media_instagram' => "");
try { $response = $rstack->request('Brand/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <brand brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-16 13:16:56" status="1">
      <name>RecurringStack</name>
      <description>Account management and subscription billing made easy.</description>
      <logo_url>https://recurringstack.com/assets/img/logo.png</logo_url>
      <support>
         <email/>
         <link>https://app.recurringstack.com/tickets</link>
         <phone/>
      </support>
      <social_media>
         <facebook/>
         <twitter>https://twitter.com/hawktgroup</twitter>
         <youtube/>
         <instagram/>
      </social_media>
      <website>
         <website_url>https://recurringstack.com</website_url>
         <login_url>https://app.recurringstack.com</login_url>
      </website>
      <policys>
         <terms_url>https://RecurringStack.com/terms</terms_url>
         <privacy_url>https://RecurringStack.com/terms</privacy_url>
      </policys>
      <status>1</status>
   </brand>
</recurringstack>

{
    "brand": {
        "@attributes": {
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-02-16 13:16:56",
            "status": "1"
        },
        "name": "RecurringStack",
        "description": "Account management and subscription billing made easy.",
        "logo_url": "https:\/\/recurringstack.com\/assets\/img\/logo.png",
        "support": {
            "email": {},
            "link": "https:\/\/app.recurringstack.com\/tickets",
            "phone": {}
        },
        "social_media": {
            "facebook": {},
            "twitter": "https:\/\/twitter.com\/hawktgroup",
            "youtube": {},
            "instagram": {}
        },
        "website": {
            "website_url": "https:\/\/recurringstack.com",
            "login_url": "https:\/\/app.recurringstack.com"
        },
        "policys": {
            "terms_url": "https:\/\/RecurringStack.com\/terms",
            "privacy_url": "https:\/\/RecurringStack.com\/terms"
        },
        "status": "1"
    }
}

API Simulator

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

Brand/Delete

Delete an existing brand.

This operation is currently non-reversable. If you have customers with subscriptions on the brand their subscriptions will no longer be billed and the brand_id can no longer be used for authentication with the API.

Parameters
Parameter Type Required Description
delete_brand_id string required The 'brand_id' you want to delete.
DELETE https://api.recurringstack.com/{format}/Brand/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('delete_brand_id' => "");
try { $response = $rstack->request('Brand/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <brand brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-16 13:16:56" deletion_date="2022-02-16 17:03:43" status="2"/>
</recurringstack>

{
    "brand": {
        "@attributes": {
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-02-16 13:16:56",
            "deletion_date": "2022-02-16 17:03:43",
            "status": "2"
        }
    }
}

API Simulator

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