SubscriptionRenewed
v1.0.0

An event raised when a subscription is renewed.
SubscriptionRenewed Schema (yml)
openapi: 3.0.0
info:
  version: "1.0.0"
  title: SubscriptionRenewed
paths: {}
components:
  schemas:
    SubscriptionRenewed:
      type: object
      required:
        - metadata
        - data
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Data:
      type: object
      required:
        - subscriptionId
        - addonSubscription
        - email
        - phoneNumber
        - startingFrom
        - kitchen
        - balance
        - currency
        - planType
        - dietType
        - foodType
        - subscriptionFrequency
        - renewType
        - amount
        - discount
        - amountPaid
        - vat
        - country
        - brand
        - deliveryDays
        - tier
        - subscriptionCost
      properties:
        subscriptionId:
          type: string
        addonSubscription:
          type: array
          items:
            type: object
            required:
              - startDate
              - endDate
              - category
              - cost
            properties:
              cost:
                type: number
              startDate:
                type: string
              endDate:
                type: string
              category:
                type: string
        email:
          type: string
        brand:
          type: string
        phoneNumber:
          type: string
        startingFrom:
          type: string
        kitchen:
          type: string
        balance:
          type: number
        currency:
          type: string
        deliveryDays:
          type: array
          items:
            type: number
        planType:
          type: string
        dietType:
          type: string
        foodType:
          type: array
          items:
            type: string
        subscriptionFrequency:
          type: string
          enum:
            - weekly
            - monthly
        renewType:
          type: string
          enum:
            - AUTO_RENEW
            - PRE_RENEW
            - USER_RENEW
        amount:
          type: number
        subscriptionCost:
          type: number
        discount:
          type: number
        amountPaid:
          type: number
        vat:
          type: number
        paymentMethod:
          type: string
        paymentCardPrefix:
          type: string
        couponCode:
          type: string
        country:
          type: string
        tier:
          type: string
    Metadata:
      type: object
      required:
        - serviceFunction
        - version
      properties:
        serviceFunction:
          type: string
        version:
          type: string
Edit this pageLast updated on 2024/4/2