{
  "opencollection": "1.0.0",
  "info": {
    "name": "HubSpot Commerce Subscriptions API",
    "version": "v3"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Hubspot List Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions",
            "params": [
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "The maximum number of results to return per page."
              },
              {
                "name": "after",
                "value": "example-value",
                "type": "query",
                "description": "The cursor for pagination to get the next page of results."
              },
              {
                "name": "properties",
                "value": "example-value",
                "type": "query",
                "description": "A comma-separated list of property names to return."
              },
              {
                "name": "archived",
                "value": "false",
                "type": "query",
                "description": "Whether to return archived subscriptions."
              }
            ]
          },
          "docs": "Returns a page of commerce subscription records. Use the limit and after parameters to paginate through subscriptions. You can also specify which properties to return using the properties parameter."
        },
        {
          "info": {
            "name": "Hubspot Create a Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new subscription record with the provided properties. Subscription records track recurring revenue relationships with customers."
        },
        {
          "info": {
            "name": "Hubspot Get a Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "500123",
                "type": "path",
                "description": "The ID of the subscription to retrieve."
              },
              {
                "name": "properties",
                "value": "example-value",
                "type": "query",
                "description": "A comma-separated list of property names to return."
              },
              {
                "name": "archived",
                "value": "false",
                "type": "query",
                "description": "Whether to return archived subscriptions."
              }
            ]
          },
          "docs": "Returns a single subscription record by its ID. You can specify which properties to return using the properties parameter."
        },
        {
          "info": {
            "name": "Hubspot Update a Subscription",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "500123",
                "type": "path",
                "description": "The ID of the subscription to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Performs a partial update of a subscription record. Only the properties included in the request body will be updated; other properties will remain unchanged."
        },
        {
          "info": {
            "name": "Hubspot Archive a Subscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "500123",
                "type": "path",
                "description": "The ID of the subscription to archive."
              }
            ]
          },
          "docs": "Archives (soft deletes) a subscription record by its ID. Archived subscriptions can be restored using the HubSpot UI or API."
        },
        {
          "info": {
            "name": "Hubspot Search Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Searches for subscription records using filter groups, sorts, and other query parameters."
        }
      ]
    },
    {
      "info": {
        "name": "Batch",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Hubspot Batch Read Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions/batch/read",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reads a batch of subscription records by their IDs. Useful for retrieving multiple subscriptions in a single API call."
        },
        {
          "info": {
            "name": "Hubspot Batch Create Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions/batch/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates multiple subscription records in a single API call."
        },
        {
          "info": {
            "name": "Hubspot Batch Update Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions/batch/update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates multiple subscription records in a single API call."
        }
      ]
    },
    {
      "info": {
        "name": "Associations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Hubspot List Subscription Associations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hubapi.com/crm/v3/objects/subscriptions/:subscriptionId/associations/:toObjectType",
            "params": [
              {
                "name": "subscriptionId",
                "value": "500123",
                "type": "path",
                "description": "The ID of the subscription."
              },
              {
                "name": "toObjectType",
                "value": "standard",
                "type": "path",
                "description": "The type of associated object."
              }
            ]
          },
          "docs": "Returns all associations of a subscription record to objects of a specified type, such as contacts, companies, or deals."
        }
      ]
    }
  ],
  "bundled": true
}