Actions55
- Webhooks Actions
- Payments Actions
- Products Actions
- Plans Actions
- Partner Referrals Actions
- Reporting Actions
- Orders Actions
- Subscriptions Actions
- Invoicing Actions
- Disputes Actions
Plans → List Plans
AI-generatedOverview
The "List Plans" operation of the "Plans" resource in this node allows users to retrieve a list of billing plans from PayPal. This is useful for businesses or developers who want to manage and review their subscription billing plans programmatically within an n8n workflow.
Typical scenarios include:
- Displaying all available billing plans for selection or reporting.
- Automating synchronization of billing plans with other systems.
- Filtering plans by creation date or controlling pagination for large datasets.
For example, a user might use this operation to fetch all active billing plans created within a specific date range to update their internal product catalog or to audit plan usage.
Properties
| Name | Meaning |
|---|---|
| Additional Options | Collection of optional parameters: - Environment: PayPal environment to use ( sandbox or live). - Page Size: Number of items per page for list operations (default 20). - Start Time: Start date filter in ISO 8601 format. - End Time: End date filter in ISO 8601 format. |
Output
The output JSON object includes:
resource: The resource name, here always"plans".operation: The operation performed, here"listPlans".success: Boolean indicating if the API call was successful.- The response body from PayPal's
/v1/billing/plansendpoint, which typically contains an array of billing plans and related metadata. creditsUsed: Number of API credits consumed by the request (from the external validation API).creditsRemaining: Remaining API credits after the request.timestamp: ISO string timestamp when the response was received.
No binary data output is produced by this operation.
Dependencies
- Requires valid credentials for:
- An API key credential for the external "N8N Tools API" used for validating operations and tracking credit usage.
- A PayPal OAuth2 access token credential with appropriate permissions to access billing plans.
- The node dynamically selects the PayPal API base URL based on the chosen environment (
sandboxorlive). - The node uses HTTP requests to both the external validation API and PayPal's REST API.
Troubleshooting
- Invalid JSON in Request Body: Although not applicable for "List Plans" (which does not use a request body), other operations may fail if the JSON input is malformed. Ensure JSON syntax correctness.
- API Validation Failure: If the external validation API rejects the operation, check that the resource and operation names are correct and that credentials are valid.
- Unknown Operation or Resource Errors: These occur if unsupported resource or operation values are provided. Confirm you selected "Plans" as resource and "List Plans" as operation.
- Authorization Errors: If PayPal returns authorization errors, verify that the OAuth2 token is valid and has sufficient scopes.
- Rate Limits / Credit Exhaustion: The node tracks API credits used and remaining; if credits run out, further calls will fail. Monitor and replenish credits as needed.
- Date Filter Format: Ensure
startTimeandendTimeare in proper ISO 8601 format to avoid filtering errors.