Plans

Plans define the max billing amount, token and billing period for subscriptions to recurring services and products. You can create a plan using the web app.

Get a list of plans

GET https://api.8pay.network/v1/:chain/variable-recurring/plans

Path Parameters

Name	Type	Description
chain	string	chain identifier

Query Parameters

Name	Type	Description
admin	string	filter by admin
receiver	string	filter by receiver
from	number	filter by createdAt (default 0)
to	number	filter by createdAt (default current timestamp)
sort	string	asc or desc (default desc), sort based on createdAt

Headers

Name	Type	Description
Authorization	string	Bearer <api-key>

200

{
    "data": [
        {
            "id": "0x57b2059e526841b3dfd964144513359c9fcfd6d91040b6c47f589c1e032b6bf7",
            "name": "VPS",
            "admin": "0xe42fD8a58A82fDF624A8a94dA03a0e44F9934Dff",
            "maxAmount": 5.5,
            "token": "8PAY",
            "period": 2592000,
            "receiver": "0xe42fD8a58A82fDF624A8a94dA03a0e44F9934Dff",
            "category": "Streaming services",
            "createdAt": 1575107256,
            "transactionHash": "0x54587230024701c54878c32ca0951c070666f2afccec09ddc1d6921d584cca3c",
            "transactionStatus": "confirmed"
        }
    ],
    "limit": 100,
    "offset": 0,
    "total": 1
}

Get a plan

GET https://api.8pay.network/v1/:chain/variable-recurring/plans/:planId

Path Parameters

Name	Type	Description
planId	string	ID of the plan
chain	string	chain identifier

Headers

Name	Type	Description
Authorization	string	Bearer <api-key>

200

{
    "id": "0x57b2059e526841b3dfd964144513359c9fcfd6d91040b6c47f589c1e032b6bf7",
    "name": "VPS",
    "admin": "0xe42fD8a58A82fDF624A8a94dA03a0e44F9934Dff",
    "maxAmount": 5.5,
    "token": "8PAY",
    "period": 2592000,
    "receiver": "0xe42fD8a58A82fDF624A8a94dA03a0e44F9934Dff",
    "category": "Streaming services",
    "createdAt": 1575107256,
    "transactionHash": "0x54587230024701c54878c32ca0951c070666f2afccec09ddc1d6921d584cca3c",
    "transactionStatus": "confirmed"
}