Dunning

Flow

Handling overdue payments. Once the payment is considered lost, the business is no longer entitled to the underlying add-on.

Process

This flow happens behind the scenes and is not involving user actions:

Dunning process completed - The billing system handles charges and overdue payments. Once a payment is considered lost, the billing system notifies the billing app to expire the subscription.
Expire subscription - The billing app expires the current subscription immediately

An example of expiring subscription API call:

curl --location --request PUT 'https://api.vcita.biz/business/subscriptionsmng/v1/subscriptions/{subscription id}' \
--header 'Authorization: Bearer {business API token}' \
--header 'Content-Type: application/json' \
--data '{
  "subscription":
  {
    "purchase_state": "expired"
  }
}'

Example Response

{
  "success": true,
  "data": {
    "subscription":
         {
           "is_active": true,
           "uid": "123",
           "display_name": "Platinum5",
           "updated_at": "2024-07-31T06:36:30.828Z",
           "created_at": "2024-07-31T06:36:30.828Z",
           "purchasable_uid": "1234",
           "purchase_state": "expired",
           "cancellation_date": "2024-07-31T06:36:30.828Z",
           "expiration_date": "2024-07-31T06:36:30.828Z",
           "buyer_uid": "12345",
           "business_uid": "123456",
           "purchase_price": 10,
           "purchase_currency": "USD",
           "payment_type": "monthly",
           "bundled_from_subscription_uid": ""
        }
  }
}