Skip to content

Get subscription details

GET
/subscriptions/{id}
api.funnelfox.io
id
required
string

Subscription ID

Fox-Secret
required
string

Example: secret_

Project Secret Key

200 Subscription details

Section titled “200”
Media typeapplication/json
object
id
required
string
psp_id
required
string
status
required
string
one of created trialing active paused cancelled expired unpaid
profile
required
object
Show 4 propertiesHide properties
id
required
string
email
string
created_at
required
string format: date-time
preview
boolean
funnel
required
object
Show 4 propertiesHide properties
id
required
string
title
required
string
alias
required

Alias/slug for the funnel

string
type
required
string
one of default cancellation retargeting
funnel_version
required
integer
funnel_locale
string
experiment
object
Show 4 propertiesHide properties
id
required
string
title
required
string
alias
required
string
enabled
required
boolean
session
required
object
Show 4 propertiesHide properties
id
required
string
created_at
required
string format: date-time
locale
string
user_agent
string
product_id
string
product
object
Show 3 propertiesHide properties
id
required
string
name
required
string
status
required
string
one of active archived
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
billing_interval
required
string
one of day week month year
billing_interval_count
required
integer
trial_offer
string
one of free paid
trial_transaction_id
string
payment_provider
required
string
one of stripe paddle paypal braintree solidgate
renews
required
boolean
sandbox
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time
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
paused_at
string format: date-time
cancelled_at
string format: date-time
cancellation_reason
string
renewed_at
string format: date-time
upgrades_to
string
custom_entitlement
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

404 Subscription not found

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