SubscriptionPaused
v1.0.0

An event fired whenever a subscription is paused

Properties

subscriptionId* :

Unique identifier of the subscriber

name* :

The name of the subscriber

phoneNumber* :

The phone number of the subscriber

email* :

The email of the subscriber

pausedAt* :

the date of pausing

kitchen* :

The kitchen of the subscriber

planType* :

Subscription plan type

dietType* :

Subscription plan type

tier* :

Subscription tier (personalized, standard)

unpauseAt* :

The date of unpausing if exists (optional)

flowchart LR l-api-service[api-service]:::producer-->SubscriptionPaused[SubscriptionPaused]:::event l-dashboard-api-service[dashboard-api-service]:::producer-->SubscriptionPaused[SubscriptionPaused]:::event l-cron-service[cron-service]:::producer-->SubscriptionPaused[SubscriptionPaused]:::event classDef event stroke:#cb9059,stroke-width: 4px; classDef producer stroke:#75d7b6,stroke-width: 2px; classDef consumer stroke:#818cf8,stroke-width: 2px; SubscriptionPaused[SubscriptionPaused]:::event-->r-unknown[unknown]:::consumer click l-api-service href "/services/api-service" "Go to api-service" _self click l-dashboard-api-service href "/services/dashboard-api-service" "Go to dashboard-api-service" _self click l-cron-service href "/services/cron-service" "Go to cron-service" _self click r-unknown href "/services/unknown" "Go to unknown" _self click SubscriptionPaused href "/events/SubscriptionPaused" "Go to SubscriptionPaused" _self
SubscriptionPaused Schema (yml)
openapi: 3.0.0
info:
  version: "1.0.0"
  title: SubscriptionPaused
paths: {}
components:
  schemas:
    SubscriptionPaused:
      type: object
      required:
        - metadata
        - data
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Data:
      type: object
      required:
        - subscriptionId
        - name
        - email
        - phoneNumber
        - pausedAt
        - kitchen
        - planType
        - dietType
        - tier
      properties:
        subscriptionId:
          type: string
        email:
          type: string
        phoneNumber:
          type: string
        pausedAt:
          type: string
        kitchen:
          type: string
        planType:
          type: string
        dietType:
          type: string
        tier:
          type: string
          enum:
            - personalized
            - standard
        unpauseAt:
          type: string
    Metadata:
      type: object
      required:
        - serviceFunction
        - version
      properties:
        serviceFunction:
          type: string
        version:
          type: string
Edit this pageLast updated on 2024/4/2