Subscriptions

Vesicash helps you collect payments recurrently from your customers using a subscription plan. Subscription plans allow you create a subscription for your customers.

post
Create Subscription Plan

https://api.vesicash.com/v1/subscription/plan/create
These are the parameters needed to make a transaction
Request
Response
Request
Headers
Accept
required
string
application/json
V-PRIVATE-KEY
required
string
your vesicash private key
Body Parameters
type
optional
string
monthly, quarterly, yearly
title
required
string
title of plan
amount
required
integer
amount to be paid
business_id
required
number
business_id of business integrating this tool
Response
200: OK
{
"status": "ok",
"message": {
"business_id": 0000000000,
"subscription_plan_id": "fRctGLrEZIgKfO41035Y",
"title": "Basic",
"amount": 10000,
"recurring_as": "monthly",
"updated_at": "2019-12-16 15:16:55",
"created_at": "2019-12-16 15:16:55",
"id": 1
}
}

post
Subscribe User To A Plan

https://api.vesicash.com/v1/subscription/subscribe
These are the parameters needed to make a transaction
Request
Response
Request
Headers
Accept
required
string
application/json
V-PRIVATE-KEY
required
string
your vesicash private key
Body Parameters
subscription_plan_id
required
number
unique id of created subscription plan
account_id
required
string
account_id of subscribing user
trial_period
required
integer
trial period / date before charges begin
Response
200: OK
{
"status": "ok",
"message": "Subscription Created",
"data": {
"subscription_id": "Q4sCUfDO606vv0Epdy45",
"subscription_plan_id": "fRctGLrEZIgKfO41035Y",
"account_id": 00000000000,
"trial_period": 0000000000,
"amount": "10000.00",
"next_execute": 1579187820,
"last_execute": 1579187820,
"updated_at": "2019-12-16 15:17:00",
"created_at": "2019-12-16 15:17:00",
"id": 1
}
}