Skip to content

Search and filter subscriptions

POST
/subscription/search
billing.funnelfox.com

Return subscriptions list with filters and pagination.

org_id
required
string

Organization ID

Media typeapplication/json
FilterSubscriptionIn
object
external_id
string
nullable · ≤ 256 characters
intro_type
Any of:
IntroTypeEnum
string
one of no_intro free_trial paid_trial
subs_id
string format: uuid
nullable
status_eq
Array
nullable
status_consists
Array
nullable
created_at_from
string format: date-time
nullable
created_at_to
string format: date-time
nullable
order_by
SubsOrderBy
string
default: started_at
one of started_at next_check
sort_direction
SortDirection
string
default: desc
one of asc desc
limit
Limit
integer
default: 100 · ≤ 500
page
Page
integer
default: 1
next_check_from
string format: date-time
nullable
next_check_to
string format: date-time
nullable

200 List of subscriptions

Section titled “200”
Media typeapplication/json
SubscriptionListOut
object
subscriptions
required
Subscriptions
Array<object>
SubscriptionOut
Show 14 propertiesHide properties
subs_id
required
Subs Id
string format: uuid
is_active
required
Is Active

Whether premium features are currently available

boolean
price_point
required
object
PricePointOut
Show 13 propertiesHide properties
ident
required
Ident
string
currency
required
object
CurrencyOut
Show 4 propertiesHide properties
code
required
Code
string
minor_units
required
Minor Units
integer
title
required
Title
string
symbol
required
Symbol
string
intro_type
required
IntroTypeEnum
string
one of no_intro free_trial paid_trial
lifetime_price
Any of:
number
intro_free_trial_period
integer
nullable
intro_free_trial_period_duration
Any of:
DurationEnum
string
one of minutes days weeks months years
intro_paid_trial_price
Any of:
number
intro_paid_trial_period
integer
nullable
intro_paid_trial_period_duration
Any of:
DurationEnum
string
one of minutes days weeks months years
next_price
Any of:
number
next_period
integer
nullable
next_period_duration
Any of:
DurationEnum
string
one of minutes days weeks months years
features
required
Features

Premium features included in this price point

Array<object>
FeatureOut
Show 1 propertyHide property
ident
required
Ident
string
status
required
Status

Current subscription status flags

Array<string>
started_at
required
Started At

When the subscription first started

string format: date-time
current_period_starts_at
required
Current Period Starts At

Start of the current billing period (may be in the future)

string format: date-time
current_period_ends_at
required
Current Period Ends At

End of the current billing period (may be in the past if payment failed)

string format: date-time
next_check_at
required
string format: date-time
nullable
next_payment_at
string format: date-time
nullable
iteration
required
Iteration

Cycle iteratin

integer
available_actions
required
Available Actions

Actions available for this subscription

Array<string>
one of pause resume defer disable_autorenew enable_autorenew create_discount migration
initial_order_metadata
required
object
Initial Order Metadata

Metadata from the initial order that created this subscription

Show 1 propertyHide property
key
additional properties
any
discounts
required
Discounts

Discount

Array<object>
DiscountOut
Show 6 propertiesHide properties
discount_id
required
Discount Id
string format: uuid
subs_id
required
Subs Id
string format: uuid
count_of_iterations
required
integer
nullable
count_of_iterations_available
required
integer
nullable
percent
required
integer
nullable
report
required
object
Report
Show 1 propertyHide property
key
additional properties
string
unused_premium_after_pause
integer
nullable