Subscriptions
Retrieves the list of subscriptions.
Columns
Name | Type | References | |
Id [KEY] | String | ||
CustomerId | String |
Customers.Id | |
AutoCollection | String | ||
BaseCurrencyCode | String | ||
BillingPeriod | Integer | ||
BillingPeriodUnit | String | ||
CancelReason | String |
The allowed values are not_paid, no_card, fraud_review_failed, non_compliant_eu_customer, tax_calculation_failed, currency_incompatible_with_gateway, non_compliant_customer. | |
CurrencyCode | String | ||
CurrentTermEnd | Integer | ||
CurrentTermStart | Integer | ||
Deleted | Boolean | ||
DueInvoicesCount | Integer | ||
ExchangeRate | Double | ||
HasScheduledChanges | Boolean | ||
Mrr | Integer | ||
NextBillingAt | Datetime | ||
Object | String | ||
PaymentSourceId | String | ||
PlanAmount | Integer | ||
PlanFreeQuantity | Integer | ||
PlanId | String |
Plans.Id | |
PlanQuantity | Integer | ||
PlanUnitPrice | Integer | ||
PoNumber | String | ||
RemainingBillingCycles | Integer | ||
ResourceVersion | Long | ||
SetupFee | Integer | ||
StartDate | Datetime | ||
StartedAt | Datetime | ||
Status | String |
The allowed values are future, in_trial, active, non_renewing, paused, cancelled. | |
TrialEnd | Datetime | ||
TrialStart | Datetime | ||
ActivatedAt | Datetime | ||
UpdatedAt | Datetime | ||
CancelledAt | Datetime | ||
CreatedAt | Datetime | ||
Addons | String |