openapi: 3.2.0
info:
  title: 701x API V1 Service Subscription API
  description: 701x API
  version: v1
tags:
- name: ServiceSubscription
paths:
  /ServiceSubscription/ServiceSubscriptionsByFilter:
    get:
      tags:
      - ServiceSubscription
      parameters:
      - name: CompanyId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get service subscription service subscriptions by filter
      x-summary-source: derived
      operationId: getServiceSubscriptionServiceSubscriptionsByFilter
      x-operation-id-source: derived
  /ServiceSubscription/ServiceSubscriptionLineItemsByFilter:
    get:
      tags:
      - ServiceSubscription
      parameters:
      - name: CompanyId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: SubscriptionId
        in: query
        schema:
          type:
          - string
          - 'null'
      - name: DeviceId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get service subscription service subscription line items by filter
      x-summary-source: derived
      operationId: getServiceSubscriptionServiceSubscriptionLineItemsByFilter
      x-operation-id-source: derived
  /ServiceSubscription/Cancel/{id}:
    post:
      tags:
      - ServiceSubscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type:
          - string
          - 'null'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Service_Subscription'
            application/json:
              schema:
                $ref: '#/components/schemas/Service_Subscription'
            text/json:
              schema:
                $ref: '#/components/schemas/Service_Subscription'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Create service subscription cancel by id
      x-summary-source: derived
      operationId: postServiceSubscriptionCancelById
      x-operation-id-source: derived
  /ServiceSubscription/Resume/{id}:
    post:
      tags:
      - ServiceSubscription
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type:
          - string
          - 'null'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Service_Subscription'
            application/json:
              schema:
                $ref: '#/components/schemas/Service_Subscription'
            text/json:
              schema:
                $ref: '#/components/schemas/Service_Subscription'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Create service subscription resume by id
      x-summary-source: derived
      operationId: postServiceSubscriptionResumeById
      x-operation-id-source: derived
  /ServiceSubscription/CancelSubscriptionLineItems:
    post:
      tags:
      - ServiceSubscription
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Sub_Line_Item_Cancel_Body'
          application/json:
            schema:
              $ref: '#/components/schemas/Sub_Line_Item_Cancel_Body'
          text/json:
            schema:
              $ref: '#/components/schemas/Sub_Line_Item_Cancel_Body'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Sub_Line_Item_Cancel_Body'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Create service subscription cancel subscription line items
      x-summary-source: derived
      operationId: postServiceSubscriptionCancelSubscriptionLineItems
      x-operation-id-source: derived
  /ServiceSubscription/ResumeSubscriptionLineItems:
    post:
      tags:
      - ServiceSubscription
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Sub_Line_Item_Cancel_Body'
          application/json:
            schema:
              $ref: '#/components/schemas/Sub_Line_Item_Cancel_Body'
          text/json:
            schema:
              $ref: '#/components/schemas/Sub_Line_Item_Cancel_Body'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Sub_Line_Item_Cancel_Body'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Line_Item'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Create service subscription resume subscription line items
      x-summary-source: derived
      operationId: postServiceSubscriptionResumeSubscriptionLineItems
      x-operation-id-source: derived
  /ServiceSubscription/GenerateRenewalBillReceipt:
    get:
      tags:
      - ServiceSubscription
      parameters:
      - name: id
        in: query
        schema:
          type:
          - string
          - 'null'
      - name: companyId
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get service subscription generate renewal bill receipt
      x-summary-source: derived
      operationId: getServiceSubscriptionGenerateRenewalBillReceipt
      x-operation-id-source: derived
  /ServiceSubscription/BillingEvents:
    get:
      tags:
      - ServiceSubscription
      parameters:
      - name: companyId
        in: query
        schema:
          type: string
          format: uuid
      - name: subscriptionId
        in: query
        schema:
          type:
          - string
          - 'null'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Billing_Event'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Billing_Event'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service_Subscription_Billing_Event'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get service subscription billing events
      x-summary-source: derived
      operationId: getServiceSubscriptionBillingEvents
      x-operation-id-source: derived
  /ServiceSubscription/BillingEventReceipt:
    get:
      tags:
      - ServiceSubscription
      parameters:
      - name: id
        in: query
        schema:
          type:
          - string
          - 'null'
      - name: companyId
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get service subscription billing event receipt
      x-summary-source: derived
      operationId: getServiceSubscriptionBillingEventReceipt
      x-operation-id-source: derived
  /ServiceSubscription/BillingEvent:
    get:
      tags:
      - ServiceSubscription
      parameters:
      - name: companyId
        in: query
        schema:
          type: string
          format: uuid
      - name: id
        in: query
        schema:
          type:
          - string
          - 'null'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Service_Subscription_Billing_Event'
            application/json:
              schema:
                $ref: '#/components/schemas/Service_Subscription_Billing_Event'
            text/json:
              schema:
                $ref: '#/components/schemas/Service_Subscription_Billing_Event'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get service subscription billing event
      x-summary-source: derived
      operationId: getServiceSubscriptionBillingEvent
      x-operation-id-source: derived
components:
  schemas:
    Sub_Line_Item_Cancel_Body:
      type: object
      properties:
        lineItemIds:
          type:
          - array
          - 'null'
          items:
            type: string
        companyId:
          type: string
          format: uuid
      additionalProperties: false
    Billing_Event_Ship_Info:
      type: object
      properties:
        shipAddress1:
          type:
          - string
          - 'null'
        shipAddress2:
          type:
          - string
          - 'null'
        shipCity:
          type:
          - string
          - 'null'
        shipState:
          type:
          - string
          - 'null'
        shipCountry:
          type:
          - string
          - 'null'
        shipZip:
          type:
          - string
          - 'null'
      additionalProperties: false
    Service_Subscription_Billing_Event:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        subscriptionId:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        paidDate:
          type:
          - string
          - 'null'
          format: date-time
        eventDate:
          type: string
          format: date-time
        data:
          $ref: '#/components/schemas/Billing_Event_Data'
      additionalProperties: false
    Billing_Event_Line_Item:
      type: object
      properties:
        deviceId:
          type: string
          format: uuid
        priceAmount:
          type: number
          format: float
      additionalProperties: false
    Service_Subscription:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        renewalDate:
          type: string
          format: date-time
        currencyCode:
          type:
          - string
          - 'null'
        customerStripeId:
          type:
          - string
          - 'null'
        companyId:
          type: string
          format: uuid
        cost:
          type:
          - number
          - 'null'
          format: double
        renewalType:
          type:
          - string
          - 'null'
        shipCity:
          type:
          - string
          - 'null'
        shipState:
          type:
          - string
          - 'null'
        shipZip:
          type:
          - string
          - 'null'
        shipCountry:
          type:
          - string
          - 'null'
        shipAddress1:
          type:
          - string
          - 'null'
        shipAddress2:
          type:
          - string
          - 'null'
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        canceledDate:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    Service_Subscription_Line_Item:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        subscriptionId:
          type:
          - string
          - 'null'
        subscriptionTierId:
          type:
          - string
          - 'null'
        currentPriceId:
          type:
          - string
          - 'null'
        nextPriceId:
          type:
          - string
          - 'null'
        deviceId:
          type: string
          format: uuid
        price:
          type: number
          format: float
        tierName:
          type:
          - string
          - 'null'
        inWarranty:
          type:
          - boolean
          - 'null'
        reactivatePending:
          type:
          - boolean
          - 'null'
        decommissionSuccess:
          type:
          - boolean
          - 'null'
        transferredAt:
          type:
          - string
          - 'null'
          format: date-time
        activationDate:
          type: string
          format: date-time
        cancellationDate:
          type:
          - string
          - 'null'
          format: date-time
        decommissionDate:
          type:
          - string
          - 'null'
          format: date-time
        lastRenewedDate:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    Billing_Event_Data:
      type: object
      properties:
        total:
          type:
          - number
          - 'null'
          format: float
        tax:
          type:
          - number
          - 'null'
          format: float
        shipInfo:
          $ref: '#/components/schemas/Billing_Event_Ship_Info'
        lineItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Billing_Event_Line_Item'
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.701x.com/connect/authorize
          tokenUrl: https://login.701x.com/connect/token
          scopes:
            api1: Demo API - full access