SubscriptionPeriods

This entity describes an Autotask SubscriptionPeriods entity. This entity stores the information for an individual billing period item associated with an Autotask Subscription. When a subscription is created, a billing item is created for every billing period included in the duration of the subscription. So, for example, when a subscription is created with a quarterly billing type, and that subscription has a one year duration, four SubscriptionPeriods are created, one for each billing period. Refer also to Subscriptions.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: SubscriptionPeriods

Entity Path:

/atservicesrest/v1.0/SubscriptionPeriods

Parent Entity:

Subscriptions

Can Create:  
Can Update:  
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

  • One or more SubscriptionPeriods are created automatically when a Subscription is created. Refer to Subscriptions.
  • If the Subscription associated with a SubscriptionPeriod is deleted, the SubscriptionPeriod will be deleted.
  • If the Status of the Subscription associated with a SubscriptionPeriod is set to Canceled, and the SubscriptionPeriod has not been posted, the SubscriptionPeriod will be deleted.

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
id long    
periodCost decimal    
periodDate datetime      
periodPrice decimal    
postedDate datetime        
purchaseOrderNumber string (50)      
subscriptionID integer Subscriptions  

Additional resources