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
Name | Type | Description |
---|---|---|
chain | string |
Query Parameters
Name | Type | Description |
---|---|---|
user | string | filter by user |
status | string | filter by status ( |
from | number | filter by |
to | number | filter by |
sortBy | string | order by |
sort | string |
|
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer <api-key> |
Get subscriptions of a plan
GET
https://api.8pay.network/v1/:chain/fixed-recurring/plans/:planId/subscriptions
Path Parameters
Name | Type | Description |
---|---|---|
planId | string | ID of the plan |
chain | string |
Query Parameters
Name | Type | Description |
---|---|---|
user | string | filter by user |
status | string | filter by status ( |
from | number | filter by |
to | number | filter by |
sortBy | string | order by |
sort | string |
|
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer <api-key> |
Get a subscription
GET
https://api.8pay.network/v1/:chain/fixed-recurring/subscriptions/:subscriptionId
Path Parameters
Name | Type | Description |
---|---|---|
subscriptionId | string | ID of the subscription |
chain | string |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer <api-key> |
Last updated