list_subscriptions

Retrieve and filter subscriptions from your Paddle account with pagination, sorting, and parameters like customer ID, price ID, status, and scheduled changes. Manage subscription data efficiently.

Instructions

This tool will list subscriptions from your Paddle account.

Use the maximum perPage by default (200) to ensure comprehensive results. Filter subscriptions by address ID, customer ID, price ID, collection mode, scheduled change action, and status as needed. Results are paginated - use the 'after' parameter with the last ID from previous results to get the next page. Sort results using orderBy parameter. Amounts are in the smallest currency unit (e.g., cents).

Input Schema

Name	Required	Description
`addressId`	No	Return entities related to the specified address.
`after`	No	Return entities after the specified Paddle ID when working with paginated endpoints.
`collectionMode`	No	Return entities that match the specified collection mode.
`customerId`	No	Return entities related to the specified customer.
`id`	No	Return only the IDs specified.
`orderBy`	No	Order returned entities by field and direction.
`perPage`	No	Set how many entities are returned per page. Default: 50; Maximum: 200.
`priceId`	No	Return entities related to the specified price.
`scheduledChangeAction`	No	Return subscriptions that have a scheduled change.
`status`	No	Return entities that match the specified status.

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "addressId": {
      "description": "Return entities related to the specified address.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "after": {
      "description": "Return entities after the specified Paddle ID when working with paginated endpoints.",
      "type": "string"
    },
    "collectionMode": {
      "description": "Return entities that match the specified collection mode.",
      "enum": [
        "automatic",
        "manual"
      ],
      "type": "string"
    },
    "customerId": {
      "description": "Return entities related to the specified customer.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "id": {
      "description": "Return only the IDs specified.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "orderBy": {
      "description": "Order returned entities by field and direction.",
      "enum": [
        "id[ASC]",
        "id[DESC]"
      ],
      "type": "string"
    },
    "perPage": {
      "description": "Set how many entities are returned per page. Default: 50; Maximum: 200.",
      "type": "number"
    },
    "priceId": {
      "description": "Return entities related to the specified price.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "scheduledChangeAction": {
      "description": "Return subscriptions that have a scheduled change.",
      "items": {
        "enum": [
          "cancel",
          "pause",
          "resume"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "status": {
      "description": "Return entities that match the specified status.",
      "items": {
        "enum": [
          "active",
          "canceled",
          "past_due",
          "paused",
          "trialing"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Paddle MCP Server