Search and filter subscriptions
POST
/subscription/search
billing.funnelfox.comReturn subscriptions list with filters and pagination.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”org_id
required
string
Organization ID
Request bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
FilterSubscriptionIn
object
external_id
string
intro_type
Any of:
IntroTypeEnum
string
subs_id
string format: uuid
status_eq
Array
status_consists
Array
created_at_from
string format: date-time
created_at_to
string format: date-time
order_by
SubsOrderBy
string
sort_direction
SortDirection
string
limit
Limit
integer
page
Page
integer
next_check_from
string format: date-time
next_check_to
string format: date-time
Responses
Section titled “Responses”200 List of subscriptions
Section titled “200”Media typeapplication/json
SubscriptionListOut
object
subscriptions
required
Subscriptions
Array<object>
SubscriptionOutShow 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
PricePointOutShow 13 propertiesHide properties
ident
required
Ident
string
currency
required
object
CurrencyOutShow 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
intro_free_trial_period
integer
intro_free_trial_period_duration
Any of:
DurationEnum
string
intro_paid_trial_period
integer
intro_paid_trial_period_duration
Any of:
DurationEnum
string
next_period
integer
next_period_duration
Any of:
DurationEnum
string
features
required
Features
Premium features included in this price point
Array<object>
FeatureOutShow 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
next_payment_at
string format: date-time
iteration
required
Iteration
Cycle iteratin
integer
available_actions
required
Available Actions
Actions available for this subscription
Array<string>
initial_order_metadata
required
object
Initial Order MetadataMetadata from the initial order that created this subscription
Show 1 propertyHide property
key
additional properties
any
discounts
required
Discounts
Discount
Array<object>
DiscountOutShow 6 propertiesHide properties
discount_id
required
Discount Id
string format: uuid
subs_id
required
Subs Id
string format: uuid
count_of_iterations
required
integer
count_of_iterations_available
required
integer
percent
required
integer
report
required
object
ReportShow 1 propertyHide property
key
additional properties
string
unused_premium_after_pause
integer