Do you want to search in all categories or in this category ?
Home
All Categories
Subshero
Dev Docs
API Documentation

API Documentation

Written by Saniya Gazala
Last update: Thursday, Dec 08, 2022

Introduction :

Subshero API helps you connect to other application via REST API

POST Commands

1️⃣Command: Login

URL :  https://api.subshero.com/api/v1/auth/login

Example Request:

curl --location -g --request POST ' https://api.subshero.com/api/v1/auth/login ' \
--header 'Accept: application/json' \
--form 'email="saniya@interstellarconsulting.com"' \
--form 'password="root@123"

  • Success Code : API request returns 201 status on successful login.

  • Error Code : API request returns 401 status "Unauthorized".

Example Response:

{
    "user": {
        "id": 41,
        "role_id": 2,
        "plan_id": 2,
        "name": "Saniya Gazala",
        "first_name": "Saniya",
        "last_name": "Gazala",
        "country": "IN",
        "email": "saniya@interstellarconsulting.com",
        "email_verified_at": "2021-10-07T10:38:51.000000Z",
        "description": null,
        "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZmlsZS80MS9Pb1FGS2lrOTFLTkpJc1czcXRrTnI4VWd1QWxHMGtzeG12NDgwVE1RLnBuZw==",
        "created_at": "2021-10-07T10:38:19.000000Z",
        "created_by": 0,
        "updated_at": "2021-12-15T10:49:03.000000Z",
        "reset_at": null,
        "status": 1
    },
    "token": "18|6CjhiyFQU2yVmllC33w1vlD1jVltt3rY6M5HvBX3"
}

2️⃣ Command : Subscription Create (Full)

URL : https://api.subshero.com/api/v1/subscriptions/

  • Success Code : 200 ok status on successful creation of lifetime or subscription.

  • Error Code : 400 "Bad Request", can not create subscription

Example Request :

curl --location -g --request POST " https://api.subshero.com/api/v1/subscriptions/" \
--header 'Accept: application/json' \
--form 'brand_id="198"' \
--form 'type="1"' \
--form 'price="99.99"' \
--form 'price_type="USD"' \
--form 'billing_type="2"' \
--form 'billing_frequency="1"' \
--form 'billing_cycle="1"' \
--form 'payment_date="2022-01-09"' \
--form 'status="1"' \
--form 'recurring="1"' \
--form 'folder_id="208"' \
--form 'alert_id="145"' \
--form 'category_id="2"' \
--form 'description="A netflix company."' \
--form 'discount_voucher="NF123"' \
--form 'payment_mode_id="711"' \
--form 'tags[]="Water bill"' \
--form 'tags[]="Tickets"' \
--form 'rating="4"' \
--form 'ltdval_price="123"' \
--form 'ltdval_cycle="1"' \
--form 'ltdval_frequency="2"' \
--form 'refund_days="5"'

Example Response :

{
  "id": 5354,
  "user_id": 41,
  "folder_id": 208,
  "brand_id": 198,
  "category_id": 2,
  "alert_id": 145,
  "platform_id": null,
  "type": 1,
  "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy9kYWlseS5wbmc=?v=1.79",
  "favicon": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy9kYWlseS5wbmc=?v=1.79",
  "product_name": "Daily",
  "brandname": "Daily",
  "product_type": 1,
  "description": "A netflix company.",
  "price": 99.99,
  "price_type": "USD",
  "recurring": 1,
  "payment_date": "2022-01-09",
  "next_payment_date": null,
  "payment_date_upd": "2022-01-09",
  "expiry_date": null,
  "contract_expiry": null,
  "homepage": null,
  "pay_gateway_id": 0,
  "note": null,
  "company_name": null,
  "discount_voucher": "NF123",
  "payment_mode": "Debit Card",
  "payment_mode_id": 711,
  "include_notes": null,
  "alert_type": null,
  "url": "https://www.daily.co/",
  "support_details": null,
  "tags": null,
  "billing_frequency": 1,
  "billing_cycle": 1,
  "billing_type": 2,
  "ltdval_price": "123.00",
  "ltdval_frequency": 2,
  "ltdval_cycle": 1,
  "status": 1,
  "pricing_type": 1,
  "timezone": "Asia/Kolkata",
  "currency_code": "USD",
  "refund_days": 5,
  "refund_date": "2022-01-14",
  "base_value": "99.99",
  "base_currency": "USD",
  "rating": 4,
  "sub_addon": 0,
  "sub_id": null,
  "created_at": "2022-12-08 13:30:30",
  "created_by": 41,
  "type_value": "Subscription",
  "recurring_value": "Recurring",
  "billing_cycle_value": "Daily",
  "billing_type_value": "Date",
  "ltdval_cycle_value": "Daily",
  "status_value": "Active",
  "pricing_type_value": "Subscription",
  "sub_addon_value": "Subscription"
}

3️⃣Command: Subscription Create

URL : https://api.subshero.com/api/v1/subscriptions

  • Success Code : 200 ok status on successful creation of lifetime or subscription.

  • Error Code : 400 "Bad Request", can not create subscription

Example Request :

curl --location -g --request POST ' https://api.subshero.com/api/v1/subscriptions/' \
--header 'Accept: application/json' \
--form 'brand_id="Flimingo"' \
--form 'type="1"' \
--form 'price="200"' \
--form 'price_type="INR"' \
--form 'billing_type="2"' \
--form 'billing_frequency="1"' \
--form 'billing_cycle="3"' \
--form 'payment_date="2022-01-09"' \
--form 'status="1"' \
--form 'recurring="1"'

Example Response :

{
  "status": true,
  "message": "Success",
  "subscription": {
    "id": 2280,
    "user_id": 41,
    "folder_id": 0,
    "brand_id": 1,
    "category_id": 1,
    "alert_id": 1,
    "type": 1,
    "image": "https://api.subshero.com/storage/c3lzdGVtL3N1YnNjcmlwdGlvbi9kZWZhdWx0X2ltYWdlLnBuZw==",
    "favicon": "https://api.subshero.com/storage/c3lzdGVtL3N1YnNjcmlwdGlvbi9kZWZhdWx0X2ltYWdlLnBuZw==",
    "product_name": "Flimingo",
    "brandname": null,
    "product_type": null,
    "description": null,
    "price": 200,
    "price_type": "INR",
    "recurring": 0,
    "payment_date": "2022-01-09",
    "next_payment_date": null,
    "payment_date_upd": "2022-01-09",
    "expiry_date": null,
    "contract_expiry": null,
    "homepage": null,
    "pay_gateway_id": 0,
    "note": null,
    "company_name": null,
    "discount_voucher": null,
    "payment_mode": null,
    "payment_mode_id": null,
    "include_notes": null,
    "alert_type": null,
    "url": null,
    "support_details": null,
    "tags": null,
    "billing_frequency": 1,
    "billing_cycle": 3,
    "billing_type": 2,
    "ltdval_price": null,
    "ltdval_frequency": null,
    "ltdval_cycle": null,
    "status": 1,
    "pricing_type": null,
    "timezone": "Asia/Kolkata",
    "currency_code": null,
    "refund_days": null,
    "refund_date": null,
    "base_value": "2.60",
    "base_currency": "USD",
    "rating": 0,
    "created_at": "2022-03-21T17:05:04.000000Z",
    "created_by": 41
  }
{ 
  "status": true,
  "message": "Success",
  "subscription": {
    "id": 2280,
    "user_id": 41,
    "folder_id": 0,
    "brand_id": 1,
    "category_id": 1,
.................  }
} Following sequence of Data array

4️⃣ Command : Subscription Refund:

URL:https://api.subshero.com/api/v1/subscriptions/2665/refund

  • Success Code : 200 ok status on successful refund on lifetime or subscription.

  • Error Code : 400 "Bad Request", can not refund subscription/lifetime.

Example Request :

curl --location -g --request POST 'https://api.subshero.com/api/v1/subscriptions/2665/refund' \
--header 'Accept: application/json'

Example Response :

{
    "status": true,
    "message": "Success"
}

5️⃣Command : Subscription Cancel:

URL:https://api.subshero.com/api/v1/subscriptions/2662/cancel

  • Success Code : 200 ok status on successful cancellation on lifetime or subscription.

  • Error Code : 400 "Bad Request", can not cancel subscription/lifetime.

Example Request :

curl --location -g --request POST 'https://api.subshero.com/api/v1/subscriptions/2662/cancel' \
--header 'Accept: application/json'

Example Response :

{
    "status": true,
    "message": "Success"
}

6️⃣Command : Subscription Add-on :

URL : https://api.subshero.com/api/v1/subscriptions/2666/addon

  • Success Code : On successful creation of add-on request the returns 200 ok status.

  • Error Code : 400 "Bad Request", can not create an add-on subscription/lifetime.

Example Request :

curl --location -g --request POST 'https://api.subshero.com/api/v1/subscriptions/2666/addon' \
--header 'Accept: application/json' \
--form 'type="3"' \
--form 'price="1900"' \
--form 'price_type="USD"' \
--form 'payment_date="2019-09-18"' \
--form 'status="1"' \
--form 'recurring="1"' \
--form 'refund_date="2022-08-10"'

Example Response :

{
  "status": true,
  "message": "Success",
  "subscription": {
    "id": 2671,
    "user_id": 85,
    "folder_id": 0,
    "brand_id": 21,
    "category_id": 1,
    "alert_id": 1,
    "type": 3,
    "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy9zZW5kaW5ibHVlLnBuZw==?v=1.79",
    "favicon": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy9zZW5kaW5ibHVlLnBuZw==?v=1.79",
    "product_name": "Sendinblue",
    "brandname": "Sendinblue",
    "product_type": 1,
    "description": "The best way to get a hold of one is by subscribing to the full package of features that RevLocal includes to help local businesses",
    "price": 1900,
    "price_type": "USD",
    "recurring": 1,
    "payment_date": "2019-09-18",
    "next_payment_date": null,
    "payment_date_upd": "2019-09-18",
    "expiry_date": null,
    "contract_expiry": null,
    "homepage": null,
    "pay_gateway_id": 0,
    "note": null,
    "company_name": null,
    "discount_voucher": null,
    "payment_mode": null,
    "payment_mode_id": 546,
    "include_notes": null,
    "alert_type": null,
    "url": "https://www.sendinblue.com/",
    "support_details": null,
    "tags": null,
    "billing_frequency": 1,
    "billing_cycle": 1,
    "billing_type": 1,
    "ltdval_price": null,
    "ltdval_frequency": null,
    "ltdval_cycle": null,
    "status": 1,
    "pricing_type": 3,
    "timezone": "America/New_York",
    "currency_code": "USD",
    "refund_days": null,
    "refund_date": null,
    "base_value": "1900.00",
    "base_currency": "USD",
    "rating": 0,
    "sub_addon": 1,
    "sub_id": 2666,
    "created_at": "2022-08-08 01:45:04",
    "created_by": 85
  }
}

7️⃣Command : Alert Profile Create

URL : https://api.subshero.com/api/v1/alerts/

  • Success Code : On successful login request the token is generated on app site.

  • Error Code : API request returns 401 status "Unauthorized".

Example Request :

curl --location -g --request POST " https://api.subshero.com/api/v1/alerts/" \
--header 'Accept: application/json' \
--form 'alert_name="Subs_alert"' \
--form 'time_period="2"' \
--form 'time="14:13"' \
--form 'alert_condition="2"' \
--form 'alert_type="1"' \
--form 'timezone="Asia/Kolkata"' \
--form 'alert_subs_type="2"'

Example Response :

{
  "user_id": 41,
  "is_default": 0,
  "alert_name": "Subs_alert",
  "time_period": "2",
  "time": "14:13",
  "alert_condition": "2",
  "alert_contact": null,
  "alert_type": "1",
  "timezone": "Asia/Kolkata",
  "alert_subs_type": "2",
  "updated_at": "2022-12-08T07:59:29.000000Z",
  "created_at": "2022-12-08T07:59:29.000000Z",
  "id": 145
}

GET Commands

1️⃣ Command: Login API using Token:

URL : https://api.subshero.com/api/v1/auth/token

  • Success Code : On successful login request the token is generated on app site.

  • Error Code : API request returns 401 status "Unauthorized".

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/auth/token' \
--header 'Accept: application/json'

Example Response :

{
  "id": 41,
  "role_id": 2,
  "plan_id": 2,
  "name": "Saniya Gazala",
  "first_name": "Saniya",
  "last_name": "Gazala",
  "country": "IN",
  "email": "saniya@interstellarconsulting.com",
  "email_verified_at": "2021-10-07T10:38:51.000000Z",
  "description": null,
  "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZmlsZS80MS9Pb1FGS2lrOTFLTkpJc1czcXRrTnI4VWd1QWxHMGtzeG12NDgwVE1RLnBuZw==",
  "created_at": "2021-10-07T10:38:19.000000Z",
  "created_by": 0,
  "updated_at": "2021-12-15T10:49:03.000000Z",
  "reset_at": null,
  "status": 1
}

2️⃣Command: Logout :

 URL :  https://api.subshero.com/api/v1/auth/logout

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/auth/logout' \
--header 'Accept: application/json'

3️⃣Command: Product Search :

URL : https://api.subshero.com/api/v1/products/search?q=Moosend

  • Success Code : Returns 200 Ok status on search of product.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/products/search?q=Moosend' \
--header 'Accept: application/json'

Example Response :

[
  {
    "id": 16,
    "admin_id": 1,
    "category_id": 12,
    "product_name": "Moosend",
    "brandname": "Sitecore",
    "product_type": 1,
    "description": "Moosend",
    "featured": null,
    "rating": null,
    "pop_factor": null,
    "url": "https://moosend.com/",
    "url_app": null,
    "app_url": null,
    "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy9tb29zZW5kLnBuZw==",
    "favicon": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy9tb29zZW5kLnBuZw==",
    "status": 1,
    "sub_ltd": 1,
    "launch_year": null,
    "sub_platform": 1,
    "pricing_type": 1,
    "currency_code": "USD",
    "price1_name": "Pro",
    "price1_value": "8.00",
    "price2_name": null,
    "price2_value": null,
    "price3_name": null,
    "price3_value": null,
    "refund_days": 0,
    "billing_frequency": 1,
    "billing_cycle": 3,
    "ltdval_price": null,
    "ltdval_frequency": null,
    "ltdval_cycle": null,
    "created_at": "2022-01-08 07:39:26",
    "created_by": 1
  },
  {
    "id": 822,
    "admin_id": 1,
    "category_id": 12,
    "product_name": "Moosend",
    "brandname": "Moosend",
     ............................
  }
]

4️⃣ Command : Product Get by id

URL : https://api.subshero.com/api/v1/products/11

  • Success Code : Returns 200 Ok status.

  • Error Code : Returns 400 "Bad request" on, no result found.

Example Request :

curl --location -g --request GET "https://api.subshero.com/api/v1/products/11" \
--header 'Accept: application/json'

Example Response :

{
  "id": 11,
  "admin_id": 1,
  "category_id": 12,
  "product_name": "Pabbly Email Market",
  "brandname": "Pabbly",
  "product_type": 1,
  "description": "Pabbly developed a software which allows you to easily manage and send bulk email to your customers and keep track of results.",
  "featured": null,
  "rating": null,
  "pop_factor": null,
  "url": "https://www.pabbly.com/email-marketing/",
  "url_app": "https://accounts.pabbly.com/login",
  "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy9wYWJibHllbWFpbG1hcmtldC5wbmc=?v=1.79",
  "favicon": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy9wYWJibHllbWFpbG1hcmtldC5wbmc=?v=1.79",
  "status": 1,
  "sub_ltd": 0,
  "launch_year": "2018",
  "sub_platform": 12,
  "pricing_type": 1,
  "currency_code": "USD",
  "price1_name": "Pro",
  "price1_value": "41.00",
  "price2_name": null,
  "price2_value": null,
  "price3_name": null,
  "price3_value": null,
  "refund_days": 30,
  "billing_frequency": 1,
  "billing_cycle": 3,
  "ltdval_price": null,
  "ltdval_frequency": null,
  "ltdval_cycle": null,
  "created_at": "2022-10-01 06:33:58",
  "created_by": 1,
  "updated_at": null
}

5️⃣ Command : Product Category Search

URL : "https://api.subshero.com/api/v1/products/categories/?q=&start=0&length=2&sort=id:desc"

  • Success Code : Returns 200 Ok status.

  • Error Code : Returns 400 "Bad request" on, no result found

Example Request :

curl --location -g --request GET " https://api.subshero.com/api/v1/products/categories/?q=&start=0&length=2&sort=id:desc" \
--header 'Accept: application/json'

Example Response :

[
  {
    "id": 144,
    "user_id": null,
    "name": "Proposal Management",
    "created_at": "2022-07-07T12:21:57.000000Z",
    "updated_at": "2022-07-07T12:21:57.000000Z"
  },
  {
    "id": 143,
    "user_id": null,
    "name": "Doc Maker",
    "created_at": "2022-07-01T12:12:11.000000Z",
    "updated_at": "2022-07-01T12:12:11.000000Z"
  }
]

6️⃣Command : Product Category Get by id

URL : "https://api.subshero.com/api/v1/products/categories/12 "

  • Success Code : Returns 200 Ok status.

  • Error Code : Returns 400 "Bad request" on, no result found

Example Request :

curl --location -g --request GET "https://api.subshero.com/api/v1/products/categories/12" \
--header 'Accept: application/json'

Example Response :

{
  "id": 12,
  "user_id": null,
  "name": "Email Marketing",
  "created_at": null,
  "updated_at": null
}

7️⃣Command : Subscription Search

 URL :'https://api.subshero.com/api/v1/subscriptions/?q=netflix&start=10&length=20&sort=payment_date:desc&filters={"subscription":{"folder_id":["0","6"],"type":["1","3"],"billing_cycle":["1","2","4"]}}'

  • Success Code : Returns 200 Ok status.

  • Error Code : Returns 400 "Bad request" on, no result found

Example Request :

curl --location -g --request GET " https://api.subshero.com/api/v1/subscriptions/?q=Twilio&start=0&length=2&sort=payment_date:asc&filters=" \
--header 'Accept: application/json'

Example Response :

[
  {
    "id": 5291,
    "user_id": 41,
    "folder_id": 0,
    "brand_id": 18,
    "category_id": 30,
    "alert_id": 1,
    "platform_id": null,
    "type": 1,
    "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy90d2lsaW8ucG5n?v=1.79",
    "favicon": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy90d2lsaW8ucG5n?v=1.79",
    "product_name": "Twilio",
    "brandname": "Twilio Inc.",
    "product_type": 1,
    "description": "Salesforce is the leader in the cloud computing industry with the most comprehensive cloud based CRM and BPM solutions.",
    "price": 15,
    "price_type": "USD",
    "recurring": 1,
    "payment_date": "2022-03-07",
    "next_payment_date": "2023-01-07",
    "payment_date_upd": "2023-01-07",
    "expiry_date": null,
    "contract_expiry": null,
    "homepage": null,
    "pay_gateway_id": 0,
    "note": null,
    "company_name": null,
    "discount_voucher": null,
    "payment_mode": null,
    "payment_mode_id": 654,
    "include_notes": null,
    "alert_type": 1,
    "url": "https://www.twilio.com/",
    "support_details": null,
    "tags": null,
    "billing_frequency": 1,
    "billing_cycle": 3,
    "billing_type": 2,
    "ltdval_price": null,
    "ltdval_frequency": null,
    "ltdval_cycle": null,
    "status": 1,
    "pricing_type": 1,
    "timezone": "Asia/Kolkata",
    "currency_code": "USD",
    "refund_days": null,
    "refund_date": null,
    "base_value": "15.00",
    "base_currency": "USD",
    "rating": 10,
    "sub_addon": 0,
    "sub_id": null,
    "created_at": "2022-11-28 16:47:41",
    "created_by": 41,
    "brand_name": "Twilio",
    "product_type_name": "Saas",
    "product_category_name": "Communication App",
    "folder_color": null,
    "folder_name": null,
    "payment_method_name": "PayPal",
    "alert_name": "System Default (Sub)",
    "attachment_count": 0,
    "type_value": "Subscription",
    "recurring_value": "Recurring",
    "billing_cycle_value": "Monthly",
    "billing_type_value": "Date",
    "ltdval_cycle_value": null,
    "status_value": "Active",
    "pricing_type_value": "Subscription",
    "sub_addon_value": "Subscription"
  }
]

8️⃣Command: Subscription GET by id

 URL : https://api.subshero.com/api/v1/subscriptions/2265

  • Success Code : Returns 200 Ok status.

  • Error Code : Returns 400 "Bad request" on, no result found

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/subscriptions/2265' \
--header 'Accept: application/json'

Example Response :

{
  "id": 2265,
  "user_id": 41,
  "folder_id": 121,
  "brand_id": 16,
  "category_id": null,
  "alert_id": 1,
  "type": 1,
  "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy9tb29zZW5kLnBuZw==",
  "favicon": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy9tb29zZW5kLnBuZw==",
  "product_name": "Moosend",
  "brandname": "Sitecore",
  "product_type": 1,
  "description": "Moosend",
  "price": 20,
  "price_type": "USD",
  "recurring": 1,
  "payment_date": "2022-01-09",
  "next_payment_date": "2022-03-22",
  "payment_date_upd": "2022-03-22",
  "expiry_date": null,
  "contract_expiry": null,
  "homepage": null,
  "pay_gateway_id": 0,
  "note": null,
  "company_name": null,
  "discount_voucher": null,
  "payment_mode": null,
  "payment_mode_id": null,
  "include_notes": null,
  "alert_type": null,
  "url": null,
  "support_details": null,
  "tags": null,
  "billing_frequency": 1,
  "billing_cycle": 1,
  "billing_type": 2,
  "ltdval_price": "234.00",
  "ltdval_frequency": 1,
  "ltdval_cycle": 4,
  "status": 1,
  "pricing_type": 1,
  "timezone": "Asia/Kolkata",
  "currency_code": "USD",
  "refund_days": 30,
  "refund_date": null,
  "base_value": "20.00",
  "base_currency": "USD",
  "rating": 10,
  "created_at": "2022-03-14T13:42:36.000000Z",
  "created_by": 41
}
]

9️⃣Command: Subscription Get All

 URL : https://api.subshero.com/api/v1/subscriptions

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/subscriptions' \
--header 'Accept: application/json'

Example Response :

[
    {
        "id": 2265,
        "user_id": 41,
        "folder_id": 121,
        "brand_id": 16,
        "category_id": null,
        "alert_id": 1,
        "type": 1,
        "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy9tb29zZW5kLnBuZw==",
        "favicon": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy9tb29zZW5kLnBuZw==",
        "product_name": "Moosend",
        "brandname": "Sitecore",
        "product_type": 1,
        "description": "Moosend",
        "price": 20,
        "price_type": "USD",
        "recurring": 1,
        "payment_date": "2022-01-09",
        "next_payment_date": "2022-03-22",
        "payment_date_upd": "2022-03-22",
        "expiry_date": null,
        "contract_expiry": null,
        "homepage": null,
        "pay_gateway_id": 0,
        "note": null,
        "company_name": null,
        "discount_voucher": null,
        "payment_mode": null,
        "payment_mode_id": null,
        "include_notes": null,
        "alert_type": null,
        "url": null,
        "support_details": null,
        "tags": null,
        "billing_frequency": 1,
        "billing_cycle": 1,
        "billing_type": 2,
        "ltdval_price": "234.00",
        "ltdval_frequency": 1,
        "ltdval_cycle": 4,
        "status": 1,
        "pricing_type": 1,
        "timezone": "Asia/Kolkata",
        "currency_code": "USD",
        "refund_days": 30,
        "refund_date": null,
        "base_value": "20.00",
        "base_currency": "USD",
        "rating": 10,
        "created_at": "2022-03-14T13:42:36.000000Z",
        "created_by": 41
    },
    {
        "id": 2266,
        "user_id": 41,
        "folder_id": 0,
        "brand_id": 11,
        "category_id": null,
        "alert_id": 1,
        "type": 1,
        "image": "https://api.subshero.com/storage/c3lzdGVtL3N1YnNjcmlwdGlvbi9kZWZhdWx0X2ltYWdlLnBuZw==",
        "favicon": "https://api.subshero.com/storage/c3lzdGVtL3N1YnNjcmlwdGlvbi9kZWZhdWx0X2ltYWdlLnBuZw==",
        "product_name": "Pabbly Email Market",
        "brandname": "Pabbly",
        "product_type": 1,
        "description": null,
        "price": 100,
        "price_type": "USD",
        "recurring": 1,
        "payment_date": "2022-01-09",
        "next_payment_date": "2022-03-22",
        "payment_date_upd": "2022-03-22",
        "expiry_date": null,
        "contract_expiry": null,
        "homepage": null,
        "pay_gateway_id": 0,
        "note": null,
        "company_name": null,
        "discount_voucher": null,
        "payment_mode": null,
        "payment_mode_id": null,
        "include_notes": null,
        "alert_type": null,
        "url": null,
        "support_details": null,
        "tags": null,
        "billing_frequency": 1,
        "billing_cycle": 1,
        "billing_type": 2,
        "ltdval_price": null,
        "ltdval_frequency": null,
        "ltdval_cycle": null,
        "status": 1,
        "pricing_type": 1,
        "timezone": "Asia/Kolkata",
        "currency_code": "USD",
        "refund_days": null,
        "refund_date": null,
        "base_value": "100.00",
        "base_currency": "USD",
        "rating": 0,
        "created_at": "2022-03-14T15:02:14.000000Z",
        "created_by": 41
    },
    {
        "id": 2267,
        "user_id": 41,
           ...............
    },
    {
        "id": 2268,
        "user_id": 41,
        ...............
    },
    {
        "id": 2271,
        "user_id": 41,
         ...............
    }
   
]

🔟Command : Upcoming Subscription

URL : https://api.subshero.com/api/v1/subscriptions/upcoming

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/subscriptions/upcoming' \
--header 'Accept: application/json'

Example Response :

[
  {
    "id": 4725,
    "user_id": 41,
    "folder_id": 187,
    "brand_id": 1,
    "category_id": 1,
    "alert_id": 1,
    "platform_id": null,
    "type": 1,
    "image": "https://devcdn.subshero.com/storage/c3lzdGVtL3N1YnNjcmlwdGlvbi9kZWZhdWx0X2ltYWdlLnBuZw==?v=1.79",
    "favicon": "https://devcdn.subshero.com/storage/c3lzdGVtL3N1YnNjcmlwdGlvbi9kZWZhdWx0X2ltYWdlLnBuZw==?v=1.79",
    "product_name": "Byg",
    "brandname": "Subscription",
    "product_type": 1,
    "description": "Default Sub",
    "price": 34.99,
    "price_type": "USD",
    "recurring": 1,
    "payment_date": "2022-11-09",
    "next_payment_date": "2022-12-09",
    "payment_date_upd": "2022-11-09",
    "expiry_date": null,
    "contract_expiry": null,
    "homepage": null,
    "pay_gateway_id": 0,
    "note": "This is sub",
    "company_name": null,
    "discount_voucher": null,
    "payment_mode": null,
    "payment_mode_id": 654,
    "include_notes": null,
    "alert_type": 1,
    "url": null,
    "support_details": null,
    "tags": null,
    "billing_frequency": 1,
    "billing_cycle": 3,
    "billing_type": 2,
    "ltdval_price": null,
    "ltdval_frequency": null,
    "ltdval_cycle": null,
    "status": 1,
    "pricing_type": 1,
    "timezone": "Asia/Kolkata",
    "currency_code": "USD",
    "refund_days": null,
    "refund_date": null,
    "base_value": "34.99",
    "base_currency": "USD",
    "rating": 0,
    "sub_addon": 0,
    "sub_id": null,
    "created_at": "2022-11-09 13:56:07",
    "created_by": 41,
    "type_value": "Subscription",
    "recurring_value": "Recurring",
    "billing_cycle_value": "Monthly",
    "billing_type_value": "Date",
    "ltdval_cycle_value": null,
    "status_value": "Active",
    "pricing_type_value": "Subscription",
    "sub_addon_value": "Subscription"
  },
  {
    "id": 4742,
      .............
    }
  {
    "id": 4745,
      .............
    }
]

1️⃣1️⃣Command :Alert Profile Search 

URL : https://api.subshero.com/api/v1/alerts/?q=notification&start=0&length=15&sort=created_at:desc

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request GET 'https://api.subshero.com/api/v1/alerts/?q=notification&start=0&length=15&sort=created_at:desc' \
--header 'Accept: application/json'

Example Response :

[
  {
    "id": 140,
    "user_id": 41,
    "is_default": 0,
    "time_period": 5,
    "time_cycle": null,
    "time": "14:13:00",
    "alert_condition": 2,
    "alert_contact": null,
    "alert_type": 1,
    "alert_name": "Mobile notifications",
    "timezone": "Asia/Kolkata",
    "alert_subs_type": 1,
    "created_at": "2022-11-14T11:35:43.000000Z",
    "updated_at": "2022-11-14T11:35:43.000000Z"
  }
]

1️⃣2️⃣ Command : Alert Profile Get by id

 URL : https://api.subshero.com/api/v1/alerts/145

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/alerts/145' \
--header 'Accept: application/json'

Example Response :

{
  "id": 145,
  "user_id": 41,
  "is_default": 0,
  "time_period": 2,
  "time_cycle": null,
  "time": "14:13:00",
  "alert_condition": 2,
  "alert_contact": null,
  "alert_type": 1,
  "alert_name": "Subs_alert",
  "timezone": "Asia/Kolkata",
  "alert_subs_type": 2,
  "created_at": "2022-12-08T07:59:29.000000Z",
  "updated_at": "2022-12-08T07:59:29.000000Z"
}

1️⃣3️⃣Command: Settings Get

 URL : https://api.subshero.com/api/v1/settings/extension

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/settings/extension ' \
--header 'Accept: application/json'

Example Response :

{
  "extension": {
    "auto_detect_subscriptions": 0,
    "browser_notifications": 1,
    "notify_before": 1
  }
}

1️⃣4️⃣Command: Calendar Get

 URL : https://api.subshero.com/api/v1/calendar

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request GET ' https://api.subshero.com/api/v1/calendar' \
--header 'Accept: application/json'

Example Response :

[
  {
    "id": 20111,
    "subscription_id": 2280,
    "user_id": 41,
    "folder_id": 0,
    "brand_id": 1,
    "category_id": null,
    "alert_id": 1,
    "type": 1,
    "image": "https://api.subshero.com/storage/c3lzdGVtL3N1YnNjcmlwdGlvbi9kZWZhdWx0X2ltYWdlLnBuZw==",
    "favicon": null,
    "product_name": "Flimingo",
    "brandname": null,
    "product_type": null,
    "description": null,
    "price": 9000,
    "price_type": "INR",
    "recurring": 1,
    "payment_date": "2022-01-09",
    "next_payment_date": "2022-03-22",
    "payment_date_upd": "2022-03-22",
    "expiry_date": null,
    "contract_expiry": null,
    "homepage": null,
    "pay_gateway_id": 0,
    "note": null,
    "company_name": null,
    "discount_voucher": null,
    "payment_mode": null,
    "payment_mode_id": null,
    "include_notes": null,
    "alert_type": null,
    "url": null,
    "support_details": null,
    "tags": null,
    "billing_frequency": 1,
    "billing_cycle": 1,
    "billing_type": 2,
    "ltdval_price": null,
    "ltdval_frequency": null,
    "ltdval_cycle": null,
    "status": 1,
    "pricing_type": null,
    "timezone": "Asia/Kolkata",
    "currency_code": null,
    "refund_days": null,
    "refund_date": null,
    "base_value": "9000.00",
    "base_currency": "USD",
    "rating": 0,
    "created_at": "2022-03-21T17:05:04.000000Z",
    "created_by": 41
  },
  {
    "id": 20110,
    "subscription_id": 2280,
    "user_id": 41,
    "folder_id": 0,
    "brand_id": 1,
    "category_id": null,
    "alert_id": 1,
    "type": 1,
    "image": "https://api.subshero.com/storage/c3lzdGVtL3N1YnNjcmlwdGlvbi9kZWZhdWx0X2ltYWdlLnBuZw==",
    "favicon": null,
    "product_name": "Flimingo",
    "brandname": null,
    "product_type": null,
    "description": null,
    "price": 9000,
    "price_type": "INR",
    "recurring": 1,
    "payment_date": "2022-01-09",
    "next_payment_date": "2022-03-21",
    "payment_date_upd": "2022-03-21",
    "expiry_date": null,
    "contract_expiry": null,
    "homepage": null,
    "pay_gateway_id": 0,
    "note": null,
    "company_name": null,
    "discount_voucher": null,
    "payment_mode": null,
    "payment_mode_id": null,
    "include_notes": null,
    "alert_type": null,
    "url": null,
    "support_details": null,
    "tags": null,
    "billing_frequency": 1,
    "billing_cycle": 1,
    "billing_type": 2,
    "ltdval_price": null,
    "ltdval_frequency": null,
    "ltdval_cycle": null,
    "status": 1,
    "pricing_type": null,
    "timezone": "Asia/Kolkata",
    "currency_code": null,
    "refund_days": null,
    "refund_date": null,
    "base_value": "9000.00",
    "base_currency": "USD",
    "rating": 0,
    "created_at": "2022-03-21T17:05:04.000000Z",
    "created_by": 41
  },
....... ]

PUT Commands

1️⃣Command: Subscription Update

 URL : https://api.subshero.com/api/v1/subscriptions/2280

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request:

curl --location -g --request PUT ' https://api.subshero.com/api/v1/subscriptions/2280' \
--header 'Accept: application/json' \
--data-urlencode 'id=1' \
--data-urlencode 'brand_id=1' \
--data-urlencode 'type=1' \
--data-urlencode 'price=9000' \
--data-urlencode 'currency_code=USD' \
--data-urlencode 'billing_type=2' \
--data-urlencode 'billing_frequency=1' \
--data-urlencode 'billing_cycle=1' \
--data-urlencode 'payment_date=2022-01-09' \
--data-urlencode 'status=1' \
--data-urlencode 'recurring=1'

Example Response :

{
    "status": true,
    "message": "Success"
}

2️⃣Command: Settings Save

URL : https://api.subshero.com/api/v1/settings/extension

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request PUT ' https://api.subshero.com/api/v1/settings/extension' \
--header 'Accept: application/json' \
--data-urlencode 'auto_detect_subscriptions=0' \
--data-urlencode 'browser_notifications=1' \
--data-urlencode 'notify_before=1'

Example Response :

{
  "status": true,
  "message": "Success"
}

3️⃣Command : Alert Profile Update

 URL : https://api.subshero.com/api/v1/alerts/145

  • Success Code : API request returns 200 ok status.

  • Error Code : Returns 400 "Bad request" on no result found

Example Request :

curl --location -g --request PUT " https://api.subshero.com/api/v1/alerts/145" \
--header 'Accept: application/json' \
--data-urlencode 'alert_name=Subscription_Alert' \
--data-urlencode 'time_period=3' \
--data-urlencode 'time=14:13' \
--data-urlencode 'alert_condition=1' \
--data-urlencode 'alert_type=1' \
--data-urlencode 'timezone=America/New_York' \
--data-urlencode 'alert_subs_type=1'

Example Response :

{
  "id": 145,
  "user_id": 41,
  "is_default": 0,
  "time_period": "3",
  "time_cycle": null,
  "time": "14:13",
  "alert_condition": "1",
  "alert_contact": null,
  "alert_type": "1",
  "alert_name": "Subscription_Alert",
  "timezone": "America/New_York",
  "alert_subs_type": "1",
  "created_at": "2022-12-08T07:59:29.000000Z",
  "updated_at": "2022-12-08T08:05:49.000000Z"
}

Delete Command

1️⃣Command: Subscription Delete

 URL : https://api.subshero.com/api/v1/subscriptions/2265

  • Success Code : API request returns 200 ok status.

Example Request :

curl --location -g --request DELETE ' https://api.subshero.com/api/v1/subscriptions/2265' \
--header 'Accept: application/json'

Example Response :

{
    "status": true,
    "message": "Success"
}

2️⃣Command : Alert Profile Delete

 URL : https://api.subshero.com/api/v1/alerts/146

  • Success Code : API request returns 200 ok status.

Example Request :

curl --location -g --request DELETE ' https://api.subshero.com/api/v1/alerts/146' \
--header 'Accept: application/json'

Example Response :

{
    "status": true,
    "message": "Success"
}

Dev Docs

The API documentation created using postman

2 articles in this category.
Written by Saniya Gazala.