Customer who created this subscription.
Last transaction for this subscription.
Related store resource.
URL of the page where the customer can modify this subscription. This link is available only when configured in subscription settings.
Open this link in browser to load up the subscription template into a full HTML cart for the store.
Transaction template for this subscription.
List of transactions for this subscription.
This resource.
The date this resource was created.
The date this resource was last modified.
If set, the date this subscription will end. The subscription will not run on this day.
If the last run of this subscription encountered an error, that error message will be saved here. It will also note if a past due payment was made.
If this subscription failed to process due to an error such as expired payment card, this field will show the first date the subscription failed to process. If it processes successfully at the next attempt, this field will be cleared.
This determines how often this subscription will be processed. The format is a number followed by a date type such as d (day), w (week), m (month), or y (year). You can also use .5m for twice a month.
Determines whether or not this transaction is active or not. If you are using the subscription datafeed, it is best to set the end_date to tomorrow instead of settings this to inactive.
The date for when this subscription will run again.
If a subscription payment is missed, this amount will be increased by that payment. The next time the subscription runs, it will be charged automatically, depending on your store's subscription settings.
The original date this subscription began or will begin if set in the future.
If this subscription is using a third party subscription system such as PayPal Express, their identifier will be set here.
Generated using TypeDoc
List of attributes for this subscription.