# Retrieve an event ``` GET https://api.freemius.com/v1/products/{product_id}/events/{event_id}.json ``` #### Auth:Bearer TokenSCOPE: PRODUCT Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need. 1. Go to the [Freemius Developer Dashboard](https://dashboard.freemius.com/). 2. Open the Settings page of the relevant product. 3. Click the API & Keys tab. 4. Copy the API Bearer Authorization Token from the UI. *** Retrieve a specific event by its ID. For instructions on creating webhook listeners, see the [documentation](https://freemius.com/help/documentation/saas/events-webhooks/#how_to_create_a_webhook). ## Request[​](#request "Direct link to request") ### Path Parameters * **product\_id** integer\[](#param-property-events-retrieve-param-path-product-id "Direct link to product_id")required The ID of the product. **Possible values:** `>= 1` **Example: **`1234` **event\_id** integer\[](#param-property-events-retrieve-param-path-event-id "Direct link to event_id")required The ID of the event. **Possible values:** `>= 1` **Example: **`1234` ### Query Parameters * **fields** string[](#param-property-events-retrieve-param-query-fields "Direct link to fields") Comma separated list of fields to return in the response. If not specified, all fields are returned. **Example: **`id,name,slug` ## Responses[​](#responses "Direct link to Responses") * 200 * 400 * 401 * 402 * 404 The retrieved event. application/json **Schema** **state**string[](#schema-property-events-retrieve-response-schema-state-string "Direct link to state") State of the event log. It essentially says whether the event was processed through the webhook or not. **Possible values:** \[`processed`, `pending`, `canceled`, `error`] **id**string\[](#schema-property-events-retrieve-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-events-retrieve-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-events-retrieve-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **type**string[](#schema-property-events-retrieve-response-schema-type-string "Direct link to type") The type of event. See our documented list of the available [event types](https://freemius.com/help/documentation/marketing-automation/events-webhooks/#event_types). **Example: **`license.activated` **developer\_id**string\[](#schema-property-events-retrieve-response-schema-developer-id-string-int64 "Direct link to developer_id") The ID of the developer. **Possible values:** `>= 1` **Example: **`1234` **plugin\_id**string\[](#schema-property-events-retrieve-response-schema-plugin-id-string-int64 "Direct link to plugin_id")nullable The ID of the product the entity belongs to. Null means it has not been associated with a product yet. **Possible values:** `>= 1` **Example: **`123456` **user\_id**string\[](#schema-property-events-retrieve-response-schema-user-id-string-int64 "Direct link to user_id")nullable The ID of the user the entity belongs to. If NULL then still not associated to any user. **Possible values:** `>= 1` **Example: **`123456` **install\_id**string\[](#schema-property-events-retrieve-response-schema-install-id-string-int64 "Direct link to install_id")nullable The ID of the installation or site the entity is associated with, a `null` value means it has not been associated with an installation yet. **Possible values:** `>= 1` **Example: **`123456` **data**[](#schema-property-events-retrieve-response-schema-data "Direct link to data")nullable The details of the triggered event. This can be a `string` showing ID of the associated entity, an `object` with additional information of the event, or array of objects. **event\_trigger**string[](#schema-property-events-retrieve-response-schema-event-trigger-string "Direct link to event_trigger") The type of trigger for the event. **Possible values:** \[`system`, `developer`, `plugin`, `user`, `install`] **Example: **`system` **process\_time**string\[](#schema-property-events-retrieve-response-schema-process-time-string-date-time "Direct link to process_time")nullable The time the event was processed. If it is `null`, the event is pending. **Example: **`2025-01-01 12:00:00` **objects** object A map of related objects keyed by their type or ID, such as Payment, User, Install, or License. **user** objectnullable oneOf * UserPluginEnriched **note**string[](#schema-property-events-retrieve-response-schema-note-string "Direct link to note") A note about the user. Only visible to the developer. **is\_marketing\_allowed**boolean[](#schema-property-events-retrieve-response-schema-is-marketing-allowed-boolean "Direct link to is_marketing_allowed")nullable Whether the user has consented for marketing notifications. **is\_beta**boolean[](#schema-property-events-retrieve-response-schema-is-beta-boolean "Direct link to is_beta") Whether or not the user has opted-in to beta versions. We do not recommend using this option anymore since it will opt-in the user to all sites/activations. Currently, sites or activations can be managed individually. **email**string[](#schema-property-events-retrieve-response-schema-email-string "Direct link to email") Email address of the person. **Example: **`jane@example.com` **first**string[](#schema-property-events-retrieve-response-schema-first-string "Direct link to first") First name of the person. **Example: **`Jane` **last**string[](#schema-property-events-retrieve-response-schema-last-string "Direct link to last") Last name of the person. **Example: **`Doe` **picture**string[](#schema-property-events-retrieve-response-schema-picture-string "Direct link to picture") Profile picture URL. **Example: **`https://example.com/profile-pic.jpg` **ip**string\[](#schema-property-events-retrieve-response-schema-ip-string-ipv4-ipv6 "Direct link to ip")nullable The IP address (v4 or v6). **Example: **`127.0.0.1` **is\_verified**boolean[](#schema-property-events-retrieve-response-schema-is-verified-boolean "Direct link to is_verified") Whether the person is trusted or not. **Example: **`true` **auth**string[](#schema-property-events-retrieve-response-schema-auth-string "Direct link to auth") The type of authentication. If `app2fa` is set, the person has signed for 2FA authentication. **Possible values:** \[`app2fa`, `password`] **secret\_key**string[](#schema-property-events-retrieve-response-schema-secret-key-string "Direct link to secret_key") The secret key associated with the entity for authorization. **Example: **`sk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6` **public\_key**string[](#schema-property-events-retrieve-response-schema-public-key-string "Direct link to public_key") The public key associated with the entity for authorization. **Example: **`pk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6` **id**string\[](#schema-property-events-retrieve-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-events-retrieve-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-events-retrieve-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **gross**number\[](#schema-property-events-retrieve-response-schema-gross-number-float "Direct link to gross") Gross payments made by the user for the product **Example: **`999` **last\_login\_at**string\[](#schema-property-events-retrieve-response-schema-last-login-at-string-date-time "Direct link to last_login_at")nullable Date and time of the last login. **Example: **`2025-07-30 05:56:29` **email\_status**string[](#schema-property-events-retrieve-response-schema-email-status-string "Direct link to email_status") The status of the last email sent to the user. **Possible values:** \[`delivered`, `bounce`, `dropped`] **plugin\_id**string\[](#schema-property-events-retrieve-response-schema-plugin-id-string-int64 "Direct link to plugin_id") The ID of the product the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **user\_id**string\[](#schema-property-events-retrieve-response-schema-user-id-string-int64 "Direct link to user_id") The ID of the user the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **install** objectnullable oneOf * Install **secret\_key**string[](#schema-property-events-retrieve-response-schema-secret-key-string "Direct link to secret_key") The secret key associated with the entity for authorization. **Example: **`sk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6` **public\_key**string[](#schema-property-events-retrieve-response-schema-public-key-string "Direct link to public_key") The public key associated with the entity for authorization. **Example: **`pk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6` **id**string\[](#schema-property-events-retrieve-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-events-retrieve-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-events-retrieve-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **site\_id**string\[](#schema-property-events-retrieve-response-schema-site-id-string-int64 "Direct link to site_id") The ID of the site. **Example: **`1234` **plugin\_id**string\[](#schema-property-events-retrieve-response-schema-plugin-id-string-int64 "Direct link to plugin_id") The ID of the product the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **user\_id**string\[](#schema-property-events-retrieve-response-schema-user-id-string-int64 "Direct link to user_id") The ID of the user the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **url**string[](#schema-property-events-retrieve-response-schema-url-string "Direct link to url")nullable The site URL. **Example: **`https://example.com` **title**string[](#schema-property-events-retrieve-response-schema-title-string "Direct link to title")nullable The site title. **Example: **`Catwalk Designs` **version**string[](#schema-property-events-retrieve-response-schema-version-string "Direct link to version") The Product version. **Example: **`1.0.0` **plan\_id**string\[](#schema-property-events-retrieve-response-schema-plan-id-string-int64 "Direct link to plan_id") The ID of the plan associated with the product that the install has a license activation. If `null` it means the install is using the free plan. **Possible values:** `>= 1` **Example: **`1234` **license\_id**string\[](#schema-property-events-retrieve-response-schema-license-id-string-int64 "Direct link to license_id")nullable The ID of the license associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **trial\_plan\_id**string\[](#schema-property-events-retrieve-response-schema-trial-plan-id-string-int64 "Direct link to trial_plan_id") The ID of the trial license associated to the product. If this is not a trial, this will be `null`. **Possible values:** `>= 1` **Example: **`1234` **trial\_ends**string\[](#schema-property-events-retrieve-response-schema-trial-ends-string-date-time "Direct link to trial_ends")nullable The product trial license expiry date. If this is not a trial, this will be null. **Example: **`2025-01-01 00:00:00` **subscription\_id**string\[](#schema-property-events-retrieve-response-schema-subscription-id-string-int64 "Direct link to subscription_id")nullable The ID of the subscription associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **gross**number\[](#schema-property-events-retrieve-response-schema-gross-number-float "Direct link to gross") The gross amount the install has spent on the product. This includes one time purchase, or subscriptions and renewals. **Example: **`100` **country\_code**string[](#schema-property-events-retrieve-response-schema-country-code-string "Direct link to country_code")nullable The [ISO 3166-1 alpha 2](http://www.wikiwand.com/en/ISO_3166-1_alpha-2) two-letter country code associated with the entity. **Example: **`us` **language**string[](#schema-property-events-retrieve-response-schema-language-string "Direct link to language")nullable The language specified for the product install. **Example: **`en-GB` **platform\_version**string[](#schema-property-events-retrieve-response-schema-platform-version-string "Direct link to platform_version")nullable The platform version (e.g WordPress version). **Example: **`1.0.0` **sdk\_version**string[](#schema-property-events-retrieve-response-schema-sdk-version-string "Direct link to sdk_version")nullable The Freemius SDK version. Only relevant for WordPress products using the Freemius [WP SDK](https://freemius.com/help/documentation/wordpress-sdk/). **Example: **`1.2.2` **programming\_language\_version**string[](#schema-property-events-retrieve-response-schema-programming-language-version-string "Direct link to programming_language_version")nullable The programming language version (e.g PHP version). **Example: **`5.6` **is\_active**boolean[](#schema-property-events-retrieve-response-schema-is-active-boolean "Direct link to is_active") If the product is actively installed on the site. **is\_disconnected**boolean[](#schema-property-events-retrieve-response-schema-is-disconnected-boolean "Direct link to is_disconnected") If the product is disconnected on the site. **is\_premium**boolean[](#schema-property-events-retrieve-response-schema-is-premium-boolean "Direct link to is_premium") If the install using the premium code. Relevant only for WP Products. **is\_uninstalled**boolean[](#schema-property-events-retrieve-response-schema-is-uninstalled-boolean "Direct link to is_uninstalled") If the product is uninstalled on the site. **is\_locked**boolean[](#schema-property-events-retrieve-response-schema-is-locked-boolean "Direct link to is_locked") If the product is locked on the site. **source**number[](#schema-property-events-retrieve-response-schema-source-number "Direct link to source") The source of the migration data. To get support migrating from other platform please see our [documentation](https://freemius.com/help/documentation/migration/). * `0` - Freemius * `1` - Other * `2` - Easy Digital Downloads (EDD) * `3` - WooCommerce (WC) * `4` - Rating Widget * `5` - Gumroad * `6` - CodeCanyon * `7` - ThemeForest * `8` - AppSumo * `9` - SendOwl * `10` - WHMCS * `11` - Lemon Squeezy **Possible values:** \[`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`] **upgraded**string\[](#schema-property-events-retrieve-response-schema-upgraded-string-date-time "Direct link to upgraded")nullable Time when the product was upgraded to the current version. If never upgraded since the initial installation, this will be `null`. **Example: **`2025-01-01 00:00:00` **last\_seen\_at**string\[](#schema-property-events-retrieve-response-schema-last-seen-at-string-date-time "Direct link to last_seen_at")nullable The last time the product was used on the site. **Example: **`2025-01-01 00:00:00` **last\_served\_update\_version**string[](#schema-property-events-retrieve-response-schema-last-served-update-version-string "Direct link to last_served_update_version")nullable The last product version update used on the site. If not updated, this will be null. **Example: **`1.2.2` **payment** objectnullable oneOf * Payment **user\_id**string\[](#schema-property-events-retrieve-response-schema-user-id-string-int64 "Direct link to user_id") The ID of the user the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **install\_id**string\[](#schema-property-events-retrieve-response-schema-install-id-string-int64 "Direct link to install_id")nullable The ID of the installation or site the entity is associated with, a `null` value means it has not been associated with an installation yet. **Possible values:** `>= 1` **Example: **`123456` **plan\_id**string\[](#schema-property-events-retrieve-response-schema-plan-id-string-int64 "Direct link to plan_id") The ID of the plan associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **pricing\_id**string\[](#schema-property-events-retrieve-response-schema-pricing-id-string-int64 "Direct link to pricing_id") The ID of the pricing associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **license\_id**string\[](#schema-property-events-retrieve-response-schema-license-id-string-int64 "Direct link to license_id") The ID of the license associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **ip**string\[](#schema-property-events-retrieve-response-schema-ip-string-ipv4-ipv6 "Direct link to ip")nullable The IP address associated with the entity. **Example: **`0.0.0.0` **country\_code**string[](#schema-property-events-retrieve-response-schema-country-code-string "Direct link to country_code") The [ISO 3166-1 alpha 2](http://www.wikiwand.com/en/ISO_3166-1_alpha-2) two-letter country code associated with the entity. **Example: **`us` **zip\_postal\_code**string[](#schema-property-events-retrieve-response-schema-zip-postal-code-string "Direct link to zip_postal_code")nullable The postal/zip code of the location. **Example: **`92710` **vat\_id**string[](#schema-property-events-retrieve-response-schema-vat-id-string "Direct link to vat_id")nullable The business VAT number (EU or UK territories) or other tax ID (for example Sales Tax ID for the US). **Example: **`GB12345678` **coupon\_id**string\[](#schema-property-events-retrieve-response-schema-coupon-id-string-int64 "Direct link to coupon_id")nullable The ID of the coupon associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **user\_card\_id**string\[](#schema-property-events-retrieve-response-schema-user-card-id-string-int64 "Direct link to user_card_id") The ID of the user card that was used for this payment. **Example: **`12345` **source**number[](#schema-property-events-retrieve-response-schema-source-number "Direct link to source") The source of the migration data. To get support migrating from other platform please see our [documentation](https://freemius.com/help/documentation/migration/). * `0` - Freemius * `1` - Other * `2` - Easy Digital Downloads (EDD) * `3` - WooCommerce (WC) * `4` - Rating Widget * `5` - Gumroad * `6` - CodeCanyon * `7` - ThemeForest * `8` - AppSumo * `9` - SendOwl * `10` - WHMCS * `11` - Lemon Squeezy **Possible values:** \[`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`] **plugin\_id**string\[](#schema-property-events-retrieve-response-schema-plugin-id-string-int64 "Direct link to plugin_id") The ID of the product the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **external\_id**string[](#schema-property-events-retrieve-response-schema-external-id-string "Direct link to external_id") The external ID of the gateway entity. **Example: **`abcde12345` **gateway**string[](#schema-property-events-retrieve-response-schema-gateway-string "Direct link to gateway")nullable The gateway used for the purchase. The gateway will be set to `null` when purchasing a product with a 100% discount. **environment**number[](#schema-property-events-retrieve-response-schema-environment-number "Direct link to environment") The environment the entity belongs to. 0 means it belongs to the production environment, 1 means it belongs to the sandbox environment. **Possible values:** \[`1`, `0`] **Example: **`0` **id**string\[](#schema-property-events-retrieve-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-events-retrieve-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-events-retrieve-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **currency**string[](#schema-property-events-retrieve-response-schema-currency-string "Direct link to currency") 3-char currency code. **Possible values:** `>= 3 characters` and `<= 3 characters`, \[`usd`, `eur`, `gbp`] **refund\_reason**string[](#schema-property-events-retrieve-response-schema-refund-reason-string "Direct link to refund_reason")nullable **Example: **`Refunded due to a bug in the plugin.` **subscription\_id**string\[](#schema-property-events-retrieve-response-schema-subscription-id-string-int64 "Direct link to subscription_id")nullable The ID of the subscription associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **payment\_presentment\_id**string\[](#schema-property-events-retrieve-response-schema-payment-presentment-id-string-int64 "Direct link to payment_presentment_id") The ID of the presentment payment. **Possible values:** `>= 1` **Example: **`123456` **gross**number\[](#schema-property-events-retrieve-response-schema-gross-number-float "Direct link to gross") The payment amount (not including taxes). **Example: **`2075.45` **bound\_payment\_id**string\[](#schema-property-events-retrieve-response-schema-bound-payment-id-string-int64 "Direct link to bound_payment_id") The ID of the payment that this payment is bound to, in case of a refund or chargeback/dispute. **Possible values:** `>= 1` **Example: **`123456` **gateway\_fee**number\[](#schema-property-events-retrieve-response-schema-gateway-fee-number-float "Direct link to gateway_fee") **Default value: **`0` The fee that the gateway took for processing this payment. **Example: **`2.99` **vat**number[](#schema-property-events-retrieve-response-schema-vat-number "Direct link to vat") **Default value: **`0` The actual tax amount. It could be any kind of tax, not necessarily VAT. For example we support US Sales Tax. **Example: **`1.24` **is\_renewal**boolean[](#schema-property-events-retrieve-response-schema-is-renewal-boolean "Direct link to is_renewal") **Default value: **`false` If the payment is a renewal. **type**string[](#schema-property-events-retrieve-response-schema-type-string "Direct link to type") **Default value: **`payment` The type of the payment. **Possible values:** \[`payment`, `refund`, `disputed`, `won_dispute`, `lost_dispute`, `chargeback`] **subscription** objectnullable oneOf * Subscription **user\_id**string\[](#schema-property-events-retrieve-response-schema-user-id-string-int64 "Direct link to user_id") The ID of the user the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **install\_id**string\[](#schema-property-events-retrieve-response-schema-install-id-string-int64 "Direct link to install_id")nullable The ID of the installation or site the entity is associated with, a `null` value means it has not been associated with an installation yet. **Possible values:** `>= 1` **Example: **`123456` **plan\_id**string\[](#schema-property-events-retrieve-response-schema-plan-id-string-int64 "Direct link to plan_id") The ID of the plan associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **pricing\_id**string\[](#schema-property-events-retrieve-response-schema-pricing-id-string-int64 "Direct link to pricing_id") The ID of the pricing associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **license\_id**string\[](#schema-property-events-retrieve-response-schema-license-id-string-int64 "Direct link to license_id") The ID of the license associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **ip**string\[](#schema-property-events-retrieve-response-schema-ip-string-ipv4-ipv6 "Direct link to ip")nullable The IP address associated with the entity. **Example: **`0.0.0.0` **country\_code**string[](#schema-property-events-retrieve-response-schema-country-code-string "Direct link to country_code") The [ISO 3166-1 alpha 2](http://www.wikiwand.com/en/ISO_3166-1_alpha-2) two-letter country code associated with the entity. **Example: **`us` **zip\_postal\_code**string[](#schema-property-events-retrieve-response-schema-zip-postal-code-string "Direct link to zip_postal_code")nullable The postal/zip code of the location. **Example: **`92710` **vat\_id**string[](#schema-property-events-retrieve-response-schema-vat-id-string "Direct link to vat_id")nullable The business VAT number (EU or UK territories) or other tax ID (for example Sales Tax ID for the US). **Example: **`GB12345678` **coupon\_id**string\[](#schema-property-events-retrieve-response-schema-coupon-id-string-int64 "Direct link to coupon_id")nullable The ID of the coupon associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **user\_card\_id**string\[](#schema-property-events-retrieve-response-schema-user-card-id-string-int64 "Direct link to user_card_id") The ID of the user card that was used for this payment. **Example: **`12345` **source**number[](#schema-property-events-retrieve-response-schema-source-number "Direct link to source") The source of the migration data. To get support migrating from other platform please see our [documentation](https://freemius.com/help/documentation/migration/). * `0` - Freemius * `1` - Other * `2` - Easy Digital Downloads (EDD) * `3` - WooCommerce (WC) * `4` - Rating Widget * `5` - Gumroad * `6` - CodeCanyon * `7` - ThemeForest * `8` - AppSumo * `9` - SendOwl * `10` - WHMCS * `11` - Lemon Squeezy **Possible values:** \[`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`] **plugin\_id**string\[](#schema-property-events-retrieve-response-schema-plugin-id-string-int64 "Direct link to plugin_id") The ID of the product the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **external\_id**string[](#schema-property-events-retrieve-response-schema-external-id-string "Direct link to external_id") The external ID of the gateway entity. **Example: **`abcde12345` **gateway**string[](#schema-property-events-retrieve-response-schema-gateway-string "Direct link to gateway")nullable The gateway used for the purchase. The gateway will be set to `null` when purchasing a product with a 100% discount. **environment**number[](#schema-property-events-retrieve-response-schema-environment-number "Direct link to environment") The environment the entity belongs to. 0 means it belongs to the production environment, 1 means it belongs to the sandbox environment. **Possible values:** \[`1`, `0`] **Example: **`0` **id**string\[](#schema-property-events-retrieve-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-events-retrieve-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-events-retrieve-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **currency**string[](#schema-property-events-retrieve-response-schema-currency-string "Direct link to currency") 3-char currency code. **Possible values:** `>= 3 characters` and `<= 3 characters`, \[`usd`, `eur`, `gbp`] **tax\_rate**number\[](#schema-property-events-retrieve-response-schema-tax-rate-number-float "Direct link to tax_rate") The tax rate as a fraction. It will either be US sales tax or VAT. **Possible values:** `>= 0` **Example: **`1.00` **total\_gross**number\[](#schema-property-events-retrieve-response-schema-total-gross-number-float "Direct link to total_gross") The total gross amount of the subscription, including taxes. **Possible values:** `>= 0` **Example: **`1.21` **amount\_per\_cycle**number\[](#schema-property-events-retrieve-response-schema-amount-per-cycle-number-float "Direct link to amount_per_cycle") The plan's original amount per cycle (not including taxes). **Possible values:** `>= 0` **Example: **`1.00` **initial\_amount**number\[](#schema-property-events-retrieve-response-schema-initial-amount-number-float "Direct link to initial_amount") The initial payment amount (not including taxes). **Possible values:** `>= 0` **Example: **`1.00` **renewal\_amount**number\[](#schema-property-events-retrieve-response-schema-renewal-amount-number-float "Direct link to renewal_amount") The renewals amount (not including taxes). **Possible values:** `>= 0` **Example: **`1.00` **renewals\_discount**integer[](#schema-property-events-retrieve-response-schema-renewals-discount-integer "Direct link to renewals_discount") The renewals discount that will be applied to the chosen plan. **Possible values:** `>= 0` **Example: **`1` **renewals\_discount\_type**string[](#schema-property-events-retrieve-response-schema-renewals-discount-type-string "Direct link to renewals_discount_type") The type of renewals discount, percentage or dollar. **Possible values:** \[`percentage`, `dollar`] **billing\_cycle**number[](#schema-property-events-retrieve-response-schema-billing-cycle-number "Direct link to billing_cycle") The billing cycle of the subscription in number of months. 1 means monthly, 12 means annually, 0 means lifetime usually when subscriptions are created for lifetime trials. **Possible values:** \[`1`, `12`, `0`] **outstanding\_balance**number\[](#schema-property-events-retrieve-response-schema-outstanding-balance-number-float "Direct link to outstanding_balance") Any outstanding balance that the user has for this subscription. **Possible values:** `>= 0` **Example: **`1.00` **failed\_payments**integer[](#schema-property-events-retrieve-response-schema-failed-payments-integer "Direct link to failed_payments") Number of failed payments associated with the subscription. **Possible values:** `>= 0` **Example: **`1` **trial\_ends**string\[](#schema-property-events-retrieve-response-schema-trial-ends-string-date-time "Direct link to trial_ends")nullable The date time when the trial period ends. If `null` the subscription is not associated with a trial. **Example: **`2025-01-01 00:00:00` **next\_payment**string\[](#schema-property-events-retrieve-response-schema-next-payment-string-date-time "Direct link to next_payment")nullable Datetime of the next payment, or `null` if cancelled. **Example: **`2025-01-01 00:00:00` **canceled\_at**string\[](#schema-property-events-retrieve-response-schema-canceled-at-string-date-time "Direct link to canceled_at")nullable Datetime of the cancellation. **Example: **`2025-01-01 00:00:00` **license** objectnullable oneOf * License **id**string\[](#schema-property-events-retrieve-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-events-retrieve-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-events-retrieve-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **plugin\_id**string\[](#schema-property-events-retrieve-response-schema-plugin-id-string-int64 "Direct link to plugin_id") The ID of the product the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **user\_id**string\[](#schema-property-events-retrieve-response-schema-user-id-string-int64 "Direct link to user_id")nullable The ID of the user the entity belongs to. If NULL then still not associated to any user. **Possible values:** `>= 1` **Example: **`123456` **plan\_id**string\[](#schema-property-events-retrieve-response-schema-plan-id-string-int64 "Direct link to plan_id") The ID of the plan associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **pricing\_id**string\[](#schema-property-events-retrieve-response-schema-pricing-id-string-int64 "Direct link to pricing_id")nullable The ID of the pricing associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **quota**integer[](#schema-property-events-retrieve-response-schema-quota-integer "Direct link to quota")nullable The maximum number of license activations. If `null` then the license will support unlimited activations. **Example: **`10` **activated**integer[](#schema-property-events-retrieve-response-schema-activated-integer "Direct link to activated") The total number of production activation the license has. This does not count local or staging environment activations. **Example: **`1` **activated\_local**integer[](#schema-property-events-retrieve-response-schema-activated-local-integer "Direct link to activated_local")nullable The number of times the license is activated on local or staging environments. **Example: **`1` **expiration**string\[](#schema-property-events-retrieve-response-schema-expiration-string-date-time "Direct link to expiration")nullable The expiration date of the license. If `null` then it's a lifetime license. **Example: **`2025-12-31 23:59:59` **secret\_key**string[](#schema-property-events-retrieve-response-schema-secret-key-string "Direct link to secret_key") The license key. This is used for activating the license on the user's site. **Example: **`sk_123FGqM456Pa786WtOp%^+67Y+;sXXz` **is\_free\_localhost**boolean[](#schema-property-events-retrieve-response-schema-is-free-localhost-boolean "Direct link to is_free_localhost") **Default value: **`true` Whether the license offers unlimited local or staging environment activations. **is\_block\_features**boolean[](#schema-property-events-retrieve-response-schema-is-block-features-boolean "Direct link to is_block_features") **Default value: **`true` Whether to block features after expiration of the license. If set to `false`, this would not block features, would only block updates. **is\_cancelled**boolean[](#schema-property-events-retrieve-response-schema-is-cancelled-boolean "Direct link to is_cancelled") If the license is canceled from the Developer Dashboard. **is\_whitelabeled**boolean[](#schema-property-events-retrieve-response-schema-is-whitelabeled-boolean "Direct link to is_whitelabeled") Guide the [Freemius WP SDK](https://github.com/Freemius/wordpress-sdk) when the product should be running in a [white-label](https://freemius.com/help/documentation/users-account-management/license-security/#white_label_mode) mode. **environment**number[](#schema-property-events-retrieve-response-schema-environment-number "Direct link to environment") The environment the entity belongs to. 0 means it belongs to the production environment, 1 means it belongs to the sandbox environment. **Possible values:** \[`1`, `0`] **Example: **`0` **source**number[](#schema-property-events-retrieve-response-schema-source-number "Direct link to source") The source of the migration data. To get support migrating from other platform please see our [documentation](https://freemius.com/help/documentation/migration/). * `0` - Freemius * `1` - Other * `2` - Easy Digital Downloads (EDD) * `3` - WooCommerce (WC) * `4` - Rating Widget * `5` - Gumroad * `6` - CodeCanyon * `7` - ThemeForest * `8` - AppSumo * `9` - SendOwl * `10` - WHMCS * `11` - Lemon Squeezy **Possible values:** \[`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`] **property name\***any[](#schema-property-events-retrieve-response-schema-property-name-any "Direct link to property name*") A map of related objects keyed by their type or ID, such as Payment, User, Install, or License. Bad request. The request could not be understood by the server due to malformed syntax or arguments. application/json **Schema** **path**string[](#schema-property-events-retrieve-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-events-retrieve-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-events-retrieve-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-events-retrieve-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-events-retrieve-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-events-retrieve-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-events-retrieve-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` Unauthorized access error. The request requires [authentication](https://freemius.com/help/api/#bearer-token-authentication) but was not provided or the provided authentication does not satisfy the required permissions. application/json **Schema** **path**string[](#schema-property-events-retrieve-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-events-retrieve-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-events-retrieve-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-events-retrieve-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-events-retrieve-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-events-retrieve-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-events-retrieve-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` The request is missing the specified argument. application/json **Schema** **path**string[](#schema-property-events-retrieve-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-events-retrieve-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-events-retrieve-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-events-retrieve-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-events-retrieve-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-events-retrieve-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-events-retrieve-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` The requested resource was not found. application/json **Schema** **path**string[](#schema-property-events-retrieve-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-events-retrieve-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-events-retrieve-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-events-retrieve-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-events-retrieve-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-events-retrieve-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-events-retrieve-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}`