--- title: "Get Event" method: GET path: "/v1/events/{id}" tags: ["events", "public"] --- # Get Event `GET /v1/events/{id}` Get an event by ID. **Scopes**: `events:read` `events:write` ## Path parameters - `id` string, uuid4, required — The event ID. ## Response `200` Successful Response - union - union - MeterCreditEvent — An event created by Polar when credits are added to a customer meter. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'meter.credited', required — The name of the event. - `metadata` MeterCreditedMetadata, required - `meter_id` string, required - `units` integer, required - `rollover` boolean, required - MeterResetEvent — An event created by Polar when a customer meter is reset. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'meter.reset', required — The name of the event. - `metadata` MeterResetMetadata, required - `meter_id` string, required - BenefitGrantedEvent — An event created by Polar when a benefit is granted to a customer. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'benefit.granted', required — The name of the event. - `metadata` BenefitGrantMetadata, required - `benefit_id` string, required - `benefit_grant_id` string, required - `benefit_type` 'custom' | 'discord' | 'github_repository' | 'downloadables' | 'license_keys' | 'meter_credit' | 'feature_flag' | 'slack_shared_channel', required - `member_id` string - BenefitCycledEvent — An event created by Polar when a benefit is cycled. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'benefit.cycled', required — The name of the event. - `metadata` BenefitGrantMetadata, required - `benefit_id` string, required - `benefit_grant_id` string, required - `benefit_type` 'custom' | 'discord' | 'github_repository' | 'downloadables' | 'license_keys' | 'meter_credit' | 'feature_flag' | 'slack_shared_channel', required - `member_id` string - BenefitUpdatedEvent — An event created by Polar when a benefit is updated. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'benefit.updated', required — The name of the event. - `metadata` BenefitGrantMetadata, required - `benefit_id` string, required - `benefit_grant_id` string, required - `benefit_type` 'custom' | 'discord' | 'github_repository' | 'downloadables' | 'license_keys' | 'meter_credit' | 'feature_flag' | 'slack_shared_channel', required - `member_id` string - BenefitRevokedEvent — An event created by Polar when a benefit is revoked from a customer. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'benefit.revoked', required — The name of the event. - `metadata` BenefitGrantMetadata, required - `benefit_id` string, required - `benefit_grant_id` string, required - `benefit_type` 'custom' | 'discord' | 'github_repository' | 'downloadables' | 'license_keys' | 'meter_credit' | 'feature_flag' | 'slack_shared_channel', required - `member_id` string - SubscriptionCreatedEvent — An event created by Polar when a subscription is created. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.created', required — The name of the event. - `metadata` SubscriptionCreatedMetadata, required - `subscription_id` string, required - `product_id` string, required - `amount` integer, required - `currency` string, required - `recurring_interval` string, required - `recurring_interval_count` integer, required - `started_at` string, required - SubscriptionUpdatedEvent — An event created by Polar when a subscription is updated. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.updated', required — The name of the event. - `metadata` SubscriptionUpdatedMetadata, required - `product_id` string - `proration_behavior` 'invoice' | 'prorate' | 'next_period' | 'reset' - `discount_id` string, nullable - `trial_end` string - `seats` integer - `billing_period_end` string - `subscription_id` string, required - SubscriptionCycledEvent — An event created by Polar when a subscription is cycled. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.cycled', required — The name of the event. - `metadata` SubscriptionCycledMetadata, required - `subscription_id` string, required - `product_id` string - `amount` integer - `currency` string - `recurring_interval` string - `recurring_interval_count` integer - SubscriptionCanceledEvent — An event created by Polar when a subscription is canceled. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.canceled', required — The name of the event. - `metadata` SubscriptionCanceledMetadata, required - `subscription_id` string, required - `product_id` string - `amount` integer, required - `currency` string, required - `recurring_interval` string, required - `recurring_interval_count` integer, required - `customer_cancellation_reason` string - `customer_cancellation_comment` string - `canceled_at` string, required - `ends_at` string - `cancel_at_period_end` boolean - SubscriptionRevokedEvent — An event created by Polar when a subscription is revoked from a customer. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.revoked', required — The name of the event. - `metadata` SubscriptionRevokedMetadata, required - `subscription_id` string, required - `product_id` string - `amount` integer - `currency` string - `recurring_interval` string - `recurring_interval_count` integer - SubscriptionPastDueEvent — An event created by Polar when a subscription becomes past due. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.past_due', required — The name of the event. - `metadata` SubscriptionPastDueMetadata, required - `subscription_id` string, required - `product_id` string - `past_due_at` string, required - `amount` integer - `currency` string - `recurring_interval` string - `recurring_interval_count` integer - SubscriptionReactivatedEvent — An event created by Polar when a past due subscription is recovered. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.reactivated', required — The name of the event. - `metadata` SubscriptionReactivatedMetadata, required - `subscription_id` string, required - `product_id` string - `amount` integer - `currency` string - `recurring_interval` string - `recurring_interval_count` integer - SubscriptionReinstatedEvent — An event created by Polar when a canceled subscription is reinstated. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.reinstated', required — The name of the event. - `metadata` SubscriptionReinstatedMetadata, required - `subscription_id` string, required - `product_id` string - `amount` integer - `currency` string - `recurring_interval` string - `recurring_interval_count` integer - SubscriptionPausedEvent — An event created by Polar when a subscription is paused. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.paused', required — The name of the event. - `metadata` SubscriptionPausedMetadata, required - `subscription_id` string, required - `product_id` string - `amount` integer - `currency` string - `recurring_interval` string - `recurring_interval_count` integer - `paused_at` string, required - `resumes_at` string - SubscriptionResumedEvent — An event created by Polar when a paused subscription is resumed. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.resumed', required — The name of the event. - `metadata` SubscriptionResumedMetadata, required - `subscription_id` string, required - `product_id` string - `amount` integer - `currency` string - `recurring_interval` string - `recurring_interval_count` integer - SubscriptionUncanceledEvent — An event created by Polar when a subscription cancellation is reversed. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.uncanceled', required — The name of the event. - `metadata` SubscriptionUncanceledMetadata, required - `subscription_id` string, required - `product_id` string, required - `amount` integer, required - `currency` string, required - `recurring_interval` string, required - `recurring_interval_count` integer, required - SubscriptionProductUpdatedEvent — An event created by Polar when a subscription changes the product. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.product_updated', required — The name of the event. - `metadata` SubscriptionProductUpdatedMetadata, required - `subscription_id` string, required - `old_product_id` string, required - `new_product_id` string, required - SubscriptionSeatsUpdatedEvent — An event created by Polar when a the seats on a subscription is changed. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.seats_updated', required — The name of the event. - `metadata` SubscriptionSeatsUpdatedMetadata, required - `subscription_id` string, required - `old_seats` integer, required - `new_seats` integer, required - `proration_behavior` string, required - SubscriptionBillingPeriodUpdatedEvent — An event created by Polar when a subscription billing period is updated. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.billing_period_updated', required — The name of the event. - `metadata` SubscriptionBillingPeriodUpdatedMetadata, required - `subscription_id` string, required - `old_period_end` string, required - `new_period_end` string, required - SubscriptionUpdateClearedEvent — An event created by Polar when a pending subscription update is cleared without being applied. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'subscription.update_cleared', required — The name of the event. - `metadata` SubscriptionUpdateClearedMetadata, required - `subscription_id` string, required - OrderPaidEvent — An event created by Polar when an order is paid. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'order.paid', required — The name of the event. - `metadata` OrderPaidMetadata, required - `order_id` string, required - `product_id` string - `billing_type` string - `amount` integer, required - `currency` string - `net_amount` integer - `tax_amount` integer - `applied_balance_amount` integer - `discount_amount` integer - `discount_id` string - `platform_fee` integer - `subscription_id` string - `recurring_interval` string - `recurring_interval_count` integer - OrderRefundedEvent — An event created by Polar when an order is refunded. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'order.refunded', required — The name of the event. - `metadata` OrderRefundedMetadata, required - `order_id` string, required - `refunded_amount` integer, required - `currency` string, required - OrderVoidedEvent — An event created by Polar when an order is voided. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'order.voided', required — The name of the event. - `metadata` OrderVoidedMetadata, required - `order_id` string, required - `amount` integer, required - `currency` string, required - OrderUnvoidedEvent — An event created by Polar when an order is unvoided. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'order.unvoided', required — The name of the event. - `metadata` OrderUnvoidedMetadata, required - `order_id` string, required - `amount` integer, required - `currency` string, required - CheckoutCreatedEvent — An event created by Polar when a checkout is created. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'checkout.created', required — The name of the event. - `metadata` CheckoutCreatedMetadata, required - `checkout_id` string, required - `checkout_status` string, required - `product_id` string - CustomerCreatedEvent — An event created by Polar when a customer is created. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'customer.created', required — The name of the event. - `metadata` CustomerCreatedMetadata, required - `customer_id` string, required - `customer_email` string, nullable, required - `customer_name` string, nullable, required - `customer_external_id` string, nullable, required - CustomerUpdatedEvent — An event created by Polar when a customer is updated. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'customer.updated', required — The name of the event. - `metadata` CustomerUpdatedMetadata, required - `customer_id` string, required - `customer_email` string, nullable, required - `customer_name` string, nullable, required - `customer_external_id` string, nullable, required - `updated_fields` CustomerUpdatedFields, required - `name` string, nullable - `billing_name` string, nullable - `email` string, nullable - `billing_address` AddressDict - `line1` string - `line2` string - `postal_code` string - `city` string - `state` string - `country` string, required - `tax_id` string, nullable - `metadata` object, nullable - CustomerDeletedEvent — An event created by Polar when a customer is deleted. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'customer.deleted', required — The name of the event. - `metadata` CustomerDeletedMetadata, required - `customer_id` string, required - `customer_email` string, nullable, required - `customer_name` string, nullable, required - `customer_external_id` string, nullable, required - BalanceOrderEvent — An event created by Polar when an order is paid. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'balance.order', required — The name of the event. - `metadata` BalanceOrderMetadata, required - `transaction_id` string, required - `order_id` string, required - `product_id` string - `subscription_id` string - `amount` integer, required - `net_amount` integer - `currency` string, required - `presentment_amount` integer, required - `presentment_currency` string, required - `tax_amount` integer, required - `tax_state` string, nullable - `tax_country` string, nullable - `fee` integer, required - `exchange_rate` number - BalanceCreditOrderEvent — An event created by Polar when an order is paid via customer balance. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'balance.credit_order', required — The name of the event. - `metadata` BalanceCreditOrderMetadata, required - `order_id` string, required - `product_id` string - `subscription_id` string - `amount` integer, required - `currency` string, required - `tax_amount` integer, required - `tax_state` string, nullable - `tax_country` string, nullable - `fee` integer, required - `exchange_rate` number - BalanceRefundEvent — An event created by Polar when an order is refunded. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'balance.refund', required — The name of the event. - `metadata` BalanceRefundMetadata, required - `transaction_id` string, required - `refund_id` string, required - `order_id` string - `order_created_at` string - `product_id` string - `subscription_id` string - `amount` integer, required - `currency` string, required - `presentment_amount` integer, required - `presentment_currency` string, required - `refundable_amount` integer - `tax_amount` integer, required - `tax_state` string, nullable - `tax_country` string, nullable - `fee` integer, required - `exchange_rate` number - BalanceRefundReversalEvent — An event created by Polar when a refund is reverted. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'balance.refund_reversal', required — The name of the event. - `metadata` BalanceRefundMetadata, required - `transaction_id` string, required - `refund_id` string, required - `order_id` string - `order_created_at` string - `product_id` string - `subscription_id` string - `amount` integer, required - `currency` string, required - `presentment_amount` integer, required - `presentment_currency` string, required - `refundable_amount` integer - `tax_amount` integer, required - `tax_state` string, nullable - `tax_country` string, nullable - `fee` integer, required - `exchange_rate` number - BalanceDisputeEvent — An event created by Polar when an order is disputed. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'balance.dispute', required — The name of the event. - `metadata` BalanceDisputeMetadata, required - `transaction_id` string, required - `dispute_id` string, required - `order_id` string - `order_created_at` string - `product_id` string - `subscription_id` string - `amount` integer, required - `currency` string, required - `presentment_amount` integer, required - `presentment_currency` string, required - `tax_amount` integer, required - `tax_state` string, nullable - `tax_country` string, nullable - `fee` integer, required - `exchange_rate` number - BalanceDisputeReversalEvent — An event created by Polar when a dispute is won and funds are reinstated. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `source` 'system', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `name` 'balance.dispute_reversal', required — The name of the event. - `metadata` BalanceDisputeMetadata, required - `transaction_id` string, required - `dispute_id` string, required - `order_id` string - `order_created_at` string - `product_id` string - `subscription_id` string - `amount` integer, required - `currency` string, required - `presentment_amount` integer, required - `presentment_currency` string, required - `tax_amount` integer, required - `tax_state` string, nullable - `tax_country` string, nullable - `fee` integer, required - `exchange_rate` number - UserEvent — An event you created through the ingestion API. - `id` string, uuid4, required — The ID of the object. - `timestamp` string, date-time, required — The timestamp of the event. - `organization_id` string, uuid4, required — The ID of the organization owning the event. - `customer_id` string, uuid4, nullable, required — ID of the customer in your Polar organization associated with the event. - `customer` Customer, required — unresolved $ref - `external_customer_id` string, nullable, required — ID of the customer in your system associated with the event. - `member_id` string, uuid4, nullable — ID of the member within the customer's organization who performed the action inside B2B. - `external_member_id` string, nullable — ID of the member in your system within the customer's organization who performed the action inside B2B. - `child_count` integer — Number of direct child events linked to this event. - `parent_id` string, uuid4, nullable — The ID of the parent event. - `label` string, required — Human readable label of the event type. - `name` string, required — The name of the event. - `source` 'user', required — The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. - `metadata` EventMetadataOutput, required - `_cost` CostMetadataOutput - `amount` string, required — The amount in cents. - `currency` string, required — The currency. Currently, only `usd` is supported. - `_llm` LLMMetadata - `vendor` string, required — The vendor of the event. - `model` string, required — The model used for the event. - `prompt` string, nullable — The LLM prompt used for the event. - `response` string, nullable — The LLM response used for the event. - `input_tokens` integer, required — The number of LLM input tokens used for the event. - `cached_input_tokens` integer — The number of LLM cached tokens that were used for the event. - `output_tokens` integer, required — The number of LLM output tokens used for the event. - `total_tokens` integer, required — The total number of LLM tokens used for the event. ## Other responses - `404` — Event not found. - `422` — Validation Error --- [API](https://skmtc.net/polar/apis/polar-api.md) · [All operations](https://skmtc.net/polar/apis/polar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polar/polar-api/revisions/f9688fd328d6/schema)