Stripe Subscription Events
Stripe Events enables your site to automatically change or merge a user's role. You can create a Stripe Plan and assign a role to each Stripe Event in WP-Admin > Ultimate Member > Stripe Plans. For more details, please see this doc article on stripe.com
List of Stripe Events:
| Stripe Events | Description |
| active | This attribute holds a role that will be assigned to customers when their subscription is active. A subscription moves into past due if the initial payment attempt fails. Once the first invoice is paid, the subscription moves into an active state. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. A subscription that is currently in a trial period is trialing and moves to active when the trial period is over. |
| trialing | This attribute holds a role that will be assigned to customers when their subscription is trialing. This is only triggered when the attribute trial_period_days is set in the WP Admin > Ultimate Member > Stripe Plans settings. |
| unpaid | This attribute holds a role that will be assigned to customers when their subscription is unpaid. If subscription collection charges automatically, It becomes past_due when payment to renew it fails and canceled or unpaid(depending on your subscription settings) when Stripe has exhausted all payment retry attempts.If subscription collection sends an invoice, it becomes past_due when its invoice is not paid by the due date and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created but then immediately automatically closed). After receiving updated payment information from a customer, you may reopen and pay their closed invoices. |
| pause | This attribute holds a role that will be assigned to customers when their subscription is paused. When a subscription is resumed, and the subscription is trialing, it will assign the role set in the trialing attribute. If the subscription is not trialing, it will assign the role set in the active attribute. |
| past_due | This attribute holds a role that will be assigned to customers when their subscription is past due. |
| canceled | This attribute holds a role that will be assigned to customers when their subscription is canceled. Stripe will change the role to canceled with the following cases:
|
| trial_period_days | The default number of trial days when subscribing a customer to a plan. This attribute enables the trialing functionality of the subscription plan. This will always overwrite any trials that might apply via a subscribed plan. |