Note/List

List notes connected to an account, subscription, or invoice.

If neither of 'customer_account_id', 'subscription_id', or 'invoice_id' is provided the last 15 notes from the brand will be returned.

Parameters

Parameter	Type	Required	Description
note_id	string	optional	Provide a 'note_id' to retreive details on a specific note (including previously deleted notes).
customer_account_id	string	optional	Provide a 'customer_account_id' to retrieve notes connected to a specific customers account.
subscription_id	string	optional	Provide a 'subscription_id' to retrieve notes connected to a specific subscription.
invoice_id	string	optional	Provice a 'invoice_id' to retrieve notes connected to a specefic subscription.

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

Response

<?xml version="1.0"?>
<recurringstack>
	<note note_id="9189da66-d8c3-423d-b624-3d5ba6a7a948" creation_date="2022-06-23 14:11:43" creation_date_friendly="June 23rd 2022" status="1">
		<links>
			<customer_account_id>0bfee5cb-9c9e-450a-8ef5-084e8c48f85f</customer_account_id>
			<subscription_id/>
			<invoice_id/>
		</links>
		<subject>Note Subject</subject>
		<contents>This is the contents of the note.</contents>
		<status>1</status>
	</note>
	<note note_id="65c73828-a445-4e84-ba41-503aa366f956" creation_date="2022-06-23 14:00:30" creation_date_friendly="June 23rd 2022" status="1">
		<links>
			<customer_account_id>0bfee5cb-9c9e-450a-8ef5-084e8c48f85f</customer_account_id>
			<subscription_id/>
			<invoice_id/>
		</links>
		<subject>Note Subject 2</subject>
		<contents>This is the contents of the note.</contents>
		<status>1</status>
	</note>
</recurringstack>

{
    "note": [
        {
            "@attributes": {
                "note_id": "9189da66-d8c3-423d-b624-3d5ba6a7a948",
                "creation_date": "2022-06-23 14:11:43",
                "creation_date_friendly": "June 23rd 2022",
                "status": "1"
            },
            "links": {
                "customer_account_id": "0bfee5cb-9c9e-450a-8ef5-084e8c48f85f",
                "subscription_id": {},
                "invoice_id": {}
            },
            "subject": "Note Subject",
            "contents": "This is the contents of the note.",
            "status": "1"
        },
        {
            "@attributes": {
                "note_id": "65c73828-a445-4e84-ba41-503aa366f956",
                "creation_date": "2022-06-23 14:00:30",
                "creation_date_friendly": "June 23rd 2022",
                "status": "1"
            },
            "links": {
                "customer_account_id": "0bfee5cb-9c9e-450a-8ef5-084e8c48f85f",
                "subscription_id": {},
                "invoice_id": {}
            },
            "subject": "Note Subject 2",
            "contents": "This is the contents of the note.",
            "status": "1"
        }
    ]
}

API Simulator

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

note_id

customer_account_id

subscription_id

invoice_id

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

Note/Create

Notes allow you to store short messages (or notes) on the stack and connect them with a customer account, invoice, or subscription for easy cross referencing.

If you have formatted data to store consider using one of 'custom_field_1' or 'custom_field_2', both of which are available on subscriptions, accounts, and invoices.

At least one of 'customer_account_id', 'subscription_id', or 'invoice_id' must be provided.

Parameters

Parameter	Type	Required	Description
customer_account_id	string	optional	Provide a 'customer_account_id' to link the note to a specific customers account.
subscription_id	string	optional	Provide a 'subscription_id' to link the note to a specific subscription.
invoice_id	string	optional	Provice a 'invoice_id' to link the note to a specefic subscription.
subject	string	required	A short subject for your note; 150 characters maximum.
contents	string	required	Plain text notes up to 5000 characters.

POST https://api.recurringstack.com/{format}/Note/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' => "",'subscription_id' => "",'invoice_id' => "",'subject' => "",'contents' => "");
try { $response = $rstack->request('Note/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="479150">
	<note note_id="65c73828-a445-4e84-ba41-503aa366f956" creation_date="2022-06-23 14:00:30" status="1">
		<links>
			<customer_account_id>0bfee5cb-9c9e-450a-8ef5-084e8c48f85f</customer_account_id>
			<subscription_id/>
			<invoice_id/>
		</links>
		<subject>Note Subject</subject>
		<contents>This is the contents of the note.</contents>
		<status>1</status>
	</note>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479150"
    },
    "note": {
        "@attributes": {
            "note_id": "65c73828-a445-4e84-ba41-503aa366f956",
            "creation_date": "2022-06-23 14:00:30",
            "status": "1"
        },
        "links": {
            "customer_account_id": "0bfee5cb-9c9e-450a-8ef5-084e8c48f85f",
            "subscription_id": {},
            "invoice_id": {}
        },
        "subject": "Note Subject",
        "contents": "This is the contents of the note.",
        "status": "1"
    }
}

API Simulator

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

customer_account_id

subscription_id

invoice_id

subject

contents

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

Note/Delete

Delete an existing note.

This action is not reversable.

Parameters

Parameter	Type	Required	Description
note_id	string	required	The 'note_id' you wish to delete.

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

Response

<?xml version="1.0"?>
<recurringstack transaction_id="479157">
  <note note_id="9189da66-d8c3-423d-b624-3d5ba6a7a948" creation_date="2022-06-23 14:11:43" deletion_date="2022-06-23 14:39:19" status="3"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479157"
    },
    "note": {
        "@attributes": {
            "note_id": "9189da66-d8c3-423d-b624-3d5ba6a7a948",
            "creation_date": "2022-06-23 14:11:43",
            "deletion_date": "2022-06-23 14:39:19",
            "status": "3"
        }
    }
}

API Simulator

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

note_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`