| handle |
string |
Per account unique handle for subscription |
|
| customer |
string |
Customer handle |
|
| plan |
string |
Subscription plan handle |
|
| state |
string |
State of the subscription, one of the following: active, expired or on_hold. Active subscriptions can be cancelled and will expire at the end of the current billing period, or later depending on optional notice and fixation periods, this can be checked using the is_cancelled parameter and expires. |
|
| test |
bool |
Test flag |
|
| amount |
int |
Optional custom plan price. If defined the plan price billed for each billing period will be overridden by this price. |
[optional] |
| quantity |
int |
Quantity of the plan product for this subscription. |
|
| expires |
\DateTime |
Fixed date when the subscription will expire because of cancellation. In ISO-8601 extended offset date-time format. |
[optional] |
| reactivated |
\DateTime |
Date when the subscription was reactivated from on hold. ISO-8601 extended offset date-time format. |
[optional] |
| timezone |
string |
Time zone for the subscription as standard time zone id. See Wikipedia |
|
| created |
\DateTime |
Date when the subscription was created. In ISO-8601 extended offset date-time format. |
|
| renewing |
bool |
If the subscription renews at current period end. Also true for subscriptions with manual scheduling. |
|
| plan_version |
int |
Subscription plan version |
|
| amount_incl_vat |
bool |
If optional custom plan price this parameter tells whether the amount is including VAT |
[optional] |
| start_date |
\DateTime |
Date and time from which the subscription is eligible to schedule invoices. Either from create or from the latest reactivate or subscription change. In ISO-8601 extended offset date-time format. |
|
| end_date |
\DateTime |
Fixed end date and time. In ISO-8601 extended offset date-time format. |
[optional] |
| grace_duration |
int |
Grace duration in seconds from the creation of a subscription where no dunning process is started for a failing invoice. This allows a certain amount of time for the customer to sign up with a payment method. |
[optional] |
| current_period_start |
\DateTime |
Start date and time for the current billing period. In ISO-8601 extended offset date-time format. |
[optional] |
| next_period_start |
\DateTime |
Start date and time for the next billing period, and also end date and time for the current billing period. Is also the date and time for next invoice if the subscription is renewing. In ISO-8601 extended offset date-time format. |
[optional] |
| first_period_start |
\DateTime |
Start date and time for the first ever billing period. In ISO-8601 extended offset date-time format. |
[optional] |
| last_period_start |
\DateTime |
Start date and time for the previous billing period. In ISO-8601 extended offset date-time format. |
[optional] |
| trial_start |
\DateTime |
Start date and time of free trial period. In ISO-8601 extended offset date-time format. |
[optional] |
| trial_end |
\DateTime |
End date and time of free trial period. In ISO-8601 extended offset date-time format. |
[optional] |
| is_cancelled |
bool |
Whether the subscription has been cancelled. Cancelled subscriptions will expire at the end of the current billing period. |
|
| in_trial |
bool |
Whether the susbcription is in its trial period. If subscription has not started (has_started), trial_start and trial_end can be used to determine if the subscription will have a trial period. |
|
| has_started |
bool |
If subscription has a later start date, this parameter tells if the subscription has started. Use this in connection with state to determine if a subscription is active. |
|
| renewal_count |
int |
Number of renewals for the subscription (number of invoices) |
|
| cancelled_date |
\DateTime |
Date when the subscription was cancelled. In ISO-8601 extended offset date-time format. |
[optional] |
| expired_date |
\DateTime |
Date when the subscription expired. ISO-8601 extended offset date-time format. |
[optional] |
| expire_reason |
string |
Reason for expire. Can be ondemand, cancelled, dunning or fixed |
[optional] |
| on_hold_date |
\DateTime |
Date when the subscription was put on hold. ISO-8601 extended offset date-time format. |
[optional] |
| on_hold_reason |
string |
Reason for on hold. Can be ondemand or dunning |
[optional] |
| payment_method_added |
bool |
Whether the customer at some point has added payment information to the subscription |
|
| scheduled_plan_change |
string |
Deprecated - see pending_change. If set, a subscription plan change has been scheduled to follow the next renewal. The value is the subscription plan handle to update to. |
[optional] |
| reminder_email_sent |
\DateTime |
If defined the date a reminder email was sent for the current billing period. In ISO-8601 extended offset date-time format. |
|
| failed_invoices |
int |
Number of failed invoices for this subscription |
|
| failed_amount |
int |
Summed amount for failed invoices |
|
| cancelled_invoices |
int |
Number of cancelled invoices for this subscription |
|
| cancelled_amount |
int |
Summed amount for cancelled invoices |
|
| pending_invoices |
int |
Number of pending invoices for this subscription |
|
| pending_amount |
int |
Summed amount for pending invoices |
|
| dunning_invoices |
int |
Number of dunning invoices for this subscription |
|
| dunning_amount |
int |
Summed amount for dunning invoices |
|
| settled_invoices |
int |
Number of settled invoices for this subscription |
|
| settled_amount |
int |
Summed settled amount |
|
| refunded_amount |
int |
Summed refunded amount |
|
| pending_additional_costs |
int |
Number of pending additional costs |
|
| pending_additional_cost_amount |
int |
Summed amount of pending additional costs incl vat |
|
| transferred_additional_costs |
int |
Number of additional costs that have been applied to invoices |
|
| transferred_additional_cost_amount |
int |
Summed amount of additional costs that have been applied to invoices |
|
| pending_credits |
int |
Number of credits that have not fully been applied to invoices |
|
| pending_credit_amount |
int |
Summed credit amount not yet applied to invoices |
|
| transferred_credits |
int |
Number of credits that have fully been applied to invoices |
|
| transferred_credit_amount |
int |
Summed credit amount that have been applied to invoices |
|
| hosted_page_links |
\Reepay\Model\SubscriptionLinks |
Links to hosted pages relating to subscription |
|
| subscription_discounts |
string[] |
List of subscription discounts handles attached to subscription |
[optional] |
| pending_change |
\Reepay\Model\SubscriptionChange |
Pending subscription change to be applied at next renewal |
[optional] |
| subscription_changes |
\Reepay\Model\SubscriptionChange[] |
List of subscription changes both at most one pending and previously applied |
[optional] |
| subscription_add_ons |
string[] |
List of subscription add-on handles attached to subscription |
[optional] |