DID_CHANGE_RENEWAL_STATUS, INTERACTIVE_RENEWAL

This notification triggers when a subscription is active or the customer is upgraded to another SKU (stock-keeping unit). Chargebee checks relevant details in the receipt to detect an upgrade event. Once an upgrade event is detected, you can update the subscription with the new product details, and allow the update to take effect immediately.

Chargebee webhooks triggered For subscription cancellation, whether immediately or at the end of the term. subscription_changed, subscription_cancellation_scheduled, subscription_cancellation_reminder, and subscription_cancelled.

For subscription upgrade with proration. subscription_changed, invoice_generated, payment_succeeded, and invoice_updated.

For subscription reactivation. subscription_reactivated, subscription_reactivated_with_backdating, payment_succeeded, and invoice_updated.

For regular subscription renewal. subscription_renewed, subscription_changed, invoice_generated, payment_succeeded, and invoice_updated.

DID_CHANGE_RENEWAL_PREF

This notification triggers when a subscription is active or the customer is downgraded to another SKU(stock-keeping unit). It indicates that the customer made a change in their subscription plan that takes effect at the next renewal. The currently active plan is not affected. Chargebee schedule downgrades to take effect at the end of the period. At the end of the billing period, confirm the downgrade at Apple's end before downgrading it in the Chargebee.

Chargebee webhooks triggered For subscription upgrade with proration. subscription_changed, invoice_generated, payment_succeeded, and invoice_updated.

DID_CHANGE_RENEWAL_STATUS

This notification triggers when a subscription is expired or the customer resubscribes to the same SKU(stock-keeping unit). Chargebee re-activates subscription immediately.

Chargebee webhooks triggered For subscription cancellation. subscription_changed, subscription_cancellation_scheduled, subscription_cancellation_reminder, and subscription_cancelled.

For subscription upgrade with proration. subscription_changed, invoice_generated, payment_succeeded, and invoice_updated.

INTERACTIVE_RENEWAL, DID_CHANGE_RENEWAL_STATUS

This notification triggers when a subscription is expired or the customer resubscribed to another SKU (upgrade or downgrade). Chargebee immediately re-activates the subscription with the new product(plan or item).

Chargebee webhooks triggered For subscription upgrade with proration. subscription_changed, invoice_generated, payment_succeeded, and invoice_updated.

For subscription cancellation, whether immediately or at the end of the term. subscription_changed, subscription_cancellation_scheduled, subscription_cancellation_reminder, and subscription_cancelled.

This notification triggers when the customer canceled the subscription from the App Store Subscriptions settings page. Their subscription will not auto-renew and will expire on the expires_date.

Chargebee sets subscription to cancel at expires_date.

Chargebee webhooks triggered

For subscription cancellation, whether immediately or at the end of the term. subscription_changed, subscription_cancellation_scheduled, subscription_cancellation_reminder, and subscription_cancelled.

DID_CHANGE_RENEWAL_STATUS

This notification triggers when the customer previously canceled the subscription but now resubscribed to the same product before the subscription expired. The subscription will auto-renew on the expires_date.

Chargebee removes scheduled cancellation of subscription and allows it to auto-renew. If the dates have changed for the term start and end, change the same in the Chargebee subscription.

For subscription reactivation. subscription_reactivated, subscription_reactivated_with_backdating, payment_succeeded, and invoice_updated.

CANCEL, DID_CHANGE_RENEWAL_STATUS

This notification triggers when AppleCare refunded a subscription. CANCEL indicates that Apple Support cancelled the auto-renewable subscription and the customer received a refund as of the timestamp in cancellation_date_ms.

Chargebee cancels the subscription on cancellation_date_ms. Record an offline refund and create a refundable credit note for the full amount. Record cancellation comment on the refund transaction saying canceled by Apple Support.

For subscription cancellation, whether immediately or at the end of the term. subscription_changed, subscription_cancellation_scheduled, subscription_cancellation_reminder, and subscription_cancelled.

DID_FAIL_TO_RENEW

This notification triggers when the subscription failed to renew because of a billing issue. It Indicates a subscription that failed to renew due to a billing issue. Check is_in_billing_retry_period to know the current retry status of the subscription. Check grace_period_expires_date to know the new service expiration date if the subscription is in a billing grace period.

Chargebee takes the following actions.

• When we receive this notification before a renewal invoice is created, schedule a cancellation at the end of the current term, if there is no grace period defined in the receipt.
• When the notification is received, after the renewal invoice is generated, the subscription remains active while the invoice status becomes not_paid.
• If grace_period_expires_date exists, schedule a subscription cancellation on that date.
• If there is no recovery until the scheduled cancellation date, then the subscription will get cancelled as scheduled, and the not_paid invoice will get written off.
• If grace_period_expires_date does not exist, cancel the subscription and write off the invoice immediately.

For subscription cancellation, whether immediately or at the end of the term. subscription_changed, subscription_cancellation_scheduled, subscription_cancellation_reminder, and subscription_cancelled.

DID_RECOVER

This notification triggers when expired subscription recovered by App Store through a billing retry. It indicates a successful automatic renewal of an expired subscription that failed to renew in the past. Check expires_date to determine the next renewal date and time. Chargebee resumes the paused subscription with any changes in subscription term dates as per receipt data. Remove scheduled cancellation. If we are syncing dunning information, update it accordingly.

Chargebee webhooks triggered For regular subscription renewal. subscription_renewed, subscription_changed, invoice_generated, payment_succeeded, and invoice_updated.

DID_CHANGE_RENEWAL_STATUS

This notification triggers when the subscription has churned after failed billing retry attempts. It indicates a change in the subscription renewal status. In the JSON response, check auto_renew_status_change_date_ms to know the date and time of the last status update. Check auto_renew_status to know the current renewal status. Chargebee cancels the subscription at the end of the current term.

Chargebee webhooks triggered For subscription cancellation, whether immediately or at the end of the term. subscription_changed, subscription_cancellation_scheduled, subscription_cancellation_reminder, and subscription_cancelled.

REFUND

This notification triggers when AppleCare successfully refunded the transaction for a consumable, non-consumable, or non-renewing subscription. Here, the cancellation_date_ms contains the timestamp of the refunded transaction. The original_transaction_id and product_id identify the original transaction and product. The cancellation_reason contains the reason.

Chargebee cancels the subscription on a specified date and records an offline refund for the full amount as canceled by Apple Support.

subscription_changed, credit_note_created, credit_note_updated, subscription_cancelled, and payment_refunded.

PRICE_INCREASE_CONSENT

This notification triggers when the subscription price is increased, and the customer must agree to the increase before the subscription auto-renews. It indicates that App Store has started asking the customer to consent to your app's subscription price increase. In the unified_receipt.Pending_renewal_info object, the price_consent_status value is 0, indicating that App Store is asking for the customer's consent, and hasn't received it. The subscription won't auto-renew unless the user agrees to the new price. When the customer agrees to the price increase, the system sets price_consent_status to 1. Check the receipt using verifyReceipt to view the updated price-consent status. Chargebee updates the subscription overriding subscription price. When consent is not received and renewal date is reached, pause the subscription. If possible, add a comment on the subscription saying "Paused because price increase consent not received from the customer".

DID_RENEW

This notification triggers when a customer's subscription is successfully auto-renewed for a new transaction period. Chargebee renews the subscription if not already auto-renewed.

Chargebee webhooks triggered For regular subscription renewal. subscription_renewed, subscription_changed, invoice_generated, payment_succeeded, and invoice_updated.

REVOKE

This notification triggers when a purchaser disabled Family Sharing for a product, the purchaser (or family member) left the family group, or the purchaser asked for and received a refund. Your app will also receive a paymentQueue(_:didRevokeEntitlementsForProductIdentifiers:) call. For more information about Family Sharing, see Supporting Family Sharing in Your App.

CONSUMPTION_REQUEST

The customer initiated a refund request for a consumable in-app purchase. Chargebee does not support this notification.

INITIAL_BUY

Indicates that the user purchased the subscription for the first time or that the user received access to the subscription through Family Sharing for the first time.

Chargebee does not take action as the initial purchase is recorded using Process Purchase Command API. However you can view these events in the "Sync events" page, if the subscription is present in the app store but wasn't created in Chargebee due to network failures. These events can be filtered by selecting "Pending" status in the Sync events page and then can be synced to Chargebee by invoking Process Purchase Command API for the associated receipt.

A new purchase (INITIAL_BUY) server notification is received.

Always use the process purchase command API to record a new purchase. Chargebee requires the amount paid and the currency to create a subscription.

A notification is received for an SKU (plan) change but the plan-item price is unavailable in Chargebee.

Create the plan-item price in Chargebee via API or admin console, then retry processing the webhook.

SUBSCRIPTION_RENEWED

Chargebee updates the subscription with the next renewal date. After receiving this notification if the subscription is in the canceled state, Chargebee reactivates the subscription.

For subscription reactivation. subscription_reactivated, subscription_reactivated_with_backdating, payment_succeeded, and invoice_updated.

For regular subscription renewal.

subscription_renewed, subscription_changed, invoice_generated, payment_succeeded, and invoice_updated.

SUBSCRIPTION_RESTARTED

Chargebee reactivates the canceled subscription.

Chargebee webhooks triggered subscription_reactivated, subscription_reactivated_with_backdating, payment_succeeded, and invoice_updated.

SUBSCRIPTION_IN_GRACE_PERIOD

Chargebee extends the current subscription term.

Chargebee webhooks triggered

subscription_changed

SUBSCRIPTION_ON_HOLD

Chargebee pauses the subscription and keeps it on hold.

Chargebee webhooks triggered

subscription_paused

SUBSCRIPTION_PAUSED

If the subscription is not already paused, Chargebee pauses the subscription.

Chargebee webhooks triggered

subscription_paused

SUBSCRIPTION_PAUSE_SCHEDULE_CHANGED

If the subscription is not already paused, Chargebee schedules the subscription pause on the pause_date.

Chargebee webhooks triggered

subscription_pause_scheduled

SUBSCRIPTION_REVOKED

Chargebee cancels the subscription immediately.

Chargebee webhooks triggered

invoice_updated and subscription_cancelled