Products

Create a product

POST https://api.piriod.com/products/

Creates a new Product object.

Request Body

Name	Type	Description
name	string	A name for product with a max length of 64 characters.
unit_label	string	A unit label for product with a max length of 12 characters.

201 A newly created Product.

{
    "id": "pro_EDYW8YlIY7mrNUb8n6",
    "name": "SimpleDTE Vuetify",
    "unit_label": "cuenta",
    "plans": [],
    "status": "active",
    "test_mode": false,
    "archived": null,
    "created": "2020-07-01T20:36:04.301041-04:00",
    "updated": "2020-07-13T21:05:05.382947-04:00"
}

Retrieve a product

GET https://api.piriod.com/products/{{id}}/

Retrieves a Product object.

Path Parameters

Name	Type	Description
id	string	ID of the Product object.

200 Returns a Product object if a valid payment ID was provided.

{
    "id": "pro_EDYW8YlIY7mrNUb8n6",
    "name": "My Awesome Saas Product",
    "unit_label": "user",
    "plans": [],
    "status": "active",
    "test_mode": false,
    "archived": null,
    "created": "2020-07-01T20:36:04.301041-04:00",
    "updated": "2020-07-01T20:36:04.301041-04:00"
}

Update a product

PATCH https://api.piriod.com/products/{{id}}/

Path Parameters

Name	Type	Description
id	string	ID of the Product object.

Request Body

Name	Type	Description
name	string	A name for product with a max length of 64 characters.
unit_label	string	A unit label for product with a max length of 12 characters.

200 Updated Product object.

{
    "id": "pro_EDYW8YlIY7mrNUb8n6",
    "name": "My Awesome Saas Product",
    "unit_label": "account",
    "plans": [],
    "status": "active",
    "test_mode": false,
    "archived": null,
    "created": "2020-07-01T20:36:04.301041-04:00",
    "updated": "2020-07-14T21:05:05.382947-04:00"
}

Destroy a product

DELETE https://api.piriod.com/products/{{id}}/

Destroy a Product object.

Path Parameters

Name	Type	Description
id	string	ID of the Product object.

204

List products

GET https://api.piriod.com/products/

Retrieves a list of Product objects.

Query Parameters

Name	Type	Description
name	string	Product name to filter results.
plans	string	Plan property to filter results. Accept operators.

200 A lists of Product objects.

{
    "count": 150,
    "next": "https://api.simpledte.com/products/?page=2",
    "previous": null,
    "results": [
        {
            "id": "pro_EDYW8YlIY7mrNUb8n6",
            "name": "My Awesome Saas Product",
            "unit_label": "account",
            "plans": [],
            "status": "active",
            "test_mode": false,
            "archived": null,
            "created": "2020-07-01T20:36:04.301041-04:00",
            "updated": "2020-07-13T21:05:05.382947-04:00"
        },
        ...
    ]
}