Subscription is a payment process on a periodic basis for an ongoing product or service defined by the frequency or interval.

HTTP Method: POST

URL

https://api.vericheck.com/subscriptions

Request Content – Example:

{  
   "customer_id":"cus_2k1620ikf0k3235gf359",
   "amount":205.02,
   "start_date":"2014-12-18",
   "end_date":"2015-12-18",
   "frequency":"monthly",
   "occurring_hour":"22"
}

Response Example:

{  
   "success":true,
   "payload":{  
      "id":"sub_4235gsg35gwgy5y42sd23f2f"
   }
}

HTTP Method: PUT

URL

https://api.vericheck.com/subscriptions/[SUBSCRIPTION_ID]

Example:

https://api.vericheck.com/subscriptions/sub_4235gsg35gwgy5y42sd23f2f

Request Content – Example

{  
   "end_date":"2017-05-03",
   "frequency":"quarterly",
   "occurring_hour":"18",
   "next_date":"2014-12-24"
}

Response Example:

{  
   "success":true
}

HTTP Method: GET

URL

https://api.vericheck.com/subscriptions/[SUBSCRIPTION_ID]

 
Example:

https://api.vericheck.com/subscriptions/sub_4235gsg35gwgy5y42sd23f2f

Response Example

{  
   "customer_id":"cus_2k1620ikf0k3235gf359",
   "amount":205.02,
   "start_date":"2014-12-18",
   "end_date":"12-18-2015",
   "frequency":"monthly",
   "occurring_hour":"18"
   ... all fields of object from below table
}

Subscription Object

Field Data Type Required Mutable

id

string

yes

no

amount

number

yes

no

start_date

string; YYYY-MM-DD

yes

no

end_date

string; YYYY-MM-DD

yes

yes

frequency

string

yes

yes

occcurring_hour

string

yes

yes

active

string; default: yes

no

yes

created_date

string; YYYY-MM-DD

no

no

next_date

string; YYYY-MM-DD

no

yes