Update the data of a scheduled charge, apply discounts or cancel automatic chargesThis functionality is available for the following models:
☐ Acquirer
☑ AggregatorFor changes to be effective, make sure you have updated subscriptions at least 24 hours before the scheduled date for the next charge.
Obtain Subscription Data#
You can check all the data available for a subscription that was already created so that you can show them on screen for your customers. You can also save the information we return in your databases. You don't need to worry, because we will not give you any sensitive card data.First, you must find the subscription ID whose data you need to check. Then, make a call to our subscription query endpoint from your back-end; don't forget to include the subscription ID as path parameter.According to the response you got, show on screen the information you requested, or save it in your database.Update Subscription Data#
When the recurring payment plan of your customers has changed, you may update data for a subscription that has been already created without the need of requesting again the card data.These are the data that you can update:Execution schedule for charges (periodicity)
Date for charge execution (startDate)
Subscription cancellation date (endDate)
Remember that to handle sensitive transaction information, your merchant must have the corresponding PCI certification.
Kushki.js integration (front end)#
If you are getting the token from your front end with the Kushki.js library, follow the steps below:Consumes the requestSubscriptionToken() method#
In your Kushki.js implementation, you need to consume the requestSubscriptionToken() method available in the library, sending the required parameters.If the request was successful, you will receive a response with the token as shown below{
"token": "90a9f2d93ba508c38971890454897fd4"
}
Update card details on a recurring charge#
If the token generation was successful, you must consume the endpoint update recurring charge card data by sending the token obtained in the previous step and the subscriptionId with the id of the subscription to be updated.API integration (back end)#
In your implementation using API, you need to consume the endpoint request a recurring charge token, sending the new card data.Update card details on a recurring charge#
If the token generation was successful, you must consume the endpoint update recurring charge card data by sending the token obtained in the previous step and the subscriptionId with the id of the subscription to be updated.Apply a temporary discount#
Kushki allows you to offer discount periods for your customers. Once the discount period you established is over, we will automatically charge the card the original amount when the subscription was created.First, you must find the ID of the subscription to which the discount will be applied. Then, make a call to our temporary discount endpoint for subscriptions from your back end; don't forget to include the subscription ID as a path parameter.The value you specify will be the amount that Kushki will charge to the card for the number of periods you defined. For example, your customer registered their card for a subscription of 30 USD monthly; if you want Kushki to charge 20 USD for two months, submit the amount and number 2, to stand for the number of periods.According to the response you get, redirect the user to a success or fail screen to inform the customer if the discount was applied correctly or if an error occurred.Cancel Recurring Charges#
If your customer decides to cancel their subscription, make sure it is also canceled in Kushki, so that scheduled charges are no longer executed. This action is immediate; once you run it, the subscription will be automatically canceled.Note that this action is irreversible.
