Subscriptions
Subscriptions allow you to charge customers on a recurring basis. Customers can subscribe through 8Pay’s hosted checkout pages that can be reached by embedded buttons, short urls and QR codes.
Statuses
Subscriptions can be in four different statuses:
ACTIVE
: the current cycle was paidEXPIRED
: the latest cycle is over, a payment is due for the next oneCANCELLED
: the subscription was cancelled by the userTERMINATED
: the subscription was terminated by the vendor
Get a list of subscriptions
GET
https://api.8pay.network/v1/:chain/fixed-recurring/subscriptions
Path Parameters
Query Parameters
user
string
filter by user
status
string
filter by status (ACTIVE
, EXPIRED
, CANCELLED
or TERMINATED
)
from
number
filter by subscribedAt
(default 0)
to
number
filter by subscribedAt
(default current timestamp)
sortBy
string
order by subscribedAt
, cycleStart
or cycleEnd
(default subscribedAt
)
sort
string
asc
or desc
(default desc
), sort based on sortBy
query parameter
Headers
Authorization
string
Bearer <api-key>
Get subscriptions of a plan
GET
https://api.8pay.network/v1/:chain/fixed-recurring/plans/:planId/subscriptions
Path Parameters
planId
string
ID of the plan
Query Parameters
user
string
filter by user
status
string
filter by status (ACTIVE
, EXPIRED
, CANCELLED
or TERMINATED
)
from
number
filter by subscribedAt
(default 0)
to
number
filter by subscribedAt
(default current timestamp)
sortBy
string
order by subscribedAt
, cycleStart
or cycleEnd
(default subscribedAt
)
sort
string
asc
or desc
(default desc
), sort based on sortBy
query parameter
Headers
Authorization
string
Bearer <api-key>
Get a subscription
GET
https://api.8pay.network/v1/:chain/fixed-recurring/subscriptions/:subscriptionId
Path Parameters
subscriptionId
string
ID of the subscription
Headers
Authorization
string
Bearer <api-key>
Last updated