Difference between revisions of "MOR API subscription create bulk"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 15: Line 15:
* service_id - Service ID. '''Required'''.  
* service_id - Service ID. '''Required'''.  


Several subscriptions at once can be assigned choosing their IDs in the service_id parameter.
'''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
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

Revision as of 13:06, 22 September 2020

Deescription

MOR API Create subscription

Usage

  • Call: /api/subscription_create
  • 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_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.



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?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>Subscription was successfully created</success>
     <id>231</id>
   </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>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=25868"