{
  "opencollection": "1.0.0",
  "info": {
    "name": "Orb Alerts Subscriptions API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.withorb.com/v1/subscriptions",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "external_customer_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "status",
                "value": "",
                "type": "query"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "An opaque cursor for the next page of results."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of items to return per page (default 20, max 100)."
              }
            ]
          },
          "docs": "List subscriptions"
        },
        {
          "info": {
            "name": "Create subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.withorb.com/v1/subscriptions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a subscription that associates a customer with a plan, starting the accrual of usage charges into a draft invoice."
        },
        {
          "info": {
            "name": "Fetch subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.withorb.com/v1/subscriptions/:subscription_id",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Fetch subscription"
        },
        {
          "info": {
            "name": "Update subscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.withorb.com/v1/subscriptions/:subscription_id",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update subscription"
        },
        {
          "info": {
            "name": "Cancel subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.withorb.com/v1/subscriptions/:subscription_id/cancel",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancel subscription"
        },
        {
          "info": {
            "name": "Fetch subscription usage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.withorb.com/v1/subscriptions/:subscription_id/usage",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "timeframe_start",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeframe_end",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns usage quantities for the subscription's billable metrics over a window."
        },
        {
          "info": {
            "name": "Schedule plan change",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.withorb.com/v1/subscriptions/:subscription_id/schedule_plan_change",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Schedule plan change"
        }
      ]
    }
  ],
  "bundled": true
}