subscriptions
List subscriptions
subscriptions
List subscriptions
Retrieve a list of subscriptions with optional filtering and pagination.
GET
/
v0
/
subscriptions
/
list
curl --request GET \
--url https://api.fungies.io/v0/subscriptions/list \
--header 'x-fngs-public-key: <api-key>'
{
"status": "<string>",
"data": {
"subscriptions": [
{
"object": "subscription",
"id": "<string>",
"status": "all",
"createdAt": 4503599627370495,
"currentIntervalEnd": 4503599627370495,
"currentIntervalStart": 4503599627370495,
"cancelAtIntervalEnd": false,
"canceledAt": null,
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user": null,
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderNumber": "<string>",
"order": {
"object": "order",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"status": "PENDING"
},
"lastPaymentId": null,
"lastPaymentNumber": null,
"lastPayment": null
}
],
"cursor": "<string>",
"count": 0
}
}
Authorizations
Query Parameters
GET /v0/subscriptions/list Parameter
Available options:
all
, active
, canceled
, incomplete
, incomplete_expired
, past_due
, trialing
, unpaid
, paused
GET /v0/subscriptions/list Parameter
GET /v0/subscriptions/list Parameter
GET /v0/subscriptions/list Parameter
Required range:
0 <= x <= 1.7976931348623157e+308
Response
200
application/json
GET /v0/subscriptions/list Positive response
Allowed value:
"success"
Available options:
all
, active
, canceled
, incomplete
, incomplete_expired
, past_due
, trialing
, unpaid
, paused
Required range:
0 <= x <= 9007199254740991
Required range:
0 <= x <= 9007199254740991
Required range:
0 <= x <= 9007199254740991
Available options:
PENDING
, PAID
, FAILED
, UNPAID
, CANCELLED
, REFUNDED
, PARTIALLY_REFUNDED
, EXPIRED
Available options:
order
Available options:
subscription
Required range:
0 <= x <= 9007199254740991
Available options:
one_time
, subscription_initial
, subscription_update
, subscription_interval
, claim_free
Available options:
PENDING
, PAID
, FAILED
, UNPAID
, CANCELLED
, REFUNDED
, PARTIALLY_REFUNDED
, EXPIRED
Available options:
payment
Required range:
-1.7976931348623157e+308 <= x <= 1.7976931348623157e+308
curl --request GET \
--url https://api.fungies.io/v0/subscriptions/list \
--header 'x-fngs-public-key: <api-key>'
{
"status": "<string>",
"data": {
"subscriptions": [
{
"object": "subscription",
"id": "<string>",
"status": "all",
"createdAt": 4503599627370495,
"currentIntervalEnd": 4503599627370495,
"currentIntervalStart": 4503599627370495,
"cancelAtIntervalEnd": false,
"canceledAt": null,
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user": null,
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderNumber": "<string>",
"order": {
"object": "order",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"status": "PENDING"
},
"lastPaymentId": null,
"lastPaymentNumber": null,
"lastPayment": null
}
],
"cursor": "<string>",
"count": 0
}
}