[
{
"title":"Access to API",
"link":"https://docs.solidgate.com/payments/integrate/access-to-api/",
"text":"Understand how Solidgate authenticates your API requests and provides validation errors.",
"imgSrc":"https://solidgate.com/wp-content/uploads/2022/08/One-time.svg"
}
,
{
"title":"Integrate",
"link":"https://docs.solidgate.com/payments/integrate",
"text":"Explore Solidgate integration options, payment methods, and merchant website integration methods.",
"imgSrc":"https://solidgate.com/wp-content/uploads/2022/08/Custom-Built-Rules.svg"
}
,
{
"title":"Testing",
"link":"https://docs.solidgate.com/payments/testing/",
"text":"Simulate payments to test your integration before launching in production.",
"imgSrc":"https://solidgate.com/wp-content/uploads/2022/07/integration.svg"
}
]
Analyze cancellations, offer soft and hard cancellation options, and restore subscriptions
This code can be used to analyze cancellations and gain insight into the subscription lifecycle. By analyzing the cancel codes, merchants can identify patterns and trends in cancellations, understand the reasons behind them, and take steps to reduce the number of cancellations.
If a large number of cancellations are due to
Guide
Understand why the payment is declined and how you can resolve it.
invalid amounts
, the merchant may need to adjust their discount thresholds or pricing
If cancellations are due to issues with the
Guide
Understand why the payment is declined and how you can resolve it.
payment processor
or
Guide
Understand why the payment is declined and how you can resolve it.
fraud prevention
systems, the merchant may need to improve their security measures or work with the payment processor to address the issue.
Soft and Hard cancellation options provide flexibility in managing subscriptions for both merchants and customers. Soft cancel postpones the subscription cancellation until the end of the billing period, while Hard cancel, on the contrary, cancels the subscription immediately.
Soft cancel
This cancellation type allows the subscriber to continue using the services until the end of the paid period while maintaining the subscription in an
active
status. Upon completion of the current paid period, the subscription status will automatically change to
cancel
Hard cancel
This cancellation type involves an immediate change of the subscription status to
cancel
. If the cancellation occurred by mistake, the subscription can be restored.
Hard cancellation is suitable for cases when the merchant and customer have agreed to terminate the subscription, and do not expect it to be reactivated in the future. This type of cancellation occurs when the force parameter has a true value in the “Cancel subscription by subscribing ID” and “Cancel subscriptions by customer ID” methods. This ensures the immediate cancellation of the subscription, regardless of the billing period.
Via HUB
You can restore a subscription through our admin panel by following these steps:
Go to the subscription tab in the admin panel
Filter the subscriptions by the customer’s email address
Click “Cancel” to schedule the cancellation at the end of the billing period (soft cancel)
Click “Cancel now” to cancel the subscription immediately (hard cancel)
Via API
By subscription ID
The
cancel subscription method
API
allows merchants to cancel a specific subscription of a client by providing the
subscription_id
, and specifying whether to cancel the subscription immediately or at the end of the billing period. Additionally, a
Guide
A subscriptions cancellation code is used to describe the reason the subscription was cancelled.
cancel code
can be provided to indicate the reason for cancellation.
The
cancel subscriptions by customer ID
API
allows merchants to cancel all subscriptions for a specific customer. This method requires the
customer_account_id
, and also allows merchants to specify whether to cancel the subscription immediately or at the end of the billing period, and a cancel code to indicate the reason for cancellation.
Retrieving a subscription by a
customer_account_id
in Solidgate typically involves the following steps:
The first step is to identify the customer to whom the subscription belongs to. This is typically done by retrieving the
customer_account_id
, which is a unique identifier assigned to each customer by Solidgate.
Using the
customer_account_id
, the merchant can make an API call to Solidgate to retrieve the subscription information:
The API call will typically include the
customer_account_id
as a parameter, and will return information such as the
subscription_id
, status, start and end date, and next billing date.
Once the merchant receives the subscription information from the API call, they can review it to check the status of the subscription, the amount, and the next billing date.
Based on the review, if the merchant wants to update the subscription status, they can make another API call to Solidgate to update the subscription status.