Subscription
The subscription object, exposed on subscription emails (e.g. Subscription canceled). These emails do not use the order data model.
Fields
| Field | Type | Notes |
|---|---|---|
name |
string | Subscription/plan name. |
userDefinedId |
string | Your plan id. |
status |
string | e.g. Active, Paused, Cancelled. |
amount |
number | Recurring amount. |
quantity |
number | |
currency |
string | |
schedule |
object | Payment schedule (interval, interval count, trial period). |
creationDate |
datetime | |
cancelledOn |
datetime | Optional. |
firstInvoiceReceivedOn |
datetime | Optional. |
totalSpent |
number | |
recurringShipping |
boolean | |
user |
object | The customer — user.email and user.billingAddress (Address). |
metadata |
object | Optional. |