Subscriptions 2.0

Event: subscription-v2:trial-interval:started Only sent if a trial period is configured for this subscription product

The trial period for a subscription has started. No invoice has been created yet. If this webhook is sent, it is preceded by a subscription-v2:trial-interval:created event with a unique status.

Event: subscription-v2:trial-interval:canceled Only sent if a trial period is configured for this subscription product

The trial period for a subscription has been canceled. One of the following events will be sent alongside this one:

• subscription-v2:trial-interval:canceled-merchant: When the subscription is canceled by the merchant through their Sellix dashboard.
• subscription-v2:trial-interval:canceled-customer: When the subscription is canceled by the customer through an embeddable or the Customer Billing Portal.
• subscription-v2:trial-interval:canceled-api: When the subscription is canceled by calling the DELETE /subscriptions_v2/{uniqid} endpoint.

Event: subscription-v2:trial-interval:ended Only sent if a trial period is configured for this subscription product

The trial period for a subscription has ended. Immediately after this event is triggered, the subscription-v2:payment-interval:started and subscription-v2:payment-interval:created events will be sent indicating that the first payment interval has been requested. This does not mean that the payment was received.

Event: subscription-v2:started

This event is triggered when the status of the subscription goes from PENDING to ACTIVE, meaing once your customer’s subscription has been started and the payment has succeeded. You can use this event to implement any logic that should be executed once the subscription is purchased.

We highly suggest the usage of our custom fields to act as a metadata object in order to recognize which customer purchased your subscription and activate it for them.

This webhook event is typically preceeded by the subscription-v2:created event, which is sent when the subscription is created with a status of PENDING.

When a subscription first starts, the following events will be triggered alongside this one, each with their respective created event:

• subscription-v2:plan:started: Triggered every time a payment plan for a subscription is started.
• subscription-v2:payment-interval:started: Treated every time a payment interval for a subscription is started.

Event: subscription-v2:plan:gateway-changed

Changing the gateway for a subscription will not create a new subscription. The recurring invoice will be charged through the new gateway. If the customer updates his preferred gateway for the subscription through our API via the PUT /subscriptions_v2/{uniqid} endpoint, embeddables or the Customer Billing Portal, you will receive a webhook event with the updated subscription object.

This event can be triggered alongside the subscription-v2:plan:payment-method-changed event.

Events: subscription-v2:plan:upgrade or subscription-v2:plan:downgrade

When the customer or merchant changes the plan of their subscription via the POST /subscriptions_v2 endpoint, embeddables, the Customer Billing Portal, or the merchant dashboard, one of these events will be triggered. When a subscription plan changes, the following events will be triggered alongside this one:

• subscription-v2:plan:started: Triggered alongside subscription-v2:plan:created every time a new plan is selected for the subscription
• subscription-v2:ended: Upgrades and downgrades will complete the subscription plan, which sends this event.
• subscription-v2:plan:ended: Triggers whenever the subscription plan changes

Events: subscription-v2:canceled and subscription-v2:plan:canceled and subscription-v2:plan:payment-canceled

Subscription cancelation by either the customer or the merchant triggers this event. The status of the subscription will be CANCELED or AWAIT_CANCELING. One of the following events will be sent alongside this one:

• subscription-v2:canceled-merchant: When the subscription is canceled by the merchant through their Sellix dashboard. The subscription-v2:plan:canceled-merchant event is also sent.
• subscription-v2:canceled-customer: When the subscription is canceled by the customer through an embeddable or the Customer Billing Portal. The subscription-v2:plan:canceled-customer event is also sent.
• subscription-v2:canceled-api: When the subscription is canceled by calling the DELETE /subscriptions_v2/{uniqid} endpoint. The subscription-v2:plan:canceled-api event is also sent.

The following events are also sent: subscription-v2:payment-interval:canceled, subscription-v2:payment-interval:canceled-merchant, subscription-v2:payment-interval:canceled-customer, subscription-v2:payment-interval:canceled-api and subscription-v2:payment-interval:payment-canceled

Event subscription-v2:payment-interval:upcoming

The event is sent a week before the current payment interval’s end.

Event subscription-v2:ended

The first part of the renewal process is ending the previous plan and payment_interval. These events will be triggered as part of that process:

• subscription-v2:plan:ended: When the subscription’s plan has reached the end of its current interval.
• subscription-v2:payment-interval:ended: When the subscription’s payment interval has ended.

The second part is creating a new payment_ and plan_ for the subscription. These events will be triggered as part of that process:

• subscription-v2:plan:payment-succeeded: When the payment for the subscription plan has been successfully processed.
• subscription-v2:payment-interval:payment-succeeded: When the payment interval for the subscription has been successfully processed.

Event: subscription-v2:plan:payment-failed

The payment for the subscription has failed. The subscription will remain ACTIVE and the payment will be retried at a later time. When the payment is retried, the subscription-v2:payment-interval:charge-retried event will be triggered, and if the retry does not succeed, the subscription-v2:payment-interval:charge-failed and subscription-v2:payment-interval:payment-failed events may be sent If the payment is not updated, the subscription will be canceled and the subscription-v2:canceled event will be triggered.