Subscriptions: Create subscription

Unbilled Charges

Unbilled charge is that charge which is held by passing invoice later in the various operations including add charge, create subscription, update subscription, etc. The Unbilled Charge element separates the reation of subscription associated charges from the invoicing them. The creation of any automatic invoice like the activation, renewal, etc., will comprise the unbilled charges.

List Unbilled Charges

List Unbilled Charges limits the number of resources to be returned and allow you to fetch the next set of resources.

Sample Code / Result:


$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://apiv1.chargemonk.com/listSubscriptionUnbilledCharges",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => array('api_token' => 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH'),
  ));

  $response = curl_exec($curl);

  curl_close($curl);
  echo $response;


{
    "status": "success",
    "data": [
        {
            "unbilledCode": "ggx9fDhF",
            "subscriptionCode": "7GabLuca",
            "description": "September Unbilled Charge",
            "amount": "50.00",
            "created_at": 1602672598,
            "status": "pending",
            "quantity": 11
        }
}

Code
Out Put


$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://apiv1.chargemonk.com/listSubscriptionUnbilledCharges');
$request->setRequestMethod('POST');
$body = new http\Message\Body;
$body->addForm(array(
  'api_token' => 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH'
), array(

));
$request->setBody($body);
$request->setOptions(array());

$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();


{
    "status": "success",
    "data": [
        {
            "unbilledCode": "ggx9fDhF",
            "subscriptionCode": "7GabLuca",
            "description": "September Unbilled Charge",
            "amount": "50.00",
            "created_at": 1602672598,
            "status": "pending",
            "quantity": 11
        }
}

Code
Out Put


curl --location --request POST 'https://apiv1.chargemonk.com/listSubscriptionUnbilledCharges' \
--form 'api_token=test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH'


{
    "status": "success",
    "data": [
        {
            "unbilledCode": "ggx9fDhF",
            "subscriptionCode": "7GabLuca",
            "description": "September Unbilled Charge",
            "amount": "50.00",
            "created_at": 1602672598,
            "status": "pending",
            "quantity": 11
        }
}

Code
Out Put


require "uri"
require "net/http"

url = URI("https://apiv1.chargemonk.com/listSubscriptionUnbilledCharges")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
form_data = [['api_token', 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH']]
request.set_form form_data, 'multipart/form-data'
response = http.request(request)
puts response.read_body


{
    "status": "success",
    "data": [
        {
            "unbilledCode": "ggx9fDhF",
            "subscriptionCode": "7GabLuca",
            "description": "September Unbilled Charge",
            "amount": "50.00",
            "created_at": 1602672598,
            "status": "pending",
            "quantity": 11
        }
}

Code
Out Put


import requests
url = "https://apiv1.chargemonk.com/listSubscriptionUnbilledCharges"
payload = {'api_token': 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH'}
files = [
]
headers= {}
response = requests.request("POST", url, headers=headers, data = payload, files = files)
print(response.text.encode('utf8'))


{
    "status": "success",
    "data": [
        {
            "unbilledCode": "ggx9fDhF",
            "subscriptionCode": "7GabLuca",
            "description": "September Unbilled Charge",
            "amount": "50.00",
            "created_at": 1602672598,
            "status": "pending",
            "quantity": 11
        }
}

Code
Out Put


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("api_token", "test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH")
  .build();
Request request = new Request.Builder()
  .url("https://apiv1.chargemonk.com/listSubscriptionUnbilledCharges")
  .method("POST", body)
  .build();
  Response response = client.newCall(request).execute();


{
    "status": "success",
    "data": [
        {
            "unbilledCode": "ggx9fDhF",
            "subscriptionCode": "7GabLuca",
            "description": "September Unbilled Charge",
            "amount": "50.00",
            "created_at": 1602672598,
            "status": "pending",
            "quantity": 11
        }
}

Code
Out Put


var client = new RestClient("https://apiv1.chargemonk.com/listSubscriptionUnbilledCharges");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AlwaysMultipartFormData = true;
request.AddParameter("api_token", "test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);


{
    "status": "success",
    "data": [
        {
            "unbilledCode": "ggx9fDhF",
            "subscriptionCode": "7GabLuca",
            "description": "September Unbilled Charge",
            "amount": "50.00",
            "created_at": 1602672598,
            "status": "pending",
            "quantity": 11
        }
}

Code
Out Put


var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://apiv1.chargemonk.com/listSubscriptionUnbilledCharges',
  'headers': {
  },
  formData: {
    'api_token': 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});


{
    "status": "success",
    "data": [
        {
            "unbilledCode": "ggx9fDhF",
            "subscriptionCode": "7GabLuca",
            "description": "September Unbilled Charge",
            "amount": "50.00",
            "created_at": 1602672598,
            "status": "pending",
            "quantity": 11
        }
}

List Unbilled attributes

Key	R/O	Description
api_token	required	Token generated by ChargeMonk. string
limit	optional	Limits the number of records to be shown. integer, default=25
search_value	optional	Description string
order_by	optional	Display records in ascending or descending order. asc,desc, default=desc
order_param	optional	You can sort createdAt or Updated alone as well as with order_by field. eg : order_param = created_at, order_by = desc created_at,amount, default=created_at
subscription_code	optional	Subscription code of the merchant. string
created_at	optional	To filter based on Subscription Created at. is,is_not,less_than,less_than_equal,greater_than,greater_than_equal,between eg. filter[created_at][less_than] = [1589796315] eg. filter[created_at][between] = [1589796315,1590390626] integer, default=1
amount	optional	Total amount of the invoice. is,is_not,less_than,less_than_equal,greater_than,greater_than_equal,between eg. filter[amount][is] = 100 eg. filter[amount][between] = [100,150] integer
filter[match]	optional	'All' will take 'AND' whereas 'ANY' will take 'OR' as condition. eg. filter[match]= ALL, filter[created_at][is] = 1589796315, filter[amount][is] = [22] Will be read as Filter if the filed has created_at like ""1589796315"" OR amount is [22]. ANY,ALL, default=USD

Add Unbilled Charges

A charge can be added in the unbilled charge list through the Web Interface and API. As the configuration allows, a charge can be add as the unbilled charge via web interface by the steps including creating a subscription, updating subscription, re-activating a subscription, adding a one-time charge to a subscription and charging next billing. By the API a charge can be added in the unbilled charge by creating actual charge and estimating charge without creating them.

Sample Code / Result:

Language

Code
Out Put


 $curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://apiv1.chargemonk.com/addSubscriptionUnbilledCharges",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => array('api_token' => 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH','description' => 'September Ubilled Charge','subscription_code' => '7GabLuca','amount' => '50','quantity' => '11'),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


{
    "status": "success",
    "message": "Added to unbilled charges."
}

Code
Out Put


 $client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://apiv1.chargemonk.com/addSubscriptionUnbilledCharges');
$request->setRequestMethod('POST');
$body = new http\Message\Body;
$body->addForm(array(
  'api_token' => 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH',
  'description' => 'September Ubilled Charge',
  'subscription_code' => '7GabLuca',
  'amount' => '50',
  'quantity' => '11'
), array(

));
$request->setBody($body);
$request->setOptions(array());

$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();


{
    "status": "success",
    "message": "Added to unbilled charges."
}

Code
Out Put


curl --location --request POST 'https://apiv1.chargemonk.com/addSubscriptionUnbilledCharges' \
--form 'api_token=test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH' \
--form 'description=September Unbilled Charge' \
--form 'subscription_code=7GabLuca' \
--form 'amount=50' \
--form 'quantity=11'


{
    "status": "success",
    "message": "Added to unbilled charges."
}

Code
Out Put


require "uri"
require "net/http"

url = URI("https://apiv1.chargemonk.com/addSubscriptionUnbilledCharges")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
form_data = [
		   ['api_token', 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH'],
		   ['description', 'September Unbilled Charge'],
		   ['subscription_code', '7GabLuca'],
		   ['amount', '50'],['quantity', '11']
	    ]
request.set_form form_data, 'multipart/form-data'
response = http.request(request)
puts response.read_body


{
    "status": "success",
    "message": "Added to unbilled charges."
}

Code
Out Put


import requests

url = "https://apiv1.chargemonk.com/addSubscriptionUnbilledCharges"

payload = {'api_token': 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH',
'description': 'September Ubilled Charge',
'subscription_code': '7GabLuca',
'amount': '50',
'quantity': '11'}
files = [

]
headers= {}

response = requests.request("POST", url, headers=headers, data = payload, files = files)

print(response.text.encode('utf8'))


{
    "status": "success",
    "message": "Added to unbilled charges."
}

Code
Out Put


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("api_token", "test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH")
  .addFormDataPart("description", "September Ubilled Charge")
  .addFormDataPart("subscription_code", "7GabLuca")
  .addFormDataPart("amount", "50")
  .addFormDataPart("quantity", "11")
  .build();
Request request = new Request.Builder()
  .url("https://apiv1.chargemonk.com/addSubscriptionUnbilledCharges")
  .method("POST", body)
  .build();
Response response = client.newCall(request).execute();


{
    "status": "success",
    "message": "Added to unbilled charges."
}

Code
Out Put


var client = new RestClient("https://apiv1.chargemonk.com/addSubscriptionUnbilledCharges");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AlwaysMultipartFormData = true;
request.AddParameter("api_token", "test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH");
request.AddParameter("description", "September Ubilled Charge");
request.AddParameter("subscription_code", "7GabLuca");>
request.AddParameter("amount", "50");
request.AddParameter("quantity", "11");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);


{
    "status": "success",
    "message": "Added to unbilled charges."
}

Code
Out Put


var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://apiv1.chargemonk.com/addSubscriptionUnbilledCharges',
  'headers': {
  },
  formData: {
    'api_token': 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH',
    'description': 'September Ubilled Charge',
    'subscription_code': '7GabLuca',
    'amount': '50',
    'quantity': '11'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});


{
    "status": "success",
    "message": "Added to unbilled charges."
}

Add Unbilled attributes

Key	R/O	Description
api_token	required	Token generated by ChargeMonk. string
amount	required	Total amount of the unbilled charges. integer
description	required	Description of the unbilled charges. string
subscription_code	required	Subscription code of the merchant. string
quantity	required	Quantity of the unbilled charges. integer

Delete Unbilled Charges

An unbilled charge can be deleted via API by specifying the id of the charge.

Sample Code / Result:

Language

Code
Out Put


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://apiv1.chargemonk.com/deleteSubscriptionUnbilledCharges",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => array('api_token' => 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH','unbilledCode' => 'rXdeoU06'),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


{
    "status": "success",
    "message": "Deleted unbilled charges."
}

Code
Out Put


$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://apiv1.chargemonk.com/deleteSubscriptionUnbilledCharges');
$request->setRequestMethod('POST');
$body = new http\Message\Body;
$body->addForm(array(
  'api_token' => 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH',
  'unbilledCode' => 'rXdeoU06'
), array(

));
$request->setBody($body);
$request->setOptions(array());

$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();


{
    "status": "success",
    "message": "Deleted unbilled charges."
}

Code
Out Put


curl --location --request POST 'https://apiv1.chargemonk.com/deleteSubscriptionUnbilledCharges' \
--form 'api_token=test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH' \
--form 'unbilledCode=rXdeoU06'


{
    "status": "success",
    "message": "Deleted unbilled charges."
}

Code
Out Put


require "uri"
require "net/http"

url = URI("https://apiv1.chargemonk.com/deleteSubscriptionUnbilledCharges")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
form_data = [
		['api_token', 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH'],
		['unbilledCode', 'rXdeoU06']
	    ]
request.set_form form_data, 'multipart/form-data'
response = http.request(request)
puts response.read_body


{
    "status": "success",
    "message": "Deleted unbilled charges."
}

Code
Out Put


import requests

url = "https://apiv1.chargemonk.com/deleteSubscriptionUnbilledCharges"

payload = {'api_token': 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH'
'unbilledCode': 'rXdeoU06'}
files = [

]
headers= {}

response = requests.request("POST", url, headers=headers, data = payload, files = files)

print(response.text.encode('utf8'))


{
    "status": "success",
    "message": "Deleted unbilled charges."
}

Code
Out Put


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("api_token", "test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH")
  .addFormDataPart("unbilledCode", "rXdeoU06")
  .build();
Request request = new Request.Builder()
  .url("https://apiv1.chargemonk.com/deleteSubscriptionUnbilledCharges")
  .method("POST", body)
  .build();
Response response = client.newCall(request).execute();


{
    "status": "success",
    "message": "Deleted unbilled charges."
}

Code
Out Put




var client = new RestClient("https://apiv1.chargemonk.com/deleteSubscriptionUnbilledCharges");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AlwaysMultipartFormData = ">true;
request.AddParameter("api_token", "test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH");
request.AddParameter("unbilledCode", "rXdeoU06");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);


{
    "status": "success",
    "message": "Deleted unbilled charges."
}

Code
Out Put



var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://apiv1.chargemonk.com/deleteSubscriptionUnbilledCharges',
  'headers': {
  },
  formData: {
    'api_token': 'test_C8OsiR4B6ZlvSqIKrn3zMA2XwfWkEamH',
    'unbilledCode': 'rXdeoU06'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});


{
    "status": "success",
    "message": "Deleted unbilled charges."
}

Delete Unbilled attributes

Key	R/O	Description
api_token	required	Token generated by ChargeMonk. string
unbilledCode	required	Unbilled Code of the merchant. string