GET
/
subscriptions
List subscriptions
curl --request GET \
  --url https://api.funnelfox.io/public/v1/subscriptions \
  --header 'Fox-Secret: <fox-secret>'
{
  "data": [
    {
      "id": "<string>",
      "psp_id": "<string>",
      "status": "created",
      "renews": true,
      "sandbox": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "billing_interval": "day",
      "billing_interval_count": 123,
      "price": 100,
      "currency": "<string>",
      "price_usd": 100,
      "funnel_version": 123,
      "payment_provider": "stripe",
      "period_starts_at": "2023-11-07T05:31:56Z",
      "period_ends_at": "2023-11-07T05:31:56Z",
      "profile": {
        "id": "<string>",
        "email": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "preview": true
      },
      "product": {
        "id": "<string>",
        "name": "<string>",
        "status": "active"
      }
    }
  ],
  "pagination": {
    "total": 123,
    "has_more": true
  }
}

Headers

Fox-Secret
string
required

Project Secret Key

Example:

"secret_"

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
cursor
string

Cursor for pagination

filter[profile_id]
string
filter[psp]
string
filter[funnel_id]
string
filter[status]
enum<string>
Available options:
created,
trialing,
active,
paused,
cancelled,
expired,
unpaid

Response

200
application/json

Subscriptions list

The response is of type object.