action rebilly_get_subscription_cancellation_collection {
  label: "Retrieve a list of cancellations"
  description: "Retrieve a list of cancellations for all subscriptions."
  provider: rebilly
  method: GET
  path: "/subscription-cancellations"
  encoding: json
  output: {
    type: "array"
    items: {
      type: "object"
      required: ["subscriptionId", "churnTime"]
      properties: {
        _links: {
          type: "array"
          description: "The links related to resource."
          items: {
            type: "object"
            required: ["rel"]
            properties: {
              rel: {
                type: "string"
                description: "The link type."
                enum: ["self"]
              }
            }
          }
        }
        appliedInvoiceId: {
          description: "The identifier of the invoice where the cancellation fees or credits are applied."
          type: "object"
        }
        canceledBy: {
          type: "string"
          description: "Who did the cancellation."
          enum: ["merchant", "customer"]
        }
        canceledTime: {
          type: "string"
          format: "date-time"
          description: "The cancellation time (when the status is confirmed which is by default unless specified \"draft\")."
        }
        churnTime: {
          type: "string"
          format: "date-time"
          description: "The time when the subscription will be deactivated."
        }
        createdTime: {
          description: "The time of resource creation (when it is posted)."
          type: "object"
        }
        description: {
          type: "string"
          description: "Cancel reason description in free form."
        }
        id: {
          description: "Cancellation identifier."
          type: "object"
        }
        lineItemSubtotal: {
          type: "number"
          description: "Subtotal of the line items which will be added after the subscription's cancellation."
        }
        lineItems: {
          description: "Items to be added to the new invoice. Proration item is generated and added automatically."
          type: "object"
        }
        prorated: {
          type: "boolean"
          description: "Defines if the customer gets a pro-rata credit for the time remaining between `churnTime` and\nsubscription's next renewal time.\n"
        }
        proratedInvoiceId: {
          description: "Identifier of the invoice on which the cancellation proration is calculated."
          type: "object"
        }
        reason: {
          type: "string"
          description: "Cancellation reason."
          enum: ["did-not-use", "did-not-want", "missing-features", "bugs-or-problems", "do-not-remember", "risk-warning", "contract-expired", "too-expensive", "other", "billing-failure"]
        }
        status: {
          type: "string"
          description: "\"draft\" defines that the cancellation isn't applied on an invoice and subscription but\ncan be inspected to see the charge.\n\"confirmed\" will set a subscription to be canceled when the `churnTime` is reached.\n\"completed\" is a read-only status which is set by the system when the churnTime is reached.\nThe cancellation may not be changed or deleted when the status is \"completed\".\n"
          enum: ["draft", "confirmed", "completed", "revoked"]
        }
        subscriptionId: {
          description: "Identifier of the canceled subscription order."
          type: "object"
        }
      }
    }
  }
}