Skip to main content
GET
Get subscription details

Headers

Fox-Secret
string
required

Project Secret Key

Example:

"secret_"

Path Parameters

id
string
required

Subscription ID

Response

Subscription details

id
string
required
psp_id
string
required
status
enum<string>
required
Available options:
created,
trialing,
active,
paused,
cancelled,
expired,
unpaid
profile
object
required
funnel
object
required
funnel_version
integer
required
session
object
required
price
integer
required

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

Example:

100

currency
string
required
price_usd
integer
required

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

Example:

100

billing_interval
enum<string>
required
Available options:
day,
week,
month,
year
billing_interval_count
integer
required
payment_provider
enum<string>
required
Available options:
stripe,
paddle,
paypal,
braintree,
solidgate
renews
boolean
required
sandbox
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
period_starts_at
string<date-time>
required
funnel_locale
string
experiment
object
product_id
string
product
object
trial_offer
enum<string>
Available options:
free,
paid
trial_transaction_id
string
period_ends_at
string<date-time>
paused_at
string<date-time>
cancelled_at
string<date-time>
cancellation_reason
string
renewed_at
string<date-time>
upgrades_to
string
custom_entitlement
string