Skip to main content
GET
/
v0
/
subscriptions
/
list
List Subscriptions
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": null,
        "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
      }
    ],
    "count": 0,
    "cursor": "<string>",
    "hasMore": false
  }
}

Authorizations

​
x-fngs-public-key
string
header
required

Query Parameters

​
status
enum<string>

Filter Subscriptions by their status: - active: Currently active Subscription - past_due: Payment failed but will retry - canceled: Subscription has been canceled - incomplete: Initial payment failed - incomplete_expired: Initial payment failed and expired - trialing: In trial period - unpaid: Payment failed and won't retry

Available options:
all,
active,
canceled,
incomplete,
incomplete_expired,
past_due,
trialing,
paused,
unpaid
​
userId
string<uuid>

Filter Subscriptions by User ID

​
cursor
string

Pagination cursor for fetching next page

​
take
integer
default:10

Number of Subscriptions per page (default: 10, max: 100)

Required range: 1 <= x <= 100

Response

GET /v0/subscriptions/list Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required