Difference between revisions of "MOR API subscription create bulk"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Deescription=
=Description=
<!---This functionality is available from MOR x5--->
<!---This functionality is available from MOR x5--->
[[MOR API]] Create subscription
[[MOR API]] Create subscription
<br><br>
<br><br>
=Usage=
=Usage=


Line 23: Line 24:
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication (admin, reseller, accountant). '''Required'''.
* u - username for authentication (admin, reseller, accountant). '''Required'''.
* subscription_start_period_day - Start Period on the day, possible values between 1 and 31, default 1
* subscription_charge_balance_on - Charge Balance on, possible values are 1,2,3 (where 1: Period Start, 2: Period End, 3: Every Day), default 1 (daily and one-time fee subscriptions inserted in database as 3)
* subscription_activation_start - Unix timestamp of Subscription activation start.  
* subscription_activation_start - Unix timestamp of Subscription activation start.  
* subscription_activation_end - Unix timestamp of Subscription activation end.  
* subscription_activation_end - Unix timestamp of Subscription activation end.  
Line 30: Line 33:
* ignore_balance - for Prepaid user subscription will be applied even if Prepaid User does not have sufficient balance (0 - off, 1 - on, default - off).
* ignore_balance - for Prepaid user subscription will be applied even if Prepaid User does not have sufficient balance (0 - off, 1 - on, default - off).
* subscription_discount_percent - Subscription Discount Percent. Possible values are from 0 to 100.
* subscription_discount_percent - Subscription Discount Percent. Possible values are from 0 to 100.
* subscription_charge_for_past - Charge for past, possible values are 0, 1 (where 0: no, 1: yes), default 0


<br><br>
<br><br>
Line 52: Line 56:
   <page>
   <page>
     <status>
     <status>
       <success>Subscription was successfully created</success>
       <success>Subscriptions were successfully created</success>
       <id>231</id>
       <ids>231</ids>
     </status>
     </status>
   </page>
   </page>
Line 64: Line 68:
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>User has insufficient balance</error> - Subscription price is bigger than Subscription User balance.
* <error>User has insufficient balance</error> - Subscription price is bigger than Subscription User balance.
* <error>Service was not found</error> - Service with specified service_id was not found.
* <error>One or more Service was not found</error> - Service with specified service_id was not found.
<br><br>
<br><br>


Latest revision as of 08:05, 17 January 2023

Description

MOR API Create subscription

Usage

  • Call: /api/subscription_create_bulk
  • Methods: POST, GET(if allowed, not recomended)



Parameters

Parameters which are included into hash:

  • user_id - User ID . Required.
  • service_id - Service ID. Required.

NOTE Several subscriptions at once can be assigned choosing their IDs in the service_id parameter.

For example, if it is needed to assign subscriptions 1, 1, 1, 2, 3, parameter will look this way: service_id=1,1,1,2,3

Parameters which are not included into hash:

  • hash - SHA1 hash constructed using API_Secret_Key ( More described in Constructing hash). Required.
  • u - username for authentication (admin, reseller, accountant). Required.
  • subscription_start_period_day - Start Period on the day, possible values between 1 and 31, default 1
  • subscription_charge_balance_on - Charge Balance on, possible values are 1,2,3 (where 1: Period Start, 2: Period End, 3: Every Day), default 1 (daily and one-time fee subscriptions inserted in database as 3)
  • subscription_activation_start - Unix timestamp of Subscription activation start.
  • subscription_activation_end - Unix timestamp of Subscription activation end.
  • subscription_memo - memo of Subscription.
  • subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
  • subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). Only for Flat Rate and Dynamic Flat-Rate.
  • ignore_balance - for Prepaid user subscription will be applied even if Prepaid User does not have sufficient balance (0 - off, 1 - on, default - off).
  • subscription_discount_percent - Subscription Discount Percent. Possible values are from 0 to 100.
  • subscription_charge_for_past - Charge for past, possible values are 0, 1 (where 0: no, 1: yes), default 0



NOTE. When Flat-Rate Service is subscribed Subscription will be created for full month.

Request

We have service_id = 10, user_id = 2, subscription_memo = acc_one, API Secret Key = 456789.

We send: 

HTML POST: http://<SERVER_IP>/billing/api/subscription_create_bulk?u=admin&service_id=10&user_id=2&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

* Note that username are not included in hash

Returns

Success 

 <?xml version="1.0" encoding="UTF-8"?>
 <page>
   <status>
     <success>Subscriptions were successfully created</success>
     <ids>231</ids>
   </status>
 </page>



Errors

  • <error>Access Denied</error> - user does not exist or cannot use this functionality.
  • <error>You are not authorised to use this functionality</error> - accountant does not have Manage Subscription permission.
  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>User has insufficient balance</error> - Subscription price is bigger than Subscription User balance.
  • <error>One or more Service was not found</error> - Service with specified service_id was not found.



See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_subscription_create_bulk&oldid=28549"