API Docs
/
No Results Found
Products

Products

A product refers to the service you offer your customers. There can be multiple products created if you offer more than one service. Each product can have different plans and addons associated with it.

Attribute

product_id
string
Unique ID generated by the server for the product.
name
string
Name of your choice to be displayed in the interface.
description
string
Short description regarding the product.
email_ids
string
The email IDs to which notifications related to the product need to be sent. (Use comma separation for multiple email-ids)
redirect_url
string
The URL to which customers should be redirected to once they subscribe to the product.
status
string
Status of the product. It can be active or inactive
created_time
string
The time at which the product was created.
updated_time
string
The time at which the product details were last updated.

Example

{ "product_id": "903000000045027", "name": "PiperHost", "description": "Dedicated server for web hosting", "email_ids": "piper@zillum.com", "redirect_url": "http://www.zillum.com/products/piperhost", "status": "active", "created_time": "2016-06-05T17:38:06-0700", "updated_time": "2016-06-05T20:09:23-0700" }

Create a product

Create a new product.
oauthscope : ZohoSubscriptions.products.CREATE

Arguments

name
string
(Required)
Name of your choice to be displayed in the interface.
description
string
Short description regarding the product.
email_ids
string
The email IDs to which notifications related to the product need to be sent. (Use comma separation for multiple email-ids)
redirect_url
string
The URL to which customers should be redirected to once they subscribe to the product.

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/products -X POST -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "name": "PiperHost", "description": "Dedicated server for web hosting", "email_ids": "piper@zillum.com", "redirect_url": "http://www.zillum.com/products/piperhost" }

Response Example

{ "code": 0, "message": "The product has been created", "product": { "product_id": "903000000045027", "name": "PiperHost", "description": "Dedicated server for web hosting", "email_ids": "piper@zillum.com", "redirect_url": "http://www.zillum.com/products/piperhost", "status": "active", "created_time": "2016-06-05T17:38:06-0700", "updated_time": "2016-06-05T20:09:23-0700" } }

List of all products

List of all created products.
oauthscope : ZohoSubscriptions.products.READ

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/products -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "products": [ { "product_id": "903000000045027", "name": "PiperHost", "description": "Dedicated server for web hosting", "email_ids": "piper@zillum.com", "redirect_url": "http://www.zillum.com/products/piperhost", "status": "active", "created_time": "2016-06-05T17:38:06-0700", "updated_time": "2016-06-05T20:09:23-0700" }, {...}, {...} ] }

Update a product

Update details of an existing product.
oauthscope : ZohoSubscriptions.products.UPDATE

Arguments

name
string
(Required)
Name of your choice to be displayed in the interface.
description
string
Short description regarding the product.
email_ids
string
The email IDs to which notifications related to the product need to be sent. (Use comma separation for multiple email-ids)
redirect_url
string
The URL to which customers should be redirected to once they subscribe to the product.

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/products/{product_id} -X PUT -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "name": "PiperHost", "description": "Dedicated server for web hosting", "email_ids": "piper@zillum.com", "redirect_url": "http://www.zillum.com/products/piperhost" }

Response Example

{ "code": 0, "message": "The product details have been updated.", "product": { "product_id": "903000000045027", "name": "PiperHost", "description": "Dedicated server for web hosting", "email_ids": "piper@zillum.com", "redirect_url": "http://www.zillum.com/products/piperhost", "status": "active", "created_time": "2016-06-05T17:38:06-0700", "updated_time": "2016-06-05T20:09:23-0700" } }

Retrieve a product

Details of an existing product.
oauthscope : ZohoSubscriptions.products.READ

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/products/{product_id} -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "product": { "product_id": "903000000045027", "name": "PiperHost", "description": "Dedicated server for web hosting", "email_ids": "piper@zillum.com", "redirect_url": "http://www.zillum.com/products/piperhost", "status": "active", "created_time": "2016-06-05T17:38:06-0700", "updated_time": "2016-06-05T20:09:23-0700" } }

Delete a product

Delete an existing product.
oauthscope : ZohoSubscriptions.products.DELETE

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/products/{product_id} -X DELETE -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The product has been deleted." }

Mark as active

The product has been marked as active.
oauthscope : ZohoSubscriptions.products.CREATE

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/products/{product_id}/markasactive -X POST -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The product has been marked as active." }

Mark as inactive

The product has been marked as inactive.
oauthscope : ZohoSubscriptions.products.CREATE

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/products/{product_id}/markasinactive -X POST -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The product has been marked as inactive." }