Documentation
Subscription Charge

The subscription charge represents a single charge carried out for a particular subscription.

States
  • Scheduled
    The charge is scheduled and it will be carried once the target date has been reached.
  • Pending
    The subscription charge is currently carried out.
  • Successful
    The subscription charge execution is successful.
  • Failed
    The subscription charge execution failed.
  • Discarded
    The charge has been discarded.
Properties
  • Created On
  • Discarded By
  • Discarded On
  • External ID
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • Failed On
  • Failed Url
    The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Language
  • Ledger Entries
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Planned Execution Date
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • Processing Type
  • Reference
  • State
  • Subscription
    The field subscription indicates the subscription to which the charge belongs to.
  • Succeed On
  • Success Url
    The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.
  • Transaction
  • Type
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.