{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Cycles API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Cycles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Get cycle details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/rns/pub/cycles/:cycleId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cycleId",
                "value": "",
                "type": "path",
                "description": "ID from the desired cycle."
              }
            ]
          },
          "docs": "Retrieve a specific cycle by its ID."
        },
        {
          "info": {
            "name": "VTex List cycles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/rns/pub/cycles",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "beginDate",
                "value": "",
                "type": "query",
                "description": "Lower limit for the date of creation of the cycle"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "Upper limit for the date of creation of the cycle"
              },
              {
                "name": "subscriptionId",
                "value": "",
                "type": "query",
                "description": "Id from the subscription that generated the cycle"
              },
              {
                "name": "customerEmail",
                "value": "",
                "type": "query",
                "description": "Customer that owns the subscription. Defaults to the current logged user"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Current cycle status"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page used for pagination"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Page size used for pagination"
              }
            ]
          },
          "docs": "List cycles filtering by some arguments."
        },
        {
          "info": {
            "name": "VTex Retry cycle",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/rns/pub/cycles/:cycleId/retry",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cycleId",
                "value": "",
                "type": "path",
                "description": "Id from the cycle that will be retried"
              }
            ]
          },
          "docs": "Every subscription order has an execution count called cycle, which determines the position of an order counting from when the shopper subscribed. This endpoint reruns a cycle that is currently in error state."
        }
      ]
    }
  ],
  "bundled": true
}