SubscriptionPeriod

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity describes an Autotask SubscriptionPeriod. A SubscriptionPeriod 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 Subscription.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: SubscriptionPeriod
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 Subscription.
  • 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 field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
id Subscription Period ID Int64    
PeriodCost Period Cost Decimal    
PeriodDate Period Date datetime      
PeriodPrice Period Price decimal    
PostedDate Posted Date datetime        
PurchaseOrderNumber Purchase Order Number string (50)      
SubscriptionID Subscription ID integer Subscription