Skip to content

subscription.cycle

POST

Fires when recurrent payment is paid for subscription.

Media typeapplication/json
object
id
required
string

Example: evt_00000000000000000000000000

type
required
string
created_at
required

UNIX timestamp in seconds

integer format: int64
location
required
object
Show 10 propertiesHide properties
funnel_id
required
string
funnel_version
required
integer
origin
required
string
query
required
string
query_params
required
object
Show 1 propertyHide property
key
additional properties
string
sandbox
required
boolean
onboarding
string
experiment_id
string
experiment_title
string
experiment_alias
string
profile
required
object
Show 12 propertiesHide properties
id
required
string

Example: pro_00000000000000000000000000

session_id
required
string

Example: ses_00000000000000000000000000

email
required

User email address

string format: email

Example: me@example.com

country
required
string

Example: GB

ip
required
string

Example: 00.00.000.00

city
required
string

Example: Birmingham

region_code
required

Region or state code, null when geo data is unavailable

string
nullable

Example: FL

postal_code
required

Postal code, null when geo data is unavailable

string
nullable

Example: 33028

time_zone
required
string

Example: Europe/London

user_agent
required
string

Example: Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X)

locale
required

Locale name

string

Example: 🇪🇸 Spanish

locale_code
required

Locale code

string

Example: en_US

funnel_id
string

Example: 00000000000000000000000000

profile_id
string

Example: pro_00000000000000000000000000

project_id
required
string

Example: 00000000000000000000000000

is_sandbox
required
boolean

Example: false

session_id
required
string

Example: ses_00000000000000000000000000

data
required
object
data
required
object
Show 12 propertiesHide properties
entitlement
string
nullable
expires_at
string format: date-time
nullable
session_id
required
string
starts_at
required
string format: date-time
subscription_id
required

FunnelFox internal subscription ID

string

Example: sub_00000000000000000000000000

vendor
required

Payment provider the subscription belongs to: stripe, paddle, paypal, solidgate, fastspring, or billing for FunnelFox Payments. If enabled for your project on request, FunnelFox Payments subscriptions arrive as funnelfox-billing instead of billing. Treat billing and funnelfox-billing as the same provider. Custom payment provider integrations send their own value.

string

Example: stripe

vendor_product_id
required
string
vendor_product_name
string
nullable
vendor_profile_id
required
string
vendor_subscription_id
required
string
vendor_transaction_id
string
nullable
cancellation_source

Where the cancellation came from. Sent only on subscription.auto_renew_off and subscription.cancelled, omitted on other events.

  • funnel — the user cancelled in a cancellation funnel
  • api — cancelled through the FunnelFox API
  • psp — cancelled directly in the payment provider

subscription.cancelled always reports psp: it fires when the provider confirms the end of access.

string
one of funnel api psp

200 Event received successfully

Section titled “200”