Update a Subscription
Update a Subscription - start date, plan, quantity, duration and the notify customer flag.
You can update following parameters of a Subscription that is active
:
-
Plan
linked to the Subscription. -
Quantity
, that is the number of times the amount should be charged to the customer per billing cycle. For example, this would be the number of users for a software product. -
Subscription Start Date
for the updated Subscription details. This can either be immediate or any future date. You can choose to update a Subscription: -
Total count
, that is the number of billing cycles. This determines the duration of the Subscription. -
Offer
, this is the offer linked to the Subscription.Watch Out!
You can only update the offer linked to the Subscription at the end of the cycle. It is not possible to update an offer linked to a Subscription immediately.
A customer might want to update from a basic plan to an advanced plan that increases the frequency of your service, or they might want to decrease the number of users for a software product. You can update the Subscription for them in such cases, either immediately or at the end of the current billing cycle.
Watch Out!
- You can only update Subscriptions in the
authenticated
andactive
states. Subscriptions in thecreated
,pending
orhalted
state cannot be updated. There is no state change when a Subscription is updated. Know more about the . - You cannot update a Subscription if the difference amount after updating a Subscription (credit or refund) is less than the update quantity x the smallest currency subunit.
When you update a Subscription immediately, you may have to perform the following:
- Charge the customer an extra amount
- Refund an amount to the customer
If the remaining amount for the original Subscription is the same as the amount to be charged for the updated Subscription, no charge or refund needs to be done.
Handy Tips
- If you are updating a Subscription (amount in Ringgits), ensure that the prorated amount difference between the existing and new plans is at least 50 currency subunits, that is, RM 0.5. You will get an error if the amount difference between the two plans is less than RM 0.5.
- This is valid only when you update a Subscription immediately.
When upgrading a plan or increasing the number of users, you may have to charge a customer an extra amount. In such scenarios, Curlec creates an invoice and charges the customer the difference amount.
If the charge is successful, the invoice is sent to the customer only if Curlec handles the customer's notifications.
You will be notified via the subscription.updated
webhook.
If the charge fails, the Subscription is not updated.
When downgrading a plan or reducing the number of users, you might have to give the customer a refund. In such scenarios, Curlec refunds the amount to the customer.
You will be notified about this via the subscription.updated
webhook.
A refund to a customer is done using a Credit Note. Credit notes are similar to add-ons and help you in reconciliation.
- Credit notes are not created against invoices. They are created against the total value of payments made by the customer. This means that only one credit note is created even if refunds have to be made against multiple invoices.
- You can view credit notes on the Dashboard against the respective Subscription.
- The credit notes are refunded automatically.
A credit note can have two states:
created
: The initial state of a credit note. A credit note stays in this state until a full refund is made to the customer.refunded
: The final state of a refund. A credit note moves to this state once the refund is successfully processed.
In the below examples, the Subscription is updated immediately, and there is no change in its billing cycle.
In the below example, we reduce the plan amount
but increase the quantity
. This change is done on the 1st
day the Subscription becomes active
. The updates take effect immediately.
In this example, you neither have to charge the customer an extra amount nor give them a refund.
In the below example, we reduce the plan amount
but increase the quantity
. This change is done on the 15th
day after the Subscription becomes active
. The updates take effect immediately.
In this example, you neither have to charge the customer an extra amount nor give them a refund.
In the below example, we reduce the plan amount
and the quantity
. This change is done on the 6th
day after the Subscription becomes active
. The updates take effect immediately.
In this example, you have to refund the customer RM 600.00.
In the below examples, the Subscription is updated immediately, and there is a change in the billing cycle.
In the below example, we are increasing the plan amount
, keeping the quantity
same and reducing the billing frequency
. This change is done on the 1st
day the Subscription becomes active
. The updates take effect immediately.
In this example, you neither have to charge the customer an extra amount nor give them a refund.
In the below example, we are increasing the plan amount
, keeping the quantity
same and reducing the billing frequency
. This change is done on the 245th
day the Subscription becomes active
. The updates take effect immediately.
Watch Out!
If the plans have different billing cycles, the new plan is billed at the new interval, starting on the day of the change.
In this example, you have to charge the customer an extra amount of RM 18,270.00.
In the below example, let us increase the plan amount
, quantity
and the billing frequency
. This change is done on the 27th
day the Subscription becomes active
. The updates take effect immediately.
Watch Out!
If the plans have different billing cycles, the new plan is billed at the new interval, starting on the day of the change.
In this example, you have to charge the customer an extra amount of RM 1,760.00.
When you update a Subscription at the end of the current billing cycle, there is no need for any amount adjustment with the customer. The Subscription is updated with the new values when the current billing cycle ends.
To update a Subscription:
-
Log in to the
and click Subscriptions under PAYMENT PRODUCTS in the left menu. -
Click the Subscription Id you want to update. The details of the Subscription appear in the right pane. You can update the Notify flag from this tab. If enabled, notifications are sent to the customers. If disabled, you need to update the customer.
-
Click Update to update any of the following parameters:
- Plan
- Quantity
- Subscription Start Date
- Total count
- Apply changes
- Offer applied on the Subscription
-
Select Immediately or End of Cycle to update the offer immediately or at the end of the current billing cycle.
Handy Tips
The new offer will be linked to the Subscription only at the end of the cycle. It is not possible to update an offer linked to a Subscription immediately.
-
Click Next. Review the changes are made and click Update.
You can update a Subscription using
API.You can cancel an update pending on a Subscription from the Dashboard.
Watch Out!
You can only cancel an update pending on a Subscription and not the live ones.
To cancel a Subscription update:
- Log in to the and click Subscriptions under PAYMENT PRODUCTS in the left menu.
- Click the Subscription Id for which you want to cancel the update and click Cancel Update.
- Click Yes, cancel.
Was this page helpful?
ON THIS PAGE