Autotask icon

Autotask

Interact with Kaseya's Autotask PSA REST API to manage companies, tickets, contracts, and more.

Actions524

Subscription Period → Get

AI-generated

Overview

This node operation retrieves a specific subscription period from the Autotask PSA system using its unique ID. It is useful for scenarios where detailed information about a particular subscription period is needed, such as billing cycles, contract management, or subscription tracking within a business process automation workflow.

Use Case Examples

  1. Retrieve subscription period details by ID to verify billing dates or subscription status.
  2. Fetch subscription period information to integrate with financial or CRM systems for reporting or automation.

Properties

Name Meaning
Subscription Period ID The unique identifier of the subscription period to retrieve, required to specify which subscription period to fetch.
Add Picklist Labels Whether to automatically add human-readable '_label' fields for picklist fields in the response, enhancing readability of picklist values.
Add Reference Labels Whether to automatically add human-readable '_label' fields for reference fields in the response, improving clarity of referenced data.
Select Columns Names or IDs. Specify which fields to include in the response. If none are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields Whether to bring user-defined fields (UDFs) to the top level of the response object instead of nested inside a userDefinedFields array, simplifying data access.

Output

JSON

  • id - The unique identifier of the subscription period.
  • name - The name or title of the subscription period.
  • startDate - The start date of the subscription period.
  • endDate - The end date of the subscription period.
  • status - The current status of the subscription period.
  • _label - Additional human-readable labels for picklist or reference fields if enabled.
  • userDefinedFields - User-defined fields related to the subscription period, optionally flattened to top-level properties.

Dependencies

  • An API key credential for Autotask PSA REST API

Troubleshooting

  • Ensure the Subscription Period ID is correctly specified and exists in the Autotask system to avoid 'not found' errors.
  • If the API credentials are invalid or missing, authentication errors will occur; verify the API key and integration code.
  • Network issues or incorrect API endpoint configuration can cause request failures; check connectivity and custom zone URL if used.

Links

Discussion