DokumentationEngagement Platform API
Sign inGet started
Guides
API

Subscription

SubscriptionTracker

Defines the tracker class for the subscription semantic package

Example

To track an event using the subscription package, you can use the corresponding method on the tracker instance:
Codebeispiel
Bird.tracker.subscription.subscriptionCreated(event_props, event_opts);

Extends

  • Tracker

Methods

subscriptionCanceled()
Codebeispiel
subscriptionCanceled(props?: SubscriptionSubscriptionCanceledProperties, opts?: BirdEventTrackingOptions): void
Parameters
• props?: SubscriptionSubscriptionCanceledProperties
• opts?: BirdEventTrackingOptions
Returns
void
subscriptionCreated()
Codebeispiel
subscriptionCreated(props?: SubscriptionSubscriptionCreatedProperties, opts?: BirdEventTrackingOptions): void
Parameters
• props?: SubscriptionSubscriptionCreatedProperties
• opts?: BirdEventTrackingOptions
Returns
void
subscriptionUpdated()
Codebeispiel
subscriptionUpdated(props?: SubscriptionSubscriptionUpdatedProperties, opts?: BirdEventTrackingOptions): void
Parameters
• props?: SubscriptionSubscriptionUpdatedProperties
• opts?: BirdEventTrackingOptions
Returns
void

SubscriptionSubscriptionCanceledProperties

Properties for subscription/subscription-canceled event

Indexable

[k: string]: unknown

Properties

PropertyType
end_date?string
order_id?string
product_categories?string[]
product_ids?string[]
product_names?string[]
product_skus?string[]
reason?string
start_date?string
subscription_id?string

SubscriptionSubscriptionCreatedProperties

Properties for subscription/subscription-created event

Indexable

[k: string]: unknown

Properties

PropertyType
end_date?string
order_id?string
product_categories?string[]
product_ids?string[]
product_names?string[]
product_skus?string[]
start_date?string
subscription_id?string

SubscriptionSubscriptionUpdatedProperties

Properties for subscription/subscription-updated event

Indexable

[k: string]: unknown

Properties

PropertyType
end_date?string
order_id?string
product_categories?string[]
product_ids?string[]
product_names?string[]
product_skus?string[]
start_date?string
subscription_id?string