Recurly OrderLineItems API

openapi: 3.2.0
info:
  title: Recurly OrderLineItems API
  version: '1.3'
  contact: {}
  description: 'Operations tagged OrderLineItems API across 2 of this provider''s published API definitions: recurly-commerce-api.json, recurly-commerce-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://subs.api.recurlycommerce.com
tags:
- name: OrderLineItems API
paths:
  /api/v1/orderLineItems:
    get:
      operationId: listOrderLineItems
      summary: List Order Line Items
      description: Retrieve a list of order line items
      parameters:
      - name: page
        required: true
        in: query
        description: Page number
        schema:
          default: 1
          type: number
      - name: limit
        required: true
        in: query
        description: Items per page. Limit must be between 1 and 250.
        schema:
          default: 10
          type: number
      - name: sort
        required: false
        in: query
        description: Sort order. If not set, default is createdAt.
        schema:
          type: string
      - name: desc
        required: false
        in: query
        description: Sort direction. If not set, default is ASC.
        schema:
          type: boolean
      - name: minCreatedAt
        required: false
        in: query
        description: The min date of createdAt
        schema:
          format: date-time
          default: '2023-01-01T00:00:00.000Z'
          type: string
      - name: maxCreatedAt
        required: false
        in: query
        description: The max date of createdAt
        schema:
          format: date-time
          default: '2023-01-01T00:00:00.000Z'
          type: string
      - name: minUpdatedAt
        required: false
        in: query
        description: The min date of updatedAt
        schema:
          format: date-time
          default: '2023-01-01T00:00:00.000Z'
          type: string
      - name: maxUpdatedAt
        required: false
        in: query
        description: The min date of updatedAt
        schema:
          format: date-time
          default: '2023-01-01T00:00:00.000Z'
          type: string
      - name: includeDeleted
        required: false
        in: query
        description: If true, include deleted lines
        schema:
          default: false
          type: boolean
      - name: subscriptionId
        required: false
        in: query
        description: The subscription ID
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved order line items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderLineItemsResultDto'
      security:
      - bearer: []
      tags:
      - OrderLineItems API
    servers:
    - url: https://subs.api.recurlycommerce.com
components:
  schemas:
    VariantDto:
      type: object
      properties:
        id:
          type: string
        externalId:
          type: string
          description: The shopify variant ID
        status:
          type: string
          enum:
          - ACTIVE
          - DELETED
        currentPrice:
          type: number
        variantTitle:
          type: string
        sku:
          type:
          - string
          - 'null'
        requiresShipping:
          type: boolean
        product:
          allOf:
          - $ref: '#/components/schemas/ProductForVariantDto'
        subscriptionOffer:
          $ref: '#/components/schemas/SubscriptionOfferDto'
      required:
      - id
      - externalId
      - status
      - currentPrice
      - variantTitle
      - sku
      - requiresShipping
    SubscriptionOfferDto:
      type: object
      properties:
        id:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        externalId:
          type: string
          description: The shopify selling plan group ID
        type:
          type: string
          enum:
          - ONETIME_AND_SUBSCRIPTION
          - ONE_TIME_AND_PREPAID_SUBSCRIPTION
          - SUBSCRIPTION_ONLY
          - PREPAID_SUBSCRIPTION_ONLY
          - ONETIME_AND_SUBSCRIPTION_AND_PREPAID
          - SUBSCRIPTION_AND_PREPAID
          - MEMBERSHIP
        status:
          type: string
          enum:
          - ACTIVE
          - ARCHIVED
          - DRAFT
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        subscriptionOfferOptions:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionOfferOptionDto'
        cancellationFlowId:
          type:
          - string
          - 'null'
          description: The ID of the associated cancellation flow, if any
        trialDurationValue:
          type:
          - number
          - 'null'
        trialDurationUnit:
          type:
          - string
          - 'null'
          enum:
          - DAYS
          - WEEKS
          - MONTHS
          - YEARS
          - null
      required:
      - id
      - createdAt
      - updatedAt
      - externalId
      - type
      - status
      - name
      - description
      - subscriptionOfferOptions
      - trialDurationValue
      - trialDurationUnit
    OrderLineItemDto:
      type: object
      properties:
        id:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        externalId:
          type: string
          description: The shopify order line item ID
        orderId:
          type: string
        subscriptionId:
          type: string
        quantity:
          type: number
        priceTotal:
          type: number
        priceTotalDiscounted:
          type: number
        priceTotalTaxWithDiscounts:
          type: number
        discountAllocationTotalAmount:
          type: number
        variant:
          $ref: '#/components/schemas/VariantDto'
        productTitle:
          type:
          - string
          - 'null'
        variantTitle:
          type:
          - string
          - 'null'
        variantSku:
          type:
          - string
          - 'null'
        isAddOnOneTime:
          type: boolean
      required:
      - id
      - createdAt
      - updatedAt
      - externalId
      - orderId
      - subscriptionId
      - quantity
      - priceTotal
      - priceTotalDiscounted
      - priceTotalTaxWithDiscounts
      - discountAllocationTotalAmount
      - variant
      - productTitle
      - variantTitle
      - variantSku
      - isAddOnOneTime
    SubscriptionOfferOptionDto:
      type: object
      properties:
        id:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        externalId:
          type: string
          description: The shopify selling plan ID
        type:
          type:
          - string
          - 'null'
          enum:
          - ONETIME_AND_SUBSCRIPTION
          - ONE_TIME_AND_PREPAID_SUBSCRIPTION
          - SUBSCRIPTION_ONLY
          - PREPAID_SUBSCRIPTION_ONLY
          - ONETIME_AND_SUBSCRIPTION_AND_PREPAID
          - SUBSCRIPTION_AND_PREPAID
          - MEMBERSHIP
          - null
        name:
          type: string
        deliveryCadenceCount:
          type: number
        deliveryCadenceUnit:
          type: string
          enum:
          - HOUR
          - DAY
          - MONTH
          - WEEK
          - YEAR
        billingCadenceCount:
          type: number
        billingCadenceUnit:
          type: string
          enum:
          - HOUR
          - DAY
          - MONTH
          - WEEK
          - YEAR
        discount:
          type: number
        discountModifier:
          type: string
          enum:
          - PERCENTAGE
          - AMOUNT
          - FIXED_AMOUNT
        archived:
          type: boolean
      required:
      - id
      - createdAt
      - updatedAt
      - externalId
      - type
      - name
      - deliveryCadenceCount
      - deliveryCadenceUnit
      - billingCadenceCount
      - billingCadenceUnit
      - discount
      - discountModifier
      - archived
    OrderLineItemsResultDto:
      type: object
      properties:
        page:
          type: number
          description: Current page number
        limit:
          type: number
          description: Number of items per page
        totalItems:
          type: number
          description: Total number of items
        totalPages:
          type: number
          description: Total number of pages
        orderLineItems:
          description: Array of order line items for the current page
          type: array
          items:
            $ref: '#/components/schemas/OrderLineItemDto'
      required:
      - page
      - limit
      - totalItems
      - totalPages
      - orderLineItems
    ProductForVariantDto:
      type: object
      properties:
        id:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        externalId:
          type: string
          description: The shopify product ID
        imageUrl:
          type:
          - string
          - 'null'
        productTitle:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
      required:
      - id
      - createdAt
      - updatedAt
      - externalId
      - imageUrl
      - productTitle
      - description
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
x-refined-from:
- recurly-commerce-api.json
- recurly-commerce-openapi.yml
x-readme:
  explorer-enabled: false