{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Subscriptions API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex Get subscription details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions/:id",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID from the target subscription."
              }
            ]
          },
          "docs": "Retrieve a specific subscription by its ID."
        },
        {
          "info": {
            "name": "VTex Update subscription",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions/:id",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID from the given subscription."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a specific subscription."
        },
        {
          "info": {
            "name": "VTex List subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerEmail",
                "value": "",
                "type": "query",
                "description": "Customer that owns the subscription. Defaults to the current logged user."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Current subscription status"
              },
              {
                "name": "addressId",
                "value": "",
                "type": "query",
                "description": "Id from the address used as shipping address"
              },
              {
                "name": "paymentId",
                "value": "",
                "type": "query",
                "description": "Id from the payment used as payment method"
              },
              {
                "name": "planId",
                "value": "",
                "type": "query",
                "description": "Id from the plan that the subscription belongs to"
              },
              {
                "name": "nextPurchaseDate",
                "value": "",
                "type": "query",
                "description": "Date for the next cycle"
              },
              {
                "name": "originalOrderId",
                "value": "",
                "type": "query",
                "description": "Id from the order that generated the subscription"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page used for pagination"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Page size used for pagination"
              }
            ]
          },
          "docs": "List subscriptions filtering by some arguments."
        },
        {
          "info": {
            "name": "VTex Create subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new subscription."
        },
        {
          "info": {
            "name": "VTex Edit items on a subscription.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions/:id/items/:itemId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id from the target subscription"
              },
              {
                "name": "itemId",
                "value": "",
                "type": "path",
                "description": "Id from the target item"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Edit a given item on a specific subscription"
        },
        {
          "info": {
            "name": "VTex Remove items from a subscription.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions/:id/items/:itemId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id from the target subscription"
              },
              {
                "name": "itemId",
                "value": "",
                "type": "path",
                "description": "Id from the subscription item that will be removed"
              }
            ]
          },
          "docs": "Removes a specific item from a given subscription"
        },
        {
          "info": {
            "name": "VTex Add item to subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions/:id/items",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID from the target subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a new item to a given subscription."
        },
        {
          "info": {
            "name": "VTex Calculate the current prices for a specific subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions/:id/simulate",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id from the target subscription"
              }
            ]
          },
          "docs": "Simulates an order made by the specific subscription on checkout and retrieves the current price for items and shipping."
        },
        {
          "info": {
            "name": "VTex Calculate the current prices for the provided subscription template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions/simulate",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Simulates an order made by subscriptions on checkout and retrieves the current price for items and shipping."
        },
        {
          "info": {
            "name": "VTex Get conversation messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/rns/pub/subscriptions/:subscriptionId/conversation-message",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "ID of the subscription."
              }
            ]
          },
          "docs": "Retrieve all conversation messages sent to a customer regarding a given subscription."
        }
      ]
    }
  ],
  "bundled": true
}