Retrieve subscription data
Retrieve subscription status, customer details, invoices, and order history using Solidgate API methods for effective recurring payment management
When offering a subscription-based product model, access to accurate and timely subscription information is essential. This not only ensures customer satisfaction but also fosters financial transparency. Solidgate offers merchants a suite of efficient methods designed to retrieve subscription data, providing them with the necessary tools for effective recurring payment management.
- Methods for retrieving subscription details
These methods allow merchants to effortlessly obtain subscription information. Specifically, they can acquire subscription status by using thesubscription_idor usecustomer_idto access more comprehensive information, encompassing not only the subscription status but also crucial details such as the upcoming billing date. - Methods for listing subscription invoices and orders
The methods provide an opportunity to view the subscription payment history. Merchants can request a list of invoices bysubscription_idor a list of orders byinvoice_id, accessing a detailed breakdown of financial operations tied to specific subscriptions.
With this practical set of data retrieval tools, merchants can effortlessly access essential information, ensuring smooth subscription management.
By subscription ID
After performing the subscription statusAPI v1 request, you receive information about the last invoice for the subscription and the order status ID, which you can later use to verify the external order ID in the SolidgateHub.
With the subscription invoice information, you also get subscription details and information about the associated product. It also contains key customer data, such as customer account ID and email.
By customer ID
Retrieve subscriptions by customerAPI v1 allows the merchant to get all subscriptions and their status for the specific customer.
Retrieving a subscription by a customer_account_id in Solidgate usually involves the steps described below.
To retrieve a subscription
Get the customer’s ID
The first step is to identify the customer who has the subscription. This is generally done by retrieving thecustomer_account_idwhich is a unique identifier assigned to each customer by Solidgate.Make an API call
Using thecustomer_account_id, the merchant can make an API call to Solidgate to retrieve the subscription information. The API call typically includes thecustomer_account_idas a parameter and returns information such as thesubscription_id, status, start and end date, and next billing date.https://subscriptions.solidgate.com/api/v1/subscription/listReview the subscription information
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 for each subscription.Update the subscription status if necessary
Based on the review, if the merchant wants to update the subscription statuses, they can make another API call.https://subscriptions.solidgate.com/api/v1/subscription/cancel-by-customer
List invoices by subscription ID
The method of listing invoices by subscription IDAPI v1 allows you to get information about all invoices relevant to the specific subscription. Efficiently managing subscription-related financial operations becomes seamless with this method. It gives access to comprehensive details about all invoices directly associated with the specific subscription.
List orders by invoice ID
Using the method to list orders by invoice IDAPI v1 is essential when you seek detailed information about all orders relevant to the subscription invoice by its unique identifier. This method offers a comprehensive snapshot of orders tied to the specified invoice. It allows you to enhance proficiency in managing and analyzing the payment history associated with the subscription.
To get in-depth insights into customer subscriptions, Solidgate offers a