SubscriptionEvent Object - Square API Reference

Name	Description
`id string` Required	The ID of the subscription event.
`subscription_event_type string` Required	Type of the subscription event.
`effective_date string` Required	The date, in YYYY-MM-DD format (for example, 2013-01-15), when the subscription event went into effect.
`plan_id string` Required	The ID of the subscription plan associated with the subscription.
`info SubscriptionEventInfo`	Additional information pertaining to the subscription event.

Required

The ID of the subscription event.


          
  
  
            subscription_event_type
          


        

        
    string

Required

Type of the subscription event.


          
  
  
            effective_date
          


        

        
    string

Required

The date, in YYYY-MM-DD format (for example, 2013-01-15), when the subscription event went into effect.

Required

The ID of the subscription plan associated with the subscription.


          
  
  
            info
          


        

        
    
      SubscriptionEventInfo

Additional information pertaining to the subscription event.

Object Index

You are viewing an old version of the API

All Versions

SubscriptionEvent