> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Events

> ### Intent

Reads the available events as a pageable collection without changing them.

### When to call it

Call this when an interface, sync, or support workflow needs to inspect events. Use the filters and paging controls shown below to limit the result.

### Access boundary

Authorize the request with a token that carries `events:read` or `events:write`.

### Successful result

A successful request returns `200`. The response schema below defines the body your integration receives.

export const RubaSocials = () => {
  if (typeof document === "undefined") {
    return null;
  }
  const inject = () => {
    const footer = document.getElementById("footer");
    if (!footer || document.getElementById("ruba-socials")) {
      return false;
    }
    const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
    const lineColor = isDark ? "#383838" : "#e8e8ed";
    const iconColor = isDark ? "#8e8e93" : "#86868b";
    const markColor = isDark ? "#ffffff" : "#08080c";
    const hoverColor = "#0071e3";
    const div = document.createElement("div");
    div.id = "ruba-socials";
    div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
    const logo = `<a href="https://getruba.com" style="display:inline-flex;height:24px;align-items:center;gap:8px;text-decoration:none;color:${markColor};line-height:1;"><svg width="24" height="24" viewBox="0 0 120 120" aria-hidden="true" style="display:block;flex:none;"><g transform="translate(2.5 0)"><path d="M19 25h59L65.43 47H19a4 4 0 0 1-4-4V29a4 4 0 0 1 4-4Z" fill="${markColor}"/><path d="M19 73h31.57L38 95H19a4 4 0 0 1-4-4V77a4 4 0 0 1 4-4Z" fill="${markColor}"/><path d="M85 25h25L70 95H45Z" fill="#007AFF"/></g></svg><span style="display:inline-flex;height:24px;align-items:center;font-weight:600;font-size:15px;color:${markColor};letter-spacing:-0.01em;line-height:1;">Ruba</span></a>`;
    const spacer = `<div style="flex:1"></div>`;
    const ig = `<a href="https://instagram.com/getruba" target="_blank" rel="noopener" aria-label="Instagram" style="display:flex;align-items:center;color:${iconColor};transition:color 0.15s ease;" onmouseover="this.style.color='${hoverColor}'" onmouseout="this.style.color='${iconColor}'"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round"><rect x="2" y="2" width="20" height="20" rx="5" ry="5"/><path d="M16 11.37A4 4 0 1 1 12.63 8 4 4 0 0 1 16 11.37z"/><line x1="17.5" y1="6.5" x2="17.51" y2="6.5"/></svg></a>`;
    const li = `<a href="https://linkedin.com/company/getruba" target="_blank" rel="noopener" aria-label="LinkedIn" style="display:flex;align-items:center;color:${iconColor};transition:color 0.15s ease;" onmouseover="this.style.color='${hoverColor}'" onmouseout="this.style.color='${iconColor}'"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round"><path d="M16 8a6 6 0 0 1 6 6v7h-4v-7a2 2 0 0 0-2-2 2 2 0 0 0-2 2v7h-4v-7a6 6 0 0 1 6-6z"/><rect x="2" y="9" width="4" height="12"/><circle cx="4" cy="4" r="2"/></svg></a>`;
    const x = `<a href="https://x.com/getruba" target="_blank" rel="noopener" aria-label="X" style="display:flex;align-items:center;color:${iconColor};transition:color 0.15s ease;" onmouseover="this.style.color='${hoverColor}'" onmouseout="this.style.color='${iconColor}'"><svg width="18" height="18" viewBox="0 0 24 24" fill="currentColor"><path d="M18.244 2.25h3.308l-7.227 8.26 8.502 11.24H16.17l-5.214-6.817L4.99 21.75H1.68l7.73-8.835L1.254 2.25H8.08l4.713 6.231zm-1.161 17.52h1.833L7.084 4.126H5.117z"/></svg></a>`;
    const github = `<a href="https://github.com/rubadot" target="_blank" rel="noopener" aria-label="GitHub" style="display:flex;align-items:center;color:${iconColor};transition:color 0.15s ease;" onmouseover="this.style.color='${hoverColor}'" onmouseout="this.style.color='${iconColor}'"><svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor"><path d="M12 .7a11.5 11.5 0 0 0-3.64 22.4c.58.1.79-.25.79-.56v-2.24c-3.22.7-3.9-1.37-3.9-1.37-.53-1.34-1.29-1.7-1.29-1.7-1.05-.72.08-.71.08-.71 1.16.08 1.78 1.2 1.78 1.2 1.04 1.77 2.72 1.26 3.38.96.1-.75.4-1.26.74-1.55-2.57-.3-5.27-1.29-5.27-5.69 0-1.26.45-2.29 1.19-3.09-.12-.29-.52-1.47.11-3.05 0 0 .97-.31 3.16 1.18A10.96 10.96 0 0 1 12 6.09c.98 0 1.94.13 2.86.39 2.2-1.49 3.16-1.18 3.16-1.18.63 1.58.23 2.76.11 3.05.74.8 1.19 1.83 1.19 3.09 0 4.42-2.7 5.39-5.28 5.68.42.36.79 1.06.79 2.14v3.28c0 .31.21.67.8.56A11.5 11.5 0 0 0 12 .7Z"/></svg></a>`;
    div.innerHTML = logo + spacer + ig + li + x + github;
    footer.appendChild(div);
    return true;
  };
  if (!document.documentElement.dataset.rubaSocialsObserver) {
    document.documentElement.dataset.rubaSocialsObserver = "true";
    const observer = new MutationObserver(() => {
      if (!document.getElementById("ruba-socials")) {
        inject();
      }
    });
    observer.observe(document.body, {
      childList: true,
      subtree: true
    });
  }
  setTimeout(() => {
    if (!inject()) {
      const interval = setInterval(() => {
        if (inject()) {
          clearInterval(interval);
        }
      }, 500);
      setTimeout(() => clearInterval(interval), 10000);
    }
  }, 300);
  return null;
};

<link rel="stylesheet" href="/style.css" />

<RubaSocials />


## OpenAPI

````yaml get /v1/events/
openapi: 3.1.0
info:
  title: Ruba API
  summary: Ruba HTTP and Webhooks API
  description: '**Details:** Read the docs at https://docs.getruba.com/api-reference.'
  version: 2026-04
servers:
  - url: https://api.getruba.com
    description: '**Details:** Production environment.'
    x-speakeasy-server-id: production
  - url: https://sandbox-api.getruba.com
    description: '**Details:** Sandbox environment.'
    x-speakeasy-server-id: sandbox
security: []
tags:
  - name: public
    description: >-
      **Details:** Endpoints shown and documented in the Ruba API documentation
      and available in our SDKs.
  - name: private
    description: >-
      **Details:** Endpoints that should appear in the schema only in
      development to generate our internal JS SDK.
paths:
  /v1/events/:
    get:
      tags:
        - events
        - public
      summary: List Events
      description: >-
        ### Intent


        Reads the available events as a pageable collection without changing
        them.


        ### When to call it


        Call this when an interface, sync, or support workflow needs to inspect
        events. Use the filters and paging controls shown below to limit the
        result.


        ### Access boundary


        Authorize the request with a token that carries `events:read` or
        `events:write`.


        ### Successful result


        A successful request returns `200`. The response schema below defines
        the body your integration receives.
      operationId: events:list
      parameters:
        - name: filter
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              **Parameter:** Filter events following filter clauses. JSON string
              following the same schema a meter filter clause.
            title: Filter
          description: >-
            **Parameter:** Filter events following filter clauses. JSON string
            following the same schema a meter filter clause.
        - name: start_timestamp
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: '**Parameter:** Filter events after this timestamp.'
            title: Start Timestamp
          description: '**Parameter:** Filter events after this timestamp.'
        - name: end_timestamp
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: '**Parameter:** Filter events before this timestamp.'
            title: End Timestamp
          description: '**Parameter:** Filter events before this timestamp.'
        - name: organization_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid4
                description: Identifier of the organization.
                examples:
                  - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
                x-ruba-selector-widget:
                  displayProperty: name
                  resourceName: Organization
                  resourceRoot: /v1/organizations
              - type: array
                items:
                  type: string
                  format: uuid4
                  description: Identifier of the organization.
                  examples:
                    - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
                  x-ruba-selector-widget:
                    displayProperty: name
                    resourceName: Organization
                    resourceRoot: /v1/organizations
              - type: 'null'
            title: OrganizationID Filter
            description: Return only records matching organization ID.
          description: Return only records matching organization ID.
        - name: customer_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid4
                description: Identifier of the customer.
              - type: array
                items:
                  type: string
                  format: uuid4
                  description: Identifier of the customer.
              - type: 'null'
            title: CustomerID Filter
            description: Return only records matching customer ID.
          description: Return only records matching customer ID.
        - name: external_customer_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - items:
                  type: string
                type: array
              - type: 'null'
            title: ExternalCustomerID Filter
            description: Return only records matching external customer ID.
          description: Return only records matching external customer ID.
        - name: meter_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid4
                description: Identifier of the meter.
              - type: 'null'
            title: MeterID Filter
            description: Return only records matching a meter filter clause.
          description: Return only records matching a meter filter clause.
        - name: name
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - items:
                  type: string
                type: array
              - type: 'null'
            title: Name Filter
            description: Return only records matching event name.
          description: Return only records matching event name.
        - name: source
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/EventSource'
              - type: array
                items:
                  $ref: '#/components/schemas/EventSource'
              - type: 'null'
            title: Source Filter
            description: Return only records matching event source.
          description: Return only records matching event source.
        - name: query
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Query
            description: '**Parameter:** Query to filter events.'
          description: '**Parameter:** Query to filter events.'
        - name: parent_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid4
                description: Identifier of the event.
              - type: 'null'
            description: >-
              **Parameter:** When combined with depth, use this event as the
              anchor instead of root events.
            title: Parent Id
          description: >-
            **Parameter:** When combined with depth, use this event as the
            anchor instead of root events.
        - name: depth
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 5
                minimum: 0
              - type: 'null'
            description: >-
              **Parameter:** Fetch descendants up to this depth. When set:
              0=root events only, 1=roots+children, etc. Max 5. When not set,
              returns all events.
            title: Depth
          description: >-
            **Parameter:** Fetch descendants up to this depth. When set: 0=root
            events only, 1=roots+children, etc. Max 5. When not set, returns all
            events.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            exclusiveMinimum: 0
            description: Results page to return. The first page is used by default.
            default: 1
            title: Page
          description: Results page to return. The first page is used by default.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            exclusiveMinimum: 0
            description: Records returned per page. Defaults to 10 and accepts up to 100.
            default: 10
            title: Limit
          description: Records returned per page. Defaults to 10 and accepts up to 100.
        - name: sorting
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  $ref: '#/components/schemas/EventSortProperty'
              - type: 'null'
            description: >-
              Sort rules applied from left to right. Prefix any rule with `-` to
              reverse it into descending order.
            default:
              - '-timestamp'
            title: Sorting
          description: >-
            Sort rules applied from left to right. Prefix any rule with `-` to
            reverse it into descending order.
        - name: metadata
          in: query
          required: false
          style: deepObject
          schema:
            $ref: '#/components/schemas/MetadataQuery'
          description: >-
            Return only records matching metadata key-value pairs. It uses the
            `deepObject` style, e.g. `?metadata[key]=value`.
      responses:
        '200':
          description: Request completed successfully
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ListResource_Event_'
                  - $ref: >-
                      #/components/schemas/ListResourceWithCursorPagination_Event_
                title: Response Events:List
        '422':
          description: Request validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - oidc:
            - events:read
            - events:write
        - pat:
            - events:read
            - events:write
        - oat:
            - events:read
            - events:write
components:
  schemas:
    EventSource:
      type: string
      enum:
        - system
        - user
      title: EventSource
    EventSortProperty:
      type: string
      enum:
        - timestamp
        - '-timestamp'
      title: EventSortProperty
    MetadataQuery:
      anyOf:
        - type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: integer
              - type: boolean
              - items:
                  type: string
                type: array
              - type: array
                items:
                  type: integer
              - type: array
                items:
                  type: boolean
        - type: 'null'
      title: MetadataQuery
    ListResource_Event_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Event'
          type: array
          title: Items
        pagination:
          $ref: '#/components/schemas/Pagination'
      type: object
      required:
        - items
        - pagination
      title: ListResource[Event]
    ListResourceWithCursorPagination_Event_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Event'
          type: array
          title: Items
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
        - items
        - pagination
      title: ListResourceWithCursorPagination[Event]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Event:
      oneOf:
        - $ref: '#/components/schemas/SystemEvent'
        - $ref: '#/components/schemas/UserEvent'
      discriminator:
        propertyName: source
        mapping:
          system:
            $ref: '#/components/schemas/SystemEvent'
          user:
            $ref: '#/components/schemas/UserEvent'
    Pagination:
      properties:
        total_count:
          type: integer
          title: Total Count
        max_page:
          type: integer
          title: Max Page
      type: object
      required:
        - total_count
        - max_page
      title: Pagination
    CursorPagination:
      properties:
        has_next_page:
          type: boolean
          title: Has Next Page
      type: object
      required:
        - has_next_page
      title: CursorPagination
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SystemEvent:
      oneOf:
        - $ref: '#/components/schemas/MeterCreditEvent'
        - $ref: '#/components/schemas/MeterResetEvent'
        - $ref: '#/components/schemas/BenefitGrantedEvent'
        - $ref: '#/components/schemas/BenefitCycledEvent'
        - $ref: '#/components/schemas/BenefitUpdatedEvent'
        - $ref: '#/components/schemas/BenefitRevokedEvent'
        - $ref: '#/components/schemas/SubscriptionCreatedEvent'
        - $ref: '#/components/schemas/SubscriptionUpdatedEvent'
        - $ref: '#/components/schemas/SubscriptionCycledEvent'
        - $ref: '#/components/schemas/SubscriptionCanceledEvent'
        - $ref: '#/components/schemas/SubscriptionRevokedEvent'
        - $ref: '#/components/schemas/SubscriptionPastDueEvent'
        - $ref: '#/components/schemas/SubscriptionReactivatedEvent'
        - $ref: '#/components/schemas/SubscriptionUncanceledEvent'
        - $ref: '#/components/schemas/SubscriptionProductUpdatedEvent'
        - $ref: '#/components/schemas/SubscriptionSeatsUpdatedEvent'
        - $ref: '#/components/schemas/SubscriptionBillingPeriodUpdatedEvent'
        - $ref: '#/components/schemas/SubscriptionUpdateClearedEvent'
        - $ref: '#/components/schemas/OrderPaidEvent'
        - $ref: '#/components/schemas/OrderRefundedEvent'
        - $ref: '#/components/schemas/OrderVoidedEvent'
        - $ref: '#/components/schemas/CheckoutCreatedEvent'
        - $ref: '#/components/schemas/CustomerCreatedEvent'
        - $ref: '#/components/schemas/CustomerUpdatedEvent'
        - $ref: '#/components/schemas/CustomerDeletedEvent'
        - $ref: '#/components/schemas/BalanceOrderEvent'
        - $ref: '#/components/schemas/BalanceCreditOrderEvent'
        - $ref: '#/components/schemas/BalanceRefundEvent'
        - $ref: '#/components/schemas/BalanceRefundReversalEvent'
        - $ref: '#/components/schemas/BalanceDisputeEvent'
        - $ref: '#/components/schemas/BalanceDisputeReversalEvent'
      discriminator:
        propertyName: name
        mapping:
          balance.credit_order:
            $ref: '#/components/schemas/BalanceCreditOrderEvent'
          balance.dispute:
            $ref: '#/components/schemas/BalanceDisputeEvent'
          balance.dispute_reversal:
            $ref: '#/components/schemas/BalanceDisputeReversalEvent'
          balance.order:
            $ref: '#/components/schemas/BalanceOrderEvent'
          balance.refund:
            $ref: '#/components/schemas/BalanceRefundEvent'
          balance.refund_reversal:
            $ref: '#/components/schemas/BalanceRefundReversalEvent'
          benefit.cycled:
            $ref: '#/components/schemas/BenefitCycledEvent'
          benefit.granted:
            $ref: '#/components/schemas/BenefitGrantedEvent'
          benefit.revoked:
            $ref: '#/components/schemas/BenefitRevokedEvent'
          benefit.updated:
            $ref: '#/components/schemas/BenefitUpdatedEvent'
          checkout.created:
            $ref: '#/components/schemas/CheckoutCreatedEvent'
          customer.created:
            $ref: '#/components/schemas/CustomerCreatedEvent'
          customer.deleted:
            $ref: '#/components/schemas/CustomerDeletedEvent'
          customer.updated:
            $ref: '#/components/schemas/CustomerUpdatedEvent'
          meter.credited:
            $ref: '#/components/schemas/MeterCreditEvent'
          meter.reset:
            $ref: '#/components/schemas/MeterResetEvent'
          order.paid:
            $ref: '#/components/schemas/OrderPaidEvent'
          order.refunded:
            $ref: '#/components/schemas/OrderRefundedEvent'
          order.voided:
            $ref: '#/components/schemas/OrderVoidedEvent'
          subscription.billing_period_updated:
            $ref: '#/components/schemas/SubscriptionBillingPeriodUpdatedEvent'
          subscription.canceled:
            $ref: '#/components/schemas/SubscriptionCanceledEvent'
          subscription.created:
            $ref: '#/components/schemas/SubscriptionCreatedEvent'
          subscription.cycled:
            $ref: '#/components/schemas/SubscriptionCycledEvent'
          subscription.past_due:
            $ref: '#/components/schemas/SubscriptionPastDueEvent'
          subscription.product_updated:
            $ref: '#/components/schemas/SubscriptionProductUpdatedEvent'
          subscription.reactivated:
            $ref: '#/components/schemas/SubscriptionReactivatedEvent'
          subscription.revoked:
            $ref: '#/components/schemas/SubscriptionRevokedEvent'
          subscription.seats_updated:
            $ref: '#/components/schemas/SubscriptionSeatsUpdatedEvent'
          subscription.uncanceled:
            $ref: '#/components/schemas/SubscriptionUncanceledEvent'
          subscription.update_cleared:
            $ref: '#/components/schemas/SubscriptionUpdateClearedEvent'
          subscription.updated:
            $ref: '#/components/schemas/SubscriptionUpdatedEvent'
    UserEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        name:
          type: string
          title: Name
          description: Name assigned to the event.
        source:
          type: string
          const: user
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        metadata:
          $ref: '#/components/schemas/EventMetadataOutput'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - name
        - source
        - metadata
      title: UserEvent
      description: Object representing event you created through the ingestion API.
    MeterCreditEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: meter.credited
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/MeterCreditedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: MeterCreditEvent
      description: >-
        Object representing event created by Ruba when credits are added to a
        customer meter.
    MeterResetEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: meter.reset
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/MeterResetMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: MeterResetEvent
      description: >-
        Object representing event created by Ruba when a customer meter is
        reset.
    BenefitGrantedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: benefit.granted
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BenefitGrantMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BenefitGrantedEvent
      description: >-
        Object representing event created by Ruba when a benefit is granted to a
        customer.
    BenefitCycledEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: benefit.cycled
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BenefitGrantMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BenefitCycledEvent
      description: Object representing event created by Ruba when a benefit is cycled.
    BenefitUpdatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: benefit.updated
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BenefitGrantMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BenefitUpdatedEvent
      description: Object representing event created by Ruba when a benefit is updated.
    BenefitRevokedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: benefit.revoked
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BenefitGrantMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BenefitRevokedEvent
      description: >-
        Object representing event created by Ruba when a benefit is revoked from
        a customer.
    SubscriptionCreatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.created
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionCreatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionCreatedEvent
      description: >-
        Object representing event created by Ruba when a subscription is
        created.
    SubscriptionUpdatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.updated
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionUpdatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionUpdatedEvent
      description: >-
        Object representing event created by Ruba when a subscription is
        updated.
    SubscriptionCycledEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.cycled
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionCycledMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionCycledEvent
      description: Object representing event created by Ruba when a subscription is cycled.
    SubscriptionCanceledEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.canceled
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionCanceledMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionCanceledEvent
      description: >-
        Object representing event created by Ruba when a subscription is
        canceled.
    SubscriptionRevokedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.revoked
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionRevokedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionRevokedEvent
      description: >-
        Object representing event created by Ruba when a subscription is revoked
        from a customer.
    SubscriptionPastDueEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.past_due
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionPastDueMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionPastDueEvent
      description: >-
        Object representing event created by Ruba when a subscription becomes
        past due.
    SubscriptionReactivatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.reactivated
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionReactivatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionReactivatedEvent
      description: >-
        Object representing event created by Ruba when a past due subscription
        is recovered.
    SubscriptionUncanceledEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.uncanceled
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionUncanceledMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionUncanceledEvent
      description: >-
        Object representing event created by Ruba when a subscription
        cancellation is reversed.
    SubscriptionProductUpdatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.product_updated
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionProductUpdatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionProductUpdatedEvent
      description: >-
        Object representing event created by Ruba when a subscription changes
        the product.
    SubscriptionSeatsUpdatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.seats_updated
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionSeatsUpdatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionSeatsUpdatedEvent
      description: >-
        Object representing event created by Ruba when a the seats on a
        subscription is changed.
    SubscriptionBillingPeriodUpdatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.billing_period_updated
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionBillingPeriodUpdatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionBillingPeriodUpdatedEvent
      description: >-
        Object representing event created by Ruba when a subscription billing
        period is updated.
    SubscriptionUpdateClearedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: subscription.update_cleared
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/SubscriptionUpdateClearedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: SubscriptionUpdateClearedEvent
      description: >-
        Object representing event created by Ruba when a pending subscription
        update is cleared without being applied.
    OrderPaidEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: order.paid
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/OrderPaidMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: OrderPaidEvent
      description: Object representing event created by Ruba when an order is paid.
    OrderRefundedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: order.refunded
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/OrderRefundedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: OrderRefundedEvent
      description: Object representing event created by Ruba when an order is refunded.
    OrderVoidedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: order.voided
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/OrderVoidedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: OrderVoidedEvent
      description: Object representing event created by Ruba when an order is voided.
    CheckoutCreatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: checkout.created
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/CheckoutCreatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: CheckoutCreatedEvent
      description: Object representing event created by Ruba when a checkout is created.
    CustomerCreatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: customer.created
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/CustomerCreatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: CustomerCreatedEvent
      description: Object representing event created by Ruba when a customer is created.
    CustomerUpdatedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: customer.updated
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/CustomerUpdatedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: CustomerUpdatedEvent
      description: Object representing event created by Ruba when a customer is updated.
    CustomerDeletedEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: customer.deleted
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/CustomerDeletedMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: CustomerDeletedEvent
      description: Object representing event created by Ruba when a customer is deleted.
    BalanceOrderEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: balance.order
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BalanceOrderMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BalanceOrderEvent
      description: Object representing event created by Ruba when an order is paid.
    BalanceCreditOrderEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: balance.credit_order
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BalanceCreditOrderMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BalanceCreditOrderEvent
      description: >-
        Object representing event created by Ruba when an order is paid via
        customer balance.
    BalanceRefundEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: balance.refund
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BalanceRefundMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BalanceRefundEvent
      description: Object representing event created by Ruba when an order is refunded.
    BalanceRefundReversalEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: balance.refund_reversal
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BalanceRefundMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BalanceRefundReversalEvent
      description: Object representing event created by Ruba when a refund is reverted.
    BalanceDisputeEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: balance.dispute
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BalanceDisputeMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BalanceDisputeEvent
      description: Object representing event created by Ruba when an order is disputed.
    BalanceDisputeReversalEvent:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: The stable identifier for this record.
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Time at which the event occurred.
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the event.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
          x-ruba-selector-widget:
            displayProperty: name
            resourceName: Organization
            resourceRoot: /v1/organizations
        customer_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Customer Id
          description: >-
            Identifier of the customer in your Ruba organization associated with
            the event.
        customer:
          anyOf:
            - $ref: '#/components/schemas/Customer'
            - type: 'null'
          description: Customer record connected to this event.
        external_customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Customer Id
          description: Your system identifier for the customer connected to this event.
        member_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Member Id
          description: >-
            Identifier of the member within the customer's organization who
            performed the action inside B2B.
        external_member_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Member Id
          description: >-
            Identifier of the member in your system within the customer's
            organization who performed the action inside B2B.
        child_count:
          type: integer
          title: Child Count
          description: Count of direct child events linked to this event.
          default: 0
        parent_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Parent Id
          description: Unique identifier for the parent event.
        label:
          type: string
          title: Label
          description: Readable label describing the event type.
        source:
          type: string
          const: system
          title: Source
          description: >-
            **Source:** Source of the event. `system` events are created by
            Ruba. `user` events are the one you create through our ingestion
            API.
        name:
          type: string
          const: balance.dispute_reversal
          title: Name
          description: Name assigned to the event.
        metadata:
          $ref: '#/components/schemas/BalanceDisputeMetadata'
      type: object
      required:
        - id
        - timestamp
        - organization_id
        - customer_id
        - customer
        - external_customer_id
        - label
        - source
        - name
        - metadata
      title: BalanceDisputeReversalEvent
      description: >-
        Object representing event created by Ruba when a dispute is won and
        funds are reinstated.
    Customer:
      oneOf:
        - $ref: '#/components/schemas/CustomerIndividual'
        - $ref: '#/components/schemas/CustomerTeam'
      discriminator:
        propertyName: type
        mapping:
          individual:
            $ref: '#/components/schemas/CustomerIndividual'
          team:
            $ref: '#/components/schemas/CustomerTeam'
    EventMetadataOutput:
      properties:
        _cost:
          $ref: '#/components/schemas/CostMetadata-Output'
        _llm:
          $ref: '#/components/schemas/LLMMetadata'
      additionalProperties:
        anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
      type: object
      title: EventMetadataOutput
    MeterCreditedMetadata:
      properties:
        meter_id:
          type: string
          title: Meter Id
        units:
          type: integer
          title: Units
        rollover:
          type: boolean
          title: Rollover
      type: object
      required:
        - meter_id
        - units
        - rollover
      title: MeterCreditedMetadata
    MeterResetMetadata:
      properties:
        meter_id:
          type: string
          title: Meter Id
      type: object
      required:
        - meter_id
      title: MeterResetMetadata
    BenefitGrantMetadata:
      properties:
        benefit_id:
          type: string
          title: Benefit Id
        benefit_grant_id:
          type: string
          title: Benefit Grant Id
        benefit_type:
          $ref: '#/components/schemas/BenefitType'
        member_id:
          type: string
          title: Member Id
      type: object
      required:
        - benefit_id
        - benefit_grant_id
        - benefit_type
      title: BenefitGrantMetadata
    SubscriptionCreatedMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        product_id:
          type: string
          title: Product Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        recurring_interval:
          type: string
          title: Recurring Interval
        recurring_interval_count:
          type: integer
          title: Recurring Interval Count
        started_at:
          type: string
          title: Started At
      type: object
      required:
        - subscription_id
        - product_id
        - amount
        - currency
        - recurring_interval
        - recurring_interval_count
        - started_at
      title: SubscriptionCreatedMetadata
    SubscriptionUpdatedMetadata:
      properties:
        product_id:
          type: string
          title: Product Id
        proration_behavior:
          $ref: '#/components/schemas/SubscriptionProrationBehavior'
        discount_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Discount Id
        trial_end:
          type: string
          title: Trial End
        seats:
          type: integer
          title: Seats
        billing_period_end:
          type: string
          title: Billing Period End
        subscription_id:
          type: string
          title: Subscription Id
      type: object
      required:
        - subscription_id
      title: SubscriptionUpdatedMetadata
    SubscriptionCycledMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        product_id:
          type: string
          title: Product Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        recurring_interval:
          type: string
          title: Recurring Interval
        recurring_interval_count:
          type: integer
          title: Recurring Interval Count
      type: object
      required:
        - subscription_id
      title: SubscriptionCycledMetadata
    SubscriptionCanceledMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        product_id:
          type: string
          title: Product Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        recurring_interval:
          type: string
          title: Recurring Interval
        recurring_interval_count:
          type: integer
          title: Recurring Interval Count
        customer_cancellation_reason:
          type: string
          title: Customer Cancellation Reason
        customer_cancellation_comment:
          type: string
          title: Customer Cancellation Comment
        canceled_at:
          type: string
          title: Canceled At
        ends_at:
          type: string
          title: Ends At
        cancel_at_period_end:
          type: boolean
          title: Cancel At Period End
      type: object
      required:
        - subscription_id
        - amount
        - currency
        - recurring_interval
        - recurring_interval_count
        - canceled_at
      title: SubscriptionCanceledMetadata
    SubscriptionRevokedMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        product_id:
          type: string
          title: Product Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        recurring_interval:
          type: string
          title: Recurring Interval
        recurring_interval_count:
          type: integer
          title: Recurring Interval Count
      type: object
      required:
        - subscription_id
      title: SubscriptionRevokedMetadata
    SubscriptionPastDueMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        product_id:
          type: string
          title: Product Id
        past_due_at:
          type: string
          title: Past Due At
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        recurring_interval:
          type: string
          title: Recurring Interval
        recurring_interval_count:
          type: integer
          title: Recurring Interval Count
      type: object
      required:
        - subscription_id
        - past_due_at
      title: SubscriptionPastDueMetadata
    SubscriptionReactivatedMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        product_id:
          type: string
          title: Product Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        recurring_interval:
          type: string
          title: Recurring Interval
        recurring_interval_count:
          type: integer
          title: Recurring Interval Count
      type: object
      required:
        - subscription_id
      title: SubscriptionReactivatedMetadata
    SubscriptionUncanceledMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        product_id:
          type: string
          title: Product Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        recurring_interval:
          type: string
          title: Recurring Interval
        recurring_interval_count:
          type: integer
          title: Recurring Interval Count
      type: object
      required:
        - subscription_id
        - product_id
        - amount
        - currency
        - recurring_interval
        - recurring_interval_count
      title: SubscriptionUncanceledMetadata
    SubscriptionProductUpdatedMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        old_product_id:
          type: string
          title: Old Product Id
        new_product_id:
          type: string
          title: New Product Id
      type: object
      required:
        - subscription_id
        - old_product_id
        - new_product_id
      title: SubscriptionProductUpdatedMetadata
    SubscriptionSeatsUpdatedMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        old_seats:
          type: integer
          title: Old Seats
        new_seats:
          type: integer
          title: New Seats
        proration_behavior:
          type: string
          title: Proration Behavior
      type: object
      required:
        - subscription_id
        - old_seats
        - new_seats
        - proration_behavior
      title: SubscriptionSeatsUpdatedMetadata
    SubscriptionBillingPeriodUpdatedMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
        old_period_end:
          type: string
          title: Old Period End
        new_period_end:
          type: string
          title: New Period End
      type: object
      required:
        - subscription_id
        - old_period_end
        - new_period_end
      title: SubscriptionBillingPeriodUpdatedMetadata
    SubscriptionUpdateClearedMetadata:
      properties:
        subscription_id:
          type: string
          title: Subscription Id
      type: object
      required:
        - subscription_id
      title: SubscriptionUpdateClearedMetadata
    OrderPaidMetadata:
      properties:
        order_id:
          type: string
          title: Order Id
        product_id:
          type: string
          title: Product Id
        billing_type:
          type: string
          title: Billing Type
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        net_amount:
          type: integer
          title: Net Amount
        tax_amount:
          type: integer
          title: Tax Amount
        applied_balance_amount:
          type: integer
          title: Applied Balance Amount
        discount_amount:
          type: integer
          title: Discount Amount
        discount_id:
          type: string
          title: Discount Id
        platform_fee:
          type: integer
          title: Platform Fee
        subscription_id:
          type: string
          title: Subscription Id
        recurring_interval:
          type: string
          title: Recurring Interval
        recurring_interval_count:
          type: integer
          title: Recurring Interval Count
      type: object
      required:
        - order_id
        - amount
      title: OrderPaidMetadata
    OrderRefundedMetadata:
      properties:
        order_id:
          type: string
          title: Order Id
        refunded_amount:
          type: integer
          title: Refunded Amount
        currency:
          type: string
          title: Currency
      type: object
      required:
        - order_id
        - refunded_amount
        - currency
      title: OrderRefundedMetadata
    OrderVoidedMetadata:
      properties:
        order_id:
          type: string
          title: Order Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
      type: object
      required:
        - order_id
        - amount
        - currency
      title: OrderVoidedMetadata
    CheckoutCreatedMetadata:
      properties:
        checkout_id:
          type: string
          title: Checkout Id
        checkout_status:
          type: string
          title: Checkout Status
        product_id:
          type: string
          title: Product Id
      type: object
      required:
        - checkout_id
        - checkout_status
      title: CheckoutCreatedMetadata
    CustomerCreatedMetadata:
      properties:
        customer_id:
          type: string
          title: Customer Id
        customer_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Email
        customer_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Name
        customer_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer External Id
      type: object
      required:
        - customer_id
        - customer_email
        - customer_name
        - customer_external_id
      title: CustomerCreatedMetadata
    CustomerUpdatedMetadata:
      properties:
        customer_id:
          type: string
          title: Customer Id
        customer_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Email
        customer_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Name
        customer_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer External Id
        updated_fields:
          $ref: '#/components/schemas/CustomerUpdatedFields'
      type: object
      required:
        - customer_id
        - customer_email
        - customer_name
        - customer_external_id
        - updated_fields
      title: CustomerUpdatedMetadata
    CustomerDeletedMetadata:
      properties:
        customer_id:
          type: string
          title: Customer Id
        customer_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Email
        customer_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Name
        customer_external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer External Id
      type: object
      required:
        - customer_id
        - customer_email
        - customer_name
        - customer_external_id
      title: CustomerDeletedMetadata
    BalanceOrderMetadata:
      properties:
        transaction_id:
          type: string
          title: Transaction Id
        order_id:
          type: string
          title: Order Id
        product_id:
          type: string
          title: Product Id
        subscription_id:
          type: string
          title: Subscription Id
        amount:
          type: integer
          title: Amount
        net_amount:
          type: integer
          title: Net Amount
        currency:
          type: string
          title: Currency
        presentment_amount:
          type: integer
          title: Presentment Amount
        presentment_currency:
          type: string
          title: Presentment Currency
        tax_amount:
          type: integer
          title: Tax Amount
        tax_state:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax State
        tax_country:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax Country
        fee:
          type: integer
          title: Fee
        exchange_rate:
          type: number
          title: Exchange Rate
      type: object
      required:
        - transaction_id
        - order_id
        - amount
        - currency
        - presentment_amount
        - presentment_currency
        - tax_amount
        - fee
      title: BalanceOrderMetadata
    BalanceCreditOrderMetadata:
      properties:
        order_id:
          type: string
          title: Order Id
        product_id:
          type: string
          title: Product Id
        subscription_id:
          type: string
          title: Subscription Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        tax_amount:
          type: integer
          title: Tax Amount
        tax_state:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax State
        tax_country:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax Country
        fee:
          type: integer
          title: Fee
        exchange_rate:
          type: number
          title: Exchange Rate
      type: object
      required:
        - order_id
        - amount
        - currency
        - tax_amount
        - fee
      title: BalanceCreditOrderMetadata
    BalanceRefundMetadata:
      properties:
        transaction_id:
          type: string
          title: Transaction Id
        refund_id:
          type: string
          title: Refund Id
        order_id:
          type: string
          title: Order Id
        order_created_at:
          type: string
          title: Order Created At
        product_id:
          type: string
          title: Product Id
        subscription_id:
          type: string
          title: Subscription Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        presentment_amount:
          type: integer
          title: Presentment Amount
        presentment_currency:
          type: string
          title: Presentment Currency
        refundable_amount:
          type: integer
          title: Refundable Amount
        tax_amount:
          type: integer
          title: Tax Amount
        tax_state:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax State
        tax_country:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax Country
        fee:
          type: integer
          title: Fee
        exchange_rate:
          type: number
          title: Exchange Rate
      type: object
      required:
        - transaction_id
        - refund_id
        - amount
        - currency
        - presentment_amount
        - presentment_currency
        - tax_amount
        - fee
      title: BalanceRefundMetadata
    BalanceDisputeMetadata:
      properties:
        transaction_id:
          type: string
          title: Transaction Id
        dispute_id:
          type: string
          title: Dispute Id
        order_id:
          type: string
          title: Order Id
        order_created_at:
          type: string
          title: Order Created At
        product_id:
          type: string
          title: Product Id
        subscription_id:
          type: string
          title: Subscription Id
        amount:
          type: integer
          title: Amount
        currency:
          type: string
          title: Currency
        presentment_amount:
          type: integer
          title: Presentment Amount
        presentment_currency:
          type: string
          title: Presentment Currency
        tax_amount:
          type: integer
          title: Tax Amount
        tax_state:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax State
        tax_country:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax Country
        fee:
          type: integer
          title: Fee
        exchange_rate:
          type: number
          title: Exchange Rate
      type: object
      required:
        - transaction_id
        - dispute_id
        - amount
        - currency
        - presentment_amount
        - presentment_currency
        - tax_amount
        - fee
      title: BalanceDisputeMetadata
    CustomerIndividual:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: Unique identifier for the customer.
          examples:
            - 992fae2a-2a17-4b7a-8d9e-e287cf90131b
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The time Ruba created this record.
        modified_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Modified At
          description: The time this record last changed.
        metadata:
          $ref: '#/components/schemas/MetadataOutputType'
        external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Id
          description: >-
            Unique identifier for the customer in your system. This must be
            unique within the organization. Once set, it can't be updated.
          examples:
            - usr_1337
        email:
          type: string
          title: Email
          description: >-
            **Email:** Email address of the customer. This must be unique within
            the organization.
          examples:
            - customer@example.com
        email_verified:
          type: boolean
          title: Email Verified
          description: >-
            Indicates whether the customer email address is verified. The
            address is automatically verified when the customer accesses the
            customer portal using their email address.
          examples:
            - true
        type:
          type: string
          const: individual
          title: Type
          description: '**Type:** Type of customer.'
          examples:
            - individual
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Name assigned to the customer.
          examples:
            - John Doe
        billing_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Billing Name
          description: >-
            **Billing Name:** Name that should appear on the customer's
            invoices. Falls back to the customer name when not explicitly set.
          examples:
            - John Doe
        billing_address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
        tax_id:
          anyOf:
            - prefixItems:
                - type: string
                - $ref: '#/components/schemas/TaxIDFormat'
              type: array
              maxItems: 2
              minItems: 2
              examples:
                - - '911144442'
                  - us_ein
                - - FR61954506077
                  - eu_vat
            - type: 'null'
          title: Tax Id
        locale:
          anyOf:
            - type: string
            - type: 'null'
          title: Locale
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the customer.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
        default_payment_method_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Default Payment Method Id
          description: >-
            Unique identifier for the customer's default payment method, if any.
            Use the payment methods endpoint to retrieve its details.
        deleted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deleted At
          description: '**Deleted At:** Timestamp for when the customer was soft deleted.'
        avatar_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Avatar Url
          examples:
            - https://www.gravatar.com/avatar/xxx?d=404
      type: object
      required:
        - id
        - created_at
        - modified_at
        - metadata
        - email
        - email_verified
        - type
        - name
        - billing_name
        - billing_address
        - tax_id
        - organization_id
        - deleted_at
        - avatar_url
      title: CustomerIndividual
      description: Object representing customer in an organization.
    CustomerTeam:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
          description: Unique identifier for the customer.
          examples:
            - 992fae2a-2a17-4b7a-8d9e-e287cf90131b
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The time Ruba created this record.
        modified_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Modified At
          description: The time this record last changed.
        metadata:
          $ref: '#/components/schemas/MetadataOutputType'
        external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Id
          description: >-
            Unique identifier for the customer in your system. This must be
            unique within the organization. Once set, it can't be updated.
          examples:
            - usr_1337
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: >-
            **Email:** Email address of the customer. This must be unique within
            the organization.
          examples:
            - customer@example.com
        email_verified:
          type: boolean
          title: Email Verified
          description: >-
            Indicates whether the customer email address is verified. The
            address is automatically verified when the customer accesses the
            customer portal using their email address.
          examples:
            - true
        type:
          type: string
          const: team
          title: Type
          description: >-
            **Type:** Type of customer. Team customers can have multiple
            members.
          examples:
            - team
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Name assigned to the customer.
          examples:
            - John Doe
        billing_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Billing Name
          description: >-
            **Billing Name:** Name that should appear on the customer's
            invoices. Falls back to the customer name when not explicitly set.
          examples:
            - John Doe
        billing_address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
        tax_id:
          anyOf:
            - prefixItems:
                - type: string
                - $ref: '#/components/schemas/TaxIDFormat'
              type: array
              maxItems: 2
              minItems: 2
              examples:
                - - '911144442'
                  - us_ein
                - - FR61954506077
                  - eu_vat
            - type: 'null'
          title: Tax Id
        locale:
          anyOf:
            - type: string
            - type: 'null'
          title: Locale
        organization_id:
          type: string
          format: uuid4
          title: Organization Id
          description: Unique identifier for the organization owning the customer.
          examples:
            - 1dbfc517-0bbf-4301-9ba8-555ca42b9737
        default_payment_method_id:
          anyOf:
            - type: string
              format: uuid4
            - type: 'null'
          title: Default Payment Method Id
          description: >-
            Unique identifier for the customer's default payment method, if any.
            Use the payment methods endpoint to retrieve its details.
        deleted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deleted At
          description: '**Deleted At:** Timestamp for when the customer was soft deleted.'
        avatar_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Avatar Url
          examples:
            - https://www.gravatar.com/avatar/xxx?d=404
      type: object
      required:
        - id
        - created_at
        - modified_at
        - metadata
        - email_verified
        - type
        - name
        - billing_name
        - billing_address
        - tax_id
        - organization_id
        - deleted_at
        - avatar_url
      title: CustomerTeam
      description: Object representing team customer in an organization.
    CostMetadata-Output:
      properties:
        amount:
          type: string
          pattern: >-
            ^(?!^[-+.]*$)[+-]?0*(?:\d{0,5}|(?=[\d.]{1,18}0*$)\d{0,5}\.\d{0,12}0*$)
          title: Amount
          description: '**Amount:** Amount in cents.'
        currency:
          type: string
          pattern: usd
          title: Currency
          description: '**Currency:** Currency. Currently, only `usd` is supported.'
      type: object
      required:
        - amount
        - currency
      title: CostMetadata
    LLMMetadata:
      properties:
        vendor:
          type: string
          title: Vendor
          description: '**Vendor:** Vendor of the event.'
        model:
          type: string
          title: Model
          description: '**Model:** Model used for the event.'
        prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: Prompt
          description: '**Prompt:** LLM prompt used for the event.'
        response:
          anyOf:
            - type: string
            - type: 'null'
          title: Response
          description: LLM response used for the event.
        input_tokens:
          type: integer
          title: Input Tokens
          description: Count of LLM input tokens used for the event.
        cached_input_tokens:
          type: integer
          title: Cached Input Tokens
          description: Count of LLM cached tokens that were used for the event.
        output_tokens:
          type: integer
          title: Output Tokens
          description: Count of LLM output tokens used for the event.
        total_tokens:
          type: integer
          title: Total Tokens
          description: '**Total Tokens:** Total number of LLM tokens used for the event.'
      type: object
      required:
        - vendor
        - model
        - input_tokens
        - output_tokens
        - total_tokens
      title: LLMMetadata
    BenefitType:
      type: string
      enum:
        - custom
        - discord
        - github_repository
        - downloadables
        - license_keys
        - meter_credit
        - feature_flag
        - slack_shared_channel
      title: BenefitType
    SubscriptionProrationBehavior:
      type: string
      enum:
        - invoice
        - prorate
        - next_period
        - reset
      title: SubscriptionProrationBehavior
    CustomerUpdatedFields:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        billing_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Billing Name
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        billing_address:
          anyOf:
            - $ref: '#/components/schemas/AddressDict'
            - type: 'null'
        tax_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax Id
        metadata:
          anyOf:
            - additionalProperties:
                anyOf:
                  - type: string
                  - type: integer
                  - type: boolean
              type: object
            - type: 'null'
          title: Metadata
      type: object
      title: CustomerUpdatedFields
    MetadataOutputType:
      additionalProperties:
        anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
      type: object
    Address:
      properties:
        line1:
          anyOf:
            - type: string
            - type: 'null'
          title: Line1
        line2:
          anyOf:
            - type: string
            - type: 'null'
          title: Line2
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Postal Code
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        state:
          anyOf:
            - type: string
            - type: 'null'
          title: State
        country:
          type: string
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
          title: CountryAlpha2
          examples:
            - US
            - SE
            - FR
          x-speakeasy-enums:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
      type: object
      required:
        - country
      title: Address
    AddressDict:
      properties:
        line1:
          type: string
          title: Line1
        line2:
          type: string
          title: Line2
        postal_code:
          type: string
          title: Postal Code
        city:
          type: string
          title: City
        state:
          type: string
          title: State
        country:
          type: string
          title: Country
      type: object
      required:
        - country
      title: AddressDict
  securitySchemes:
    oidc:
      type: openIdConnect
      openIdConnectUrl: /.well-known/openid-configuration
    pat:
      type: http
      description: >-
        **Authentication:** You can generate a **Personal Access Token** from
        your [settings](https://getruba.com/settings).
      scheme: bearer
    oat:
      type: http
      description: >-
        **Authentication:** You can generate an **Organization Access Token**
        from your organization's settings.
      scheme: bearer

````