Recurly SubscriptionActivities API

openapi: 3.2.0
info:
  title: Recurly SubscriptionActivities API
  version: '1.3'
  contact: {}
  description: 'Operations tagged SubscriptionActivities 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: SubscriptionActivities API
paths:
  /api/v1/subscriptionActivities:
    get:
      operationId: listSubscriptionActivities
      summary: List Subscription Activities
      description: Retrieve a list of subscription activities
      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 subscription activities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionActivitiesResultDto'
      security:
      - bearer: []
      tags:
      - SubscriptionActivities API
    servers:
    - url: https://subs.api.recurlycommerce.com
components:
  schemas:
    SubscriptionActivityDto:
      type: object
      properties:
        id:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        subscriptionId:
          type: string
          description: The id of the subscription
        type:
          type: string
          description: The type of the activity
        description:
          type: string
        user:
          type: string
          description: The initiator of the activity
          enum:
          - Store Admin
          - Customer
          - Recurly System
          - Prive System
          - Shopper
          - Bulk Updater
        apiToken:
          description: The API token if the activity was triggered by API
          allOf:
          - $ref: '#/components/schemas/ApiTokenDto'
        eventTimestamp:
          format: date-time
          type: string
        targetEntityType:
          type:
          - string
          - 'null'
          description: The type of the target entity
          enum:
          - SUBSCRIPTION
          - SUBSCRIPTION_LINE
          - ONE_TIME_ADD_ON
          - ORDER
          - BILLING_ATTEMPT
          - SUBSCRIPTION_DISCOUNT_CODE
          - DELIVERY_CONDITION
          - null
        targetEntityId:
          type:
          - string
          - 'null'
          description: The id of the target entity
        oldData:
          type:
          - object
          - 'null'
        newData:
          type:
          - object
          - 'null'
        removeLineData:
          allOf:
          - $ref: '#/components/schemas/CancellationMetaDataDto'
        cancelContractData:
          type:
          - object
          - 'null'
        oldLines:
          type:
          - object
          - 'null'
        newLines:
          type:
          - object
          - 'null'
      required:
      - id
      - createdAt
      - updatedAt
      - subscriptionId
      - type
      - description
      - user
      - apiToken
      - eventTimestamp
      - targetEntityType
      - targetEntityId
      - oldData
      - newData
      - removeLineData
      - cancelContractData
      - oldLines
      - newLines
    ApiTokenDto:
      type: object
      properties:
        id:
          type: string
        tokenName:
          type:
          - string
          - 'null'
      required:
      - id
      - tokenName
    CancellationMetaDataDto:
      type: object
      properties:
        cancelReason:
          type: string
          description: The cancellation reason configured
        cancelReasonComments:
          type: string
          description: The cancellation reason provided by the end user
        cancellationQuestionId:
          type: string
          description: The cancellation question id
        lineId:
          type:
          - string
          - 'null'
          description: The cancellation question id
      required:
      - cancelReason
      - cancelReasonComments
      - cancellationQuestionId
      - lineId
    SubscriptionActivitiesResultDto:
      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
        subscriptionActivities:
          description: Array of subscription activities for the current page
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionActivityDto'
      required:
      - page
      - limit
      - totalItems
      - totalPages
      - subscriptionActivities
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
x-refined-from:
- recurly-commerce-api.json
- recurly-commerce-openapi.yml
x-readme:
  explorer-enabled: false