Skip to content

List subscriptions

GET
/subscriptions
api.funnelfox.io
Fox-Secret
required
string

Example: secret_

Project Secret Key

limit
integer
default: 20 · 1–500

Maximum number of items to return

cursor
string

Cursor for pagination

filter[profile_id]
string
filter[psp]
string
filter[funnel_id]
string
filter[status]
string
one of created trialing active paused cancelled expired unpaid
filter[email]
string
filter[updated_at.from]
string format: date-time

Filter by updated_at >= this value (RFC3339, e.g. 2024-11-01T00:00:00Z)

filter[updated_at.to]
string format: date-time

Filter by updated_at < this value (RFC3339, e.g. 2024-12-01T00:00:00Z)

200 Subscriptions list

Section titled “200”
Media typeapplication/json
object
data
required
Array<object>
Show 19 propertiesHide properties
id
required
string
psp_id
required
string
status
required
string
one of created trialing active paused cancelled expired unpaid
renews
required
boolean
sandbox
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time
billing_interval
required
string
one of day week month year
billing_interval_count
required
integer
price
required

Monetary amount in cents (e.g., $1.00 = 100 cents)

integer
currency
required
string
price_usd
required

Monetary amount in cents (e.g., $1.00 = 100 cents)

integer
funnel_version
required
integer
payment_provider
required
string
one of stripe paddle paypal braintree solidgate
period_starts_at
required
string format: date-time
period_ends_at

End of the current period. When status is trialing, this is the trial end; when cancel_scheduled is true, this is when access ends.

string format: date-time
cancel_scheduled
required

True when status is active or trialing and renews is false; access ends at period_ends_at.

boolean
profile
object
Show 4 propertiesHide properties
id
required
string
email
string
created_at
required
string format: date-time
preview
boolean
product
object
Show 3 propertiesHide properties
id
required
string
name
required
string
status
required
string
one of active archived
pagination
required
object
Show 3 propertiesHide properties
total

Total count of items

integer
has_more
required

Whether there are more items available

boolean
next_cursor

Cursor for next page

string

400 Request error

Section titled “400”
Media typeapplication/json
object
message
required
string

401 Authentication error

Section titled “401”
Media typeapplication/json
object
message
required
string