Skip to main content
POST
Search and filter subscriptions

Authorizations

ff-secret-key
string
header
required

Secret key for FunnelFox Billing API. Required for all requests.

Path Parameters

org_id
string
required

Organization ID

Body

application/json
external_id
string | null
Maximum string length: 256
intro_type
enum<string> | null
Available options:
no_intro,
free_trial,
paid_trial
subs_id
string<uuid> | null
status_eq
(string | integer)[] | null
status_consists
(string | integer)[] | null
created_at_from
string<date-time> | null
created_at_to
string<date-time> | null
order_by
enum<string>
default:started_at
Available options:
started_at,
next_check
sort_direction
enum<string>
default:desc
Available options:
asc,
desc
limit
integer
default:100
Required range: 0 <= x <= 500
page
integer
default:1
Required range: x >= 0
next_check_from
string<date-time> | null
next_check_to
string<date-time> | null

Response

200 - application/json

List of subscriptions

subscriptions
SubscriptionOut · object[]
required