Documentation
Documentation
Subscription
Close API Documentation
Subscription
States
  • Pending
    The subscription is pending.
  • Initializing
    The subscription is currently initializing. It will be active once the initial transaction is successful and the state is set to fulfill.
  • Failed
    The subscription has failed. The initialization was not successful.
  • Active
    The subscription is active. The customer will be charged according to the subscription cycle.
  • Terminating
    The subscription is terminating.
  • Terminated
    The subscription is terminated.
  • Termination scheduled
    The subscription is scheduled to be terminated.
  • Suspended
    The subscription is suspended. The customer will not be charged.
Properties
  • Activated On
    The date and time when the subscription was activate.
  • Affiliate
    The affiliate that led to the creation of the subscription.
  • Created On
    The date and time when the subscription was created.
  • Current Product Version
    The version of the product that the subscription is currently linked to.
  • Description
    A description used to identify the subscription.
  • ID
    A unique identifier for the object.
  • Initialized On
    The date and time when the subscription was initialized.
  • Language
    The language that is linked to the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Planned Termination Date
    The date and time when the subscription is planned to be terminated.
  • Reference
    The merchant's reference used to identify the subscription.
  • State
    The object's current state.
  • Subscriber
    The subscriber that the subscription belongs to.
  • Terminated By
    The ID of the user the subscription was terminated by.
  • Terminated On
    The date and time when the subscription was terminated.
  • Terminating On
    The date and time when the termination of the subscription started.
  • Termination Scheduled On
    The date and time when the subscription was scheduled to be terminated.
  • Token
    The payment token that is used to charge the customer.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.