"}},"httpPath":"/resign","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/refund-card-order","routeSlug":"/api/card-payments/refund-card-order","metadata":{"seo":{"title":"Refund","description":"Request for transferring funds back to the cardholder."}},"httpPath":"/refund","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Void","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/void-card-order","routeSlug":"/api/card-payments/void-card-order","metadata":{"seo":{"title":"Void","description":"The void request serves to nullify pre-existing auth transactions by revoking the initial authorization. Be advised that the void method can only be executed for auth transactions."}},"httpPath":"/void","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Settle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/settle-card-order","routeSlug":"/api/card-payments/settle-card-order","metadata":{"seo":{"title":"Settle","description":"The settle method facilitates the settlement of previously auth transactions. Be advised that if the subsequent settle amount is less than the initial auth transaction amount, the difference will be refunded to the cardholder's account."}},"httpPath":"/settle","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Check order status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/get-status-card-order","routeSlug":"/api/card-payments/get-status-card-order","metadata":{"seo":{"title":"Check order status","description":"The check order status request helps to retrieve the present status of a given order."}},"httpPath":"/status","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Get ARN codes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/card-payments/get-arn-codes","routeSlug":"/api/card-payments/get-arn-codes","metadata":{"seo":{"title":"Get ARN codes","description":"Get ARN codes request obtains ARN codes for specific orders, providing essential information about refunds, currencies, and transaction statuses."}},"httpPath":"/arn-code","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Updated card order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-card-order-status","routeSlug":"/api/card-payments/webhook-card-order-status","metadata":{"seo":{"title":"Updated card order","description":"Webhooks allow merchants to securely receive real-time notifications in card order status changes, for example, from processing to auth_failed, and automatically trigger actions or updates in their own systems based on those events."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"CardsOrderStatus","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Created network token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-network-token-created","routeSlug":"/api/card-payments/webhook-network-token-created","metadata":{"seo":{"title":"Created network token","description":"Webhooks provide merchants with real-time notifications, indicating that the network token associated with a payment card has been issued by Visa or Mastercard. Merchants can then automatically update their systems based on these notifications."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"NetworkTokenCreated","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Updated network token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-network-token-updated","routeSlug":"/api/card-payments/webhook-network-token-updated","metadata":{"seo":{"title":"Updated network token","description":"Webhooks provide merchants with real-time notifications when the network token associated with a payment card is updated by Visa or Mastercard. These notifications allow merchants to automatically update their systems based on the events."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"NetworkTokenUpdated","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Received dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-chargeback","routeSlug":"/api/card-payments/webhook-chargeback","metadata":{"seo":{"title":"Received dispute","description":"Webhooks for chargebacks allow merchants to securely receive real-time notifications of chargeback events and automatically trigger actions or updates in their own systems based on those events."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"Chargeback","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Received prevention alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-alert-prevent","routeSlug":"/api/card-payments/webhook-alert-prevent","metadata":{"seo":{"title":"Received prevention alert","description":"Webhooks enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"CardPreventAlert","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Received fraud alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/card-payments/webhook-fraud-alert","routeSlug":"/api/card-payments/webhook-fraud-alert","metadata":{"seo":{"title":"Received fraud alert","description":"Webhooks for fraud alerts allow merchants to securely receive real-time notifications of fraud reported by card schemes."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"FraudAlert","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Alternative payment methods","link":"/api/alternative-payment-methods","routeSlug":"/api/alternative-payment-methods","items":[{"label":"Init payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/create-apm-init-payment","routeSlug":"/api/alternative-payment-methods/create-apm-init-payment","metadata":{"seo":{"title":"Init payment","description":"Operation for the initiation of a payment using an APMs, performs order creation and prepares the transaction for payment, allowing the customer to proceed with the payment process."}},"httpPath":"/init-payment","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Recurring","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/make-apm-recurring","routeSlug":"/api/alternative-payment-methods/make-apm-recurring","metadata":{"seo":{"title":"Recurring","description":"Initiate a token-based recurring payment refers to an automatic billing applied to a customer's payment method at predetermined intervals."}},"httpPath":"/v1/recurring","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Revoke token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/revoke-apm-recurring-token","routeSlug":"/api/alternative-payment-methods/revoke-apm-recurring-token","metadata":{"seo":{"title":"Revoke token","description":"Request to revoke a recurring token for alternative payment methods."}},"httpPath":"/v1/recurring-token/cancel","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/refund-apm-order","routeSlug":"/api/alternative-payment-methods/refund-apm-order","metadata":{"seo":{"title":"Refund","description":"Initiate a refund request to return funds for successfully processed orders."}},"httpPath":"/v1/refund","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Check order status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/alternative-payment-methods/get-status-apm-order","routeSlug":"/api/alternative-payment-methods/get-status-apm-order","metadata":{"seo":{"title":"Check order status","description":"Request for receiving current order status. The key benefit is that it allows merchants to efficiently monitor and manage their payments by providing comprehensive information about the order's status, payment method, transaction details, and customer information."}},"httpPath":"/v1/status","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Updated alternative order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/alternative-payment-methods/webhook-apm-order-status","routeSlug":"/api/alternative-payment-methods/webhook-apm-order-status","metadata":{"seo":{"title":"Updated alternative order","description":"Webhooks for alternative payment method status enable merchants to securely receive real-time notifications of changes in the status of alternative payment methods, such as processing or declined, and automatically initiate actions or updates in their own systems based on those events."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"APMOrderStatus","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Received PayPal dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/alternative-payment-methods/webhook-paypal-dispute","routeSlug":"/api/alternative-payment-methods/webhook-paypal-dispute","metadata":{"seo":{"title":"Received PayPal dispute","description":"Webhooks delivers critical insights into each PayPal dispute and its lifecycle, enabling businesses to manage disputes effectively and enhance customer satisfaction."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"PayPalDispute","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Received prevention alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/alternative-payment-methods/webhook-apm-alert-prevent","routeSlug":"/api/alternative-payment-methods/webhook-apm-alert-prevent","metadata":{"seo":{"title":"Received prevention alert","description":"Webhooks enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert, specifically for the PayPal method."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"APMPreventAlert","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Revoked recurring token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/alternative-payment-methods/webhook-apm-revoked-recurring-token","routeSlug":"/api/alternative-payment-methods/webhook-apm-revoked-recurring-token","metadata":{"seo":{"title":"Revoked recurring token","description":"Webhooks notify about a revoked recurring token for alternative payment methods."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"APMRevokedRecurringToken","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Billing","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Products and prices","link":"/api/products-and-prices","routeSlug":"/api/products-and-prices","items":[{"label":"Create product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/create-product","routeSlug":"/api/products-and-prices/create-product","metadata":{"seo":{"title":"Create product","description":"This method allows merchants to create new products by providing the required details."}},"httpPath":"/products","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Get product list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/get-products","routeSlug":"/api/products-and-prices/get-products","metadata":{"seo":{"title":"Get product list","description":"By using this method, merchants can find products and retrieve their details by applying filters such as product identifier, status, trial availability, and sorting criteria with pagination support."}},"httpPath":"/products","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Update product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/update-product","routeSlug":"/api/products-and-prices/update-product","metadata":{"seo":{"title":"Update product","description":"This method updates the existing product with specified details and returns the updated product information."}},"httpPath":"/products/{product_id}","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Get product by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/get-product-by-id","routeSlug":"/api/products-and-prices/get-product-by-id","metadata":{"seo":{"title":"Get product by ID","description":"This method allows merchants to obtain the existing product by its identifier."}},"httpPath":"/products/{product_id}","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Archive product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/archive-product","routeSlug":"/api/products-and-prices/archive-product","metadata":{"seo":{"title":"Archive product","description":"By using this method, merchants can archive products."}},"httpPath":"/products/{product_id}/archive","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Create product price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/create-product-price","routeSlug":"/api/products-and-prices/create-product-price","metadata":{"seo":{"title":"Create product price","description":"By using this method, merchants can create a new product price with specified details and retrieve the created product price information."}},"httpPath":"/products/{product_id}/prices","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Get product prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/get-product-prices","routeSlug":"/api/products-and-prices/get-product-prices","metadata":{"seo":{"title":"Get product prices","description":"This method allows merchants to retrieve product prices based on the specified filter criteria and pagination settings, returning the results along with pagination information."}},"httpPath":"/products/{product_id}/prices","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Retrieve prices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/find-prices","routeSlug":"/api/products-and-prices/find-prices","metadata":{"seo":{"title":"Retrieve prices","description":"This method allows merchants to retrieve prices in bulk based on specified filter criteria with pagination settings."}},"httpPath":"/products/prices/list","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Update product price","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/update-product-price","routeSlug":"/api/products-and-prices/update-product-price","metadata":{"seo":{"title":"Update product price","description":"By using this method, you can update an existing product price."}},"httpPath":"/products/{product_id}/prices/{product_price_id}","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Archive product price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/archive-product-price","routeSlug":"/api/products-and-prices/archive-product-price","metadata":{"seo":{"title":"Archive product price","description":"By using this method, you can archive an existing product price."}},"httpPath":"/products/{product_id}/prices/{product_price_id}/archive","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Calculate product price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/products-and-prices/calculate-product-price","routeSlug":"/api/products-and-prices/calculate-product-price","metadata":{"seo":{"title":"Calculate product price","description":"This method allows merchants to calculate an estimated product price for a specific location."}},"httpPath":"/products/calculatePrice","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Taxes","link":"/api/taxes","routeSlug":"/api/taxes","items":[{"label":"Transactional tax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/taxes/tax-transactional","routeSlug":"/api/taxes/tax-transactional","metadata":{"seo":{"title":"Transactional tax","description":"The transactional tax report aggregates every tax-relevant transaction into one file, combining order and product identifiers, channel and legal entity, processing amounts and currency, full tax breakdown, include type, rate, taxable and tax amounts, location, and BIN/IP geography for delivering a concise, high-level view of liabilities across entities and jurisdictions."}},"httpPath":"/transactional","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Download transactional tax","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/taxes/download-tax-transactional","routeSlug":"/api/taxes/download-tax-transactional","metadata":{"seo":{"title":"Download transactional tax","description":"Retrieves a ready-generated transactional tax report CSV."}},"httpPath":"/transactional/report/{report_id}/download","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Summary tax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/taxes/tax-summary","routeSlug":"/api/taxes/tax-summary","metadata":{"seo":{"title":"Summary tax","description":"The summary tax report aggregates your tax data into a single file, grouping figures by every unique combination of legal entity, tax location, and processing currency configured in your Solidgate account. It includes key metrics such as taxable turnover, calculated tax amount, and net revenue for each group, giving you a clear, high-level view of your liabilities across jurisdictions."}},"httpPath":"/summary","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Download summary tax","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/taxes/download-tax-summary","routeSlug":"/api/taxes/download-tax-summary","metadata":{"seo":{"title":"Download summary tax","description":"Retrieves a ready-generated summary tax report CSV."}},"httpPath":"/summary/report/{report_id}/download","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Calculated tax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/taxes/webhook-calculated-tax","routeSlug":"/api/taxes/webhook-calculated-tax","metadata":{"seo":{"title":"Calculated tax","description":"Webhooks provide merchants with instant notifications when the Solidgate tax solution calculates the tax amount of the transaction. These notifications allow merchants to notify users about paid taxes or to save tax information in real-time on the merchant’s side."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"CalculatedTax","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Manage subscriptions","link":"/api/manage-subscriptions","routeSlug":"/api/manage-subscriptions","items":[{"label":"Update subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/update-subscription","routeSlug":"/api/manage-subscriptions/update-subscription","metadata":{"seo":{"title":"Update subscription","description":"By using this method, merchants can update an active subscription by modifying the trial period, applying a discount, or changing the product. It allows multiple changes in a single request for efficient subscription management and customer retention."}},"httpPath":"/subscription/update","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Switch product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/switch-subscription-product","routeSlug":"/api/manage-subscriptions/switch-subscription-product","metadata":{"seo":{"title":"Switch product","description":"By using this method, merchants can update the product in the active subscription with a new one. After the switch request is made, a callback confirms the update and includes the new subscription product. The updated settings take effect on the next billing date."}},"httpPath":"/subscription/switch-subscription-product","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Update subscription token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/update-subscription-token","routeSlug":"/api/manage-subscriptions/update-subscription-token","metadata":{"seo":{"title":"Update subscription token","description":"This method provides a mechanism for merchants to update the payment token when the customer's preferred payment method changes."}},"httpPath":"/subscription/update-token","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Create subscription pause","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/create-subscription-pause","routeSlug":"/api/manage-subscriptions/create-subscription-pause","metadata":{"seo":{"title":"Create subscription pause","description":"By using this method, merchants can schedule a subscription pause, setting the specific start and end dates for the pause period."}},"httpPath":"/subscriptions/{subscription_id}/pause-schedule","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Update subscription pause","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/update-subscription-pause","routeSlug":"/api/manage-subscriptions/update-subscription-pause","metadata":{"seo":{"title":"Update subscription pause","description":"By using this method, merchants can modify the existing pause schedule, including the possibility of adjusting the start and end dates of the pause period."}},"httpPath":"/subscriptions/{subscription_id}/pause-schedule","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Remove subscription pause","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/delete-subscription-pause","routeSlug":"/api/manage-subscriptions/delete-subscription-pause","metadata":{"seo":{"title":"Remove subscription pause","description":"This method provides a way to delete the scheduled pause, reverting the subscription to its previous active state or as specified."}},"httpPath":"/subscriptions/{subscription_id}/pause-schedule","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Cancel subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/cancel-subscription","routeSlug":"/api/manage-subscriptions/cancel-subscription","metadata":{"seo":{"title":"Cancel subscription","description":"By using this method, merchants can cancel the specific subscription by its subscription identifier."}},"httpPath":"/subscription/cancel","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Cancel subscriptions by customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/cancel-subscriptions-by-customer","routeSlug":"/api/manage-subscriptions/cancel-subscriptions-by-customer","metadata":{"seo":{"title":"Cancel subscriptions by customer","description":"By using this method, the merchant can cancel all subscriptions for the specific customer."}},"httpPath":"/subscription/cancel-by-customer","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Restore subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-subscriptions/restore-subscription","routeSlug":"/api/manage-subscriptions/restore-subscription","metadata":{"seo":{"title":"Restore subscription","description":"By using this method, merchants can restore the specific subscription of their customer in case it was cancelled."}},"httpPath":"/subscription/restore","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Subscription payment updates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/manage-subscriptions/webhook-subscription-status","routeSlug":"/api/manage-subscriptions/webhook-subscription-status","metadata":{"seo":{"title":"Subscription payment updates","description":"Webhooks for subscription status provide real-time notifications about changes in subscription status."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"Billing","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Retrieve subscription data","link":"/api/retrieve-subscription-data","routeSlug":"/api/retrieve-subscription-data","items":[{"label":"Get subscription status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/retrieve-subscription-data/get-subscription-status","routeSlug":"/api/retrieve-subscription-data/get-subscription-status","metadata":{"seo":{"title":"Get subscription status","description":"By using this method, merchants can retrieve subscription data by subscription identifier and obtain its details, such as the start date, status, and the information about the most recent invoice related to the subscription."}},"httpPath":"/subscription/status","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Retrieve subscriptions by customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/retrieve-subscription-data/retrieve-subscriptions-by-customer","routeSlug":"/api/retrieve-subscription-data/retrieve-subscriptions-by-customer","metadata":{"seo":{"title":"Retrieve subscriptions by customer","description":"This method allows the merchant to retrieve all subscriptions and their statuses for the specific customer by the customer identifier."}},"httpPath":"/subscription/list","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"List invoices by subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/retrieve-subscription-data/list-invoices-by-subscription-id","routeSlug":"/api/retrieve-subscription-data/list-invoices-by-subscription-id","metadata":{"seo":{"title":"List invoices by subscription","description":"By using this method, merchants can get a list of invoices related to a specific subscription."}},"httpPath":"/subscription/invoice/list","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"List orders by invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/retrieve-subscription-data/list-orders-by-invoice-id","routeSlug":"/api/retrieve-subscription-data/list-orders-by-invoice-id","metadata":{"seo":{"title":"List orders by invoice","description":"By using this method, merchants can retrieve a list of orders associated with a particular invoice."}},"httpPath":"/subscription/order/list","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Risks","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Fraud prevention","link":"/api/fraud-prevention","routeSlug":"/api/fraud-prevention","items":[{"label":"Create fraud prevention list items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fraud-prevention/fraud-prevention-list-items-create","routeSlug":"/api/fraud-prevention/fraud-prevention-list-items-create","metadata":{"seo":{"title":"Create fraud prevention list items","description":"This method allows you to add new items to fraud prevention list linked to the merchant's account."}},"httpPath":"/fraud-prevention-list-items/create","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"List fraud prevention list items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fraud-prevention/fraud-prevention-list-items-list","routeSlug":"/api/fraud-prevention/fraud-prevention-list-items-list","metadata":{"seo":{"title":"List fraud prevention list items","description":"This method retrieves existing fraud prevention list items linked to the merchant's account."}},"httpPath":"/fraud-prevention-list-items/list","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Delete fraud prevention list item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fraud-prevention/fraud-prevention-list-items-delete","routeSlug":"/api/fraud-prevention/fraud-prevention-list-items-delete","metadata":{"seo":{"title":"Delete fraud prevention list item","description":"This method allows you to delete an existing fraud prevention list item linked to the merchant's account."}},"httpPath":"/fraud-prevention-list-items/{id}","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Dispute representment","link":"/api/dispute-representment","routeSlug":"/api/dispute-representment","items":[{"label":"Create dispute representment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/dispute-representment/dispute-representments-create","routeSlug":"/api/dispute-representment/dispute-representments-create","metadata":{"seo":{"title":"Create dispute representment","description":"This method allows you to initiate a dispute representment case with associated evidence files."}},"httpPath":"/dispute-representments/create","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Enrich dispute representment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/dispute-representment/dispute-representments-enrich","routeSlug":"/api/dispute-representment/dispute-representments-enrich","metadata":{"seo":{"title":"Enrich dispute representment","description":"This method allows you to enrich dispute representment with additional content."}},"httpPath":"/dispute-representments/enrich","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Checkout solutions","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Payment page","link":"/api/payment-page","routeSlug":"/api/payment-page","items":[{"label":"Create page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-page/create-payment-page","routeSlug":"/api/payment-page/create-payment-page","metadata":{"seo":{"title":"Create page","description":"Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under 120 attempts.
"}},"httpPath":"/init","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Deactivate page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-page/deactivate-payment-page","routeSlug":"/api/payment-page/deactivate-payment-page","metadata":{"seo":{"title":"Deactivate page","description":"Deactivate an active payment page to prevent further use."}},"httpPath":"/deactivate","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Payment link","link":"/api/payment-link","routeSlug":"/api/payment-link","items":[{"label":"Create link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-link/create-payment-link","routeSlug":"/api/payment-link/create-payment-link","metadata":{"seo":{"title":"Create link","description":"Payment links are code-free and reusable, allowing you to share them as many times as needed."}},"httpPath":"/link/init","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Deactivate link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-link/deactivate-payment-link","routeSlug":"/api/payment-link/deactivate-payment-link","metadata":{"seo":{"title":"Deactivate link","description":"Deactivate an active payment link to prevent further use."}},"httpPath":"/link/deactivate","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Manage webhooks","link":"/api/manage-webhooks","routeSlug":"/api/manage-webhooks","items":[{"label":"Create webhook endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-webhooks/webhook-endpoint-create","routeSlug":"/api/manage-webhooks/webhook-endpoint-create","metadata":{"seo":{"title":"Create webhook endpoint","description":"This method allows you to configure a webhook endpoint to receive specified events."}},"httpPath":"/webhooks/endpoints","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"List webhook endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-webhooks/webhook-endpoint-list","routeSlug":"/api/manage-webhooks/webhook-endpoint-list","metadata":{"seo":{"title":"List webhook endpoints","description":"This method retrieves a list of your previously created webhook endpoints."}},"httpPath":"/webhooks/endpoints","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Update webhook endpoint","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-webhooks/webhook-endpoint-update","routeSlug":"/api/manage-webhooks/webhook-endpoint-update","metadata":{"seo":{"title":"Update webhook endpoint","description":"This method allows you to update an existing webhook endpoint. For that, you need to provide the endpoint identifier and the new configuration."}},"httpPath":"/webhooks/endpoints/{id}","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Delete webhook endpoint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/manage-webhooks/webhook-endpoint-delete","routeSlug":"/api/manage-webhooks/webhook-endpoint-delete","metadata":{"seo":{"title":"Delete webhook endpoint","description":"This method allows you to delete an existing webhook endpoint. For that, you need to provide the endpoint identifier you want to delete."}},"httpPath":"/webhooks/endpoints/{id}","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Reporting","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Reports","link":"/api/reports","routeSlug":"/api/reports","items":[{"label":"Card orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-card-orders","routeSlug":"/api/reports/retrieve-card-orders","metadata":{"seo":{"title":"Card orders","description":"The report provides essential data for merchants, including transaction details, customer information, and technical insights, facilitating comprehensive order tracking, financial reconciliation, and enhanced operational and marketing strategies."}},"httpPath":"/card-orders","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"APM orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-apm-orders","routeSlug":"/api/reports/retrieve-apm-orders","metadata":{"seo":{"title":"APM orders","description":"The report is essential for merchants using alternative payment methods, offering comprehensive transaction details, including order IDs, statuses, amounts, customer information, crucial for a complete understanding of APM transaction dynamics."}},"httpPath":"/apm-orders","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Subscriptions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-subscriptions","routeSlug":"/api/reports/retrieve-subscriptions","metadata":{"seo":{"title":"Subscriptions","description":"The report offers a comprehensive overview for merchants, detailing customer subscriptions, payment methods, key customer data, and associated invoices, which are important for managing recurring revenues, customer retention, and informed decision-making in subscription-based businesses."}},"httpPath":"/subscriptions","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Chargebacks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-card-chargebacks","routeSlug":"/api/reports/retrieve-card-chargebacks","metadata":{"seo":{"title":"Chargebacks","description":"The report is essential for merchants, providing exhaustive insights into each chargeback, including identifiers, dates, types, amounts, reasons, and related original order details, which is crucial for understanding chargeback patterns, enhancing dispute resolution, and fraud prevention."}},"httpPath":"/card-orders/chargebacks","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"PayPal disputes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-apm-paypal-disputes","routeSlug":"/api/reports/retrieve-apm-paypal-disputes","metadata":{"seo":{"title":"PayPal disputes","description":"The report is crucial, offering detailed insights on each PayPal dispute and lifecycle stage. These details are essential for effective dispute management and enhancing customer satisfaction."}},"httpPath":"/apm-orders/paypal-disputes","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Prevention alerts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/prevention-alerts-by-date","routeSlug":"/api/reports/prevention-alerts-by-date","metadata":{"seo":{"title":"Prevention alerts","description":"The report retrieves data to identify and resolve potential issues, thereby preventing the generation of alerts."}},"httpPath":"/prevention_alerts","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Download prevention alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/download-prevention-alerts","routeSlug":"/api/reports/download-prevention-alerts","metadata":{"seo":{"title":"Download prevention alerts","description":"The report offering detailed information on prevention alerts. It provides insights into each alert, including unique identifiers, alert types, amounts, outcomes, and the alert generation timeline."}},"httpPath":"/prevention_alerts/report/{report_id}/download","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Card fraud alerts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/retrieve-card-fraud-alerts","routeSlug":"/api/reports/retrieve-card-fraud-alerts","metadata":{"seo":{"title":"Card fraud alerts","description":"The report is vital for merchants, providing detailed fraud-related information such as order IDs, amounts, and timings, along with specific fraud types and reason codes, crucial for swiftly identifying, analyzing, and formulating effective strategies to enhance transaction security."}},"httpPath":"/card-orders/fraud-alerts","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Financial entries by date range","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/financial-entries-by-date","routeSlug":"/api/reports/financial-entries-by-date","metadata":{"seo":{"title":"Financial entries by date range","description":"In a successful response, you will receive a link to the file report_url."}},"httpPath":"/financial_entries","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Download financial entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/download-financial-entries","routeSlug":"/api/reports/download-financial-entries","metadata":{"seo":{"title":"Download financial entries","description":"The report offers an extensive overview of financial transactions, detailing financial record IDs, order and transaction IDs, dates, amounts, currencies, payment methods, and geographical data essential for comprehensive financial analysis and management."}},"httpPath":"/financial_entries/report/{report_id}/download","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Routing events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/routing-events-by-date","routeSlug":"/api/reports/routing-events-by-date","metadata":{"seo":{"title":"Routing events","description":"The report provides a comprehensive view of routing decisions and execution flow for orders processed through routing configurations."}},"httpPath":"/routing/events","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"label":"Download routing events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/reports/download-routing-events","routeSlug":"/api/reports/download-routing-events","metadata":{"seo":{"title":"Download routing events","description":"The report offers detailed information on routing events. It provides insights into each event, including unique identifiers, configuration and version, route and step details, 3DS decisions, and connector account selected for processing."}},"httpPath":"/routing/events/report/{report_id}/download","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","label":"Files","version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"group","label":"Files upload","link":"/api/files-upload","routeSlug":"/api/files-upload","items":[{"label":"Create file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files-upload/create-upload-url","routeSlug":"/api/files-upload/create-upload-url","metadata":{"seo":{"title":"Create file","description":"This method allows to create a file upload request by generating a unique file_id to reference the file."}},"httpPath":"/file/get-upload-url","version":"v1","isDefault":true,"versionFolderId":"702acf7c"}],"version":"v1","isDefault":true,"versionFolderId":"702acf7c"},{"type":"separator","version":"v1","versionFolderId":"702acf7c","separatorLine":true},{"type":"link","fsPath":"api/@v2/get-started.md","metadata":{"type":"markdown"},"label":"Get started","link":"/api/v2/get-started","routeSlug":"/api/v2/get-started","icon":"/assets/get-started.8c0a38f41e67eea02a59551e0f5f9283833d302e716a3628a925c4679b4ea2c9.9c1bb791.svg","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"link","label":"Solidgate API Reference","link":"/api/v2","routeSlug":"/api/v2","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Integration","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"API keys","link":"/api/v2/api-keys","routeSlug":"/api/v2/api-keys","items":[{"label":"Create API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/api-keys/create-api-key","routeSlug":"/api/v2/api-keys/create-api-key","metadata":{"seo":{"title":"Create API key","description":"Creates a new API key for authentication and authorization. This endpoint requires an account-level API key."}},"httpPath":"/api-keys/create","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List API keys","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/api-keys/list-api-key","routeSlug":"/api/v2/api-keys/list-api-key","metadata":{"seo":{"title":"List API keys","description":"Retrieves a paginated list of API keys for the specified account. This endpoint requires an account-level API key."}},"httpPath":"/api-keys/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/api-keys/get-api-key","routeSlug":"/api/v2/api-keys/get-api-key","metadata":{"seo":{"title":"Get API key","description":"Returns details and permissions for the specified API key. This endpoint requires an account-level API key."}},"httpPath":"/api-keys/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Rotate API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/api-keys/rotate-api-key","routeSlug":"/api/v2/api-keys/rotate-api-key","metadata":{"seo":{"title":"Rotate API key","description":"Rotates the secret key for the specified API key. Returns a new secret in the rotate_secret field, which becomes valid within a few seconds. The previous secret remains valid during the rotation period and expires once the period ends. This endpoint requires an account-level API key."}},"httpPath":"/api-keys/rotate","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Channels","link":"/api/v2/channels","routeSlug":"/api/v2/channels","items":[{"label":"List channels","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/channels/list-channel","routeSlug":"/api/v2/channels/list-channel","metadata":{"seo":{"title":"List channels","description":"Retrieves a paginated list of channels for the specified account. This endpoint requires an account-level API key."}},"httpPath":"/channels/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Legal entities","link":"/api/v2/legal-entities","routeSlug":"/api/v2/legal-entities","items":[{"label":"List legal entities","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/legal-entities/list-legal-entities","routeSlug":"/api/v2/legal-entities/list-legal-entities","metadata":{"seo":{"title":"List legal entities","description":"Retrieves a paginated list of legal entities registered under your account. This endpoint requires an account-level API key."}},"httpPath":"/legal-entities/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get legal entity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/legal-entities/get-legal-entity","routeSlug":"/api/v2/legal-entities/get-legal-entity","metadata":{"seo":{"title":"Get legal entity","description":"Retrieves details for the specified legal entity registered under your account. This endpoint requires an account-level API key."}},"httpPath":"/legal-entities/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Webhooks","link":"/api/v2/webhooks","routeSlug":"/api/v2/webhooks","items":[{"label":"Create webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/webhooks/create-webhook","routeSlug":"/api/v2/webhooks/create-webhook","metadata":{"seo":{"title":"Create webhook","description":"Creates a new webhook endpoint to receive payment and order events. Webhook endpoints are inactive until activated by calling the patch endpoint with the status set to ACTIVE."}},"httpPath":"/webhooks/create","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List webhooks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/webhooks/list-webhook","routeSlug":"/api/v2/webhooks/list-webhook","metadata":{"seo":{"title":"List webhooks","description":"Retrieves a paginated list of webhook endpoints."}},"httpPath":"/webhooks/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/webhooks/get-webhook","routeSlug":"/api/v2/webhooks/get-webhook","metadata":{"seo":{"title":"Get webhook","description":"Retrieves webhook endpoint details by ID."}},"httpPath":"/webhooks/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Patch webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/webhooks/patch-webhook","routeSlug":"/api/v2/webhooks/patch-webhook","metadata":{"seo":{"title":"Patch webhook","description":"Updates an existing webhook endpoint configuration."}},"httpPath":"/webhooks/patch","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Delete webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/webhooks/delete-webhook","routeSlug":"/api/v2/webhooks/delete-webhook","metadata":{"seo":{"title":"Delete webhook","description":"Deletes a webhook endpoint."}},"httpPath":"/webhooks/delete","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Rotate webhook key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/webhooks/rotate-webhook-key","routeSlug":"/api/v2/webhooks/rotate-webhook-key","metadata":{"seo":{"title":"Rotate webhook key","description":"Rotates the secret for the specified webhook key. Returns a new secret in the rotate_secret field, which becomes valid within a few seconds. The previous secret remains valid during the rotation period and expires once the period ends."}},"httpPath":"/webhooks/rotate-key","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Customers","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Customers","link":"/api/v2/customers","routeSlug":"/api/v2/customers","items":[{"label":"Create customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/customers/create-customer","routeSlug":"/api/v2/customers/create-customer","metadata":{"seo":{"title":"Create customer","description":"Creates a new customer."}},"httpPath":"/customers/create","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Update customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/customers/update-customer","routeSlug":"/api/v2/customers/update-customer","metadata":{"seo":{"title":"Update customer","description":"Updates specified customer fields."}},"httpPath":"/customers/update","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/customers/get-customer","routeSlug":"/api/v2/customers/get-customer","metadata":{"seo":{"title":"Get customer","description":"Returns the customer for the provided identifier."}},"httpPath":"/customers/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List customers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/customers/list-customers","routeSlug":"/api/v2/customers/list-customers","metadata":{"seo":{"title":"List customers","description":"Returns a paginated list of customers."}},"httpPath":"/customers/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Customer created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/customers/on-customer-created","routeSlug":"/api/v2/customers/on-customer-created","metadata":{"seo":{"title":"Customer created","description":"Webhook sent when a new customer is created."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"CustomerCreated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Customer updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/customers/on-customer-updated","routeSlug":"/api/v2/customers/on-customer-updated","metadata":{"seo":{"title":"Customer updated","description":"Webhook sent when a customer is updated."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"CustomerUpdated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Payment instruments","link":"/api/v2/payment-instruments","routeSlug":"/api/v2/payment-instruments","items":[{"label":"Get payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/payment-instruments/get-payment-instrument","routeSlug":"/api/v2/payment-instruments/get-payment-instrument","metadata":{"seo":{"title":"Get payment instrument","description":"Returns the payment instrument for the provided identifier."}},"httpPath":"/payment-instruments/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List payment instruments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/payment-instruments/list-payment-instruments","routeSlug":"/api/v2/payment-instruments/list-payment-instruments","metadata":{"seo":{"title":"List payment instruments","description":"Returns a paginated list of payment instruments for the specified customer."}},"httpPath":"/payment-instruments/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Revoke payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/payment-instruments/revoke-payment-instrument","routeSlug":"/api/v2/payment-instruments/revoke-payment-instrument","metadata":{"seo":{"title":"Revoke payment instrument","description":"Revokes an active payment instrument and prevents it from being used for future payments."}},"httpPath":"/payment-instruments/revoke","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Payment instrument created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/payment-instruments/on-payment-instrument-created","routeSlug":"/api/v2/payment-instruments/on-payment-instrument-created","metadata":{"seo":{"title":"Payment instrument created","description":"Webhook sent when a new payment instrument is created."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"PaymentInstrumentCreated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Payment instrument revoked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/payment-instruments/on-payment-instrument-revoked","routeSlug":"/api/v2/payment-instruments/on-payment-instrument-revoked","metadata":{"seo":{"title":"Payment instrument revoked","description":"Webhook sent when a payment instrument is revoked."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"PaymentInstrumentRevoked","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Payment instrument expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/payment-instruments/on-payment-instrument-expired","routeSlug":"/api/v2/payment-instruments/on-payment-instrument-expired","metadata":{"seo":{"title":"Payment instrument expired","description":"Webhook sent when a payment instrument expires."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"PaymentInstrumentExpired","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Billing","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Invoices","link":"/api/v2/invoices","routeSlug":"/api/v2/invoices","items":[{"label":"Create invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/invoices/create-invoice","routeSlug":"/api/v2/invoices/create-invoice","metadata":{"seo":{"title":"Create invoice","description":"Creates a new invoice."}},"httpPath":"/invoices/create","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Update invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/invoices/update-invoice","routeSlug":"/api/v2/invoices/update-invoice","metadata":{"seo":{"title":"Update invoice","description":"Updates specified fields of a draft invoice."}},"httpPath":"/invoices/update","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Finalize invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/invoices/finalize-invoice","routeSlug":"/api/v2/invoices/finalize-invoice","metadata":{"seo":{"title":"Finalize invoice","description":"Finalizes a draft invoice."}},"httpPath":"/invoices/finalize","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Void invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/invoices/void-invoice","routeSlug":"/api/v2/invoices/void-invoice","metadata":{"seo":{"title":"Void invoice","description":"Voids an unpaid invoice."}},"httpPath":"/invoices/void","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Delete invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/invoices/delete-invoice","routeSlug":"/api/v2/invoices/delete-invoice","metadata":{"seo":{"title":"Delete invoice","description":"Deletes a draft invoice."}},"httpPath":"/invoices/delete","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/invoices/get-invoice","routeSlug":"/api/v2/invoices/get-invoice","metadata":{"seo":{"title":"Get invoice","description":"Returns the invoice for the provided identifier."}},"httpPath":"/invoices/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List invoices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/invoices/list-invoices","routeSlug":"/api/v2/invoices/list-invoices","metadata":{"seo":{"title":"List invoices","description":"Returns a paginated list of invoices."}},"httpPath":"/invoices/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Pay invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/invoices/pay-invoice","routeSlug":"/api/v2/invoices/pay-invoice","metadata":{"seo":{"title":"Pay invoice","description":"Pays a finalized invoice using a saved payment instrument."}},"httpPath":"/invoices/pay","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-created","routeSlug":"/api/v2/invoices/on-invoice-created","metadata":{"seo":{"title":"Invoice created","description":"Webhook sent when a new invoice is created."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoiceCreated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-updated","routeSlug":"/api/v2/invoices/on-invoice-updated","metadata":{"seo":{"title":"Invoice updated","description":"Webhook sent when an invoice is updated."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoiceUpdated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice finalized","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-finalized","routeSlug":"/api/v2/invoices/on-invoice-finalized","metadata":{"seo":{"title":"Invoice finalized","description":"Webhook sent when an invoice is finalized."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoiceFinalized","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice finalization failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-finalization-failed","routeSlug":"/api/v2/invoices/on-invoice-finalization-failed","metadata":{"seo":{"title":"Invoice finalization failed","description":"Webhook sent when an invoice finalization fails."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoiceFinalizationFailed","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-paid","routeSlug":"/api/v2/invoices/on-invoice-paid","metadata":{"seo":{"title":"Invoice paid","description":"Webhook sent when an invoice is paid."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoicePaid","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice voided","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-voided","routeSlug":"/api/v2/invoices/on-invoice-voided","metadata":{"seo":{"title":"Invoice voided","description":"Webhook sent when an invoice is voided."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoiceVoided","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice deleted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-deleted","routeSlug":"/api/v2/invoices/on-invoice-deleted","metadata":{"seo":{"title":"Invoice deleted","description":"Webhook sent when an invoice is deleted."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoiceDeleted","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice payment failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-payment-failed","routeSlug":"/api/v2/invoices/on-invoice-payment-failed","metadata":{"seo":{"title":"Invoice payment failed","description":"Webhook sent when an invoice payment fails."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoicePaymentFailed","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice payment refunded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-payment-refunded","routeSlug":"/api/v2/invoices/on-invoice-payment-refunded","metadata":{"seo":{"title":"Invoice payment refunded","description":"Webhook sent when an invoice payment is refunded."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoicePaymentRefunded","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice dunning started","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-dunning-started","routeSlug":"/api/v2/invoices/on-invoice-dunning-started","metadata":{"seo":{"title":"Invoice dunning started","description":"Webhook sent when an invoice enters the dunning process."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoiceDunningStarted","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Invoice unpaid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/invoices/on-invoice-unpaid","routeSlug":"/api/v2/invoices/on-invoice-unpaid","metadata":{"seo":{"title":"Invoice unpaid","description":"Webhook sent when an invoice becomes unpaid."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"InvoiceUnpaid","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Subscriptions","link":"/api/v2/subscriptions","routeSlug":"/api/v2/subscriptions","items":[{"label":"Create subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/subscriptions/create-subscription","routeSlug":"/api/v2/subscriptions/create-subscription","metadata":{"seo":{"title":"Create subscription","description":"Creates a new subscription."}},"httpPath":"/subscriptions/create","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/subscriptions/get-subscription","routeSlug":"/api/v2/subscriptions/get-subscription","metadata":{"seo":{"title":"Get subscription","description":"Returns the subscription for the provided identifier."}},"httpPath":"/subscriptions/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List subscriptions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/subscriptions/list-subscriptions","routeSlug":"/api/v2/subscriptions/list-subscriptions","metadata":{"seo":{"title":"List subscriptions","description":"Returns a paginated list of subscriptions."}},"httpPath":"/subscriptions/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Cancel subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/subscriptions/cancel-subscription","routeSlug":"/api/v2/subscriptions/cancel-subscription","metadata":{"seo":{"title":"Cancel subscription","description":"Cancels the subscription immediately or schedules cancellation for the end of the current billing period."}},"httpPath":"/subscriptions/cancel","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Delete subscription cancellation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/subscriptions/delete-subscription-cancellation","routeSlug":"/api/v2/subscriptions/delete-subscription-cancellation","metadata":{"seo":{"title":"Delete subscription cancellation","description":"Removes the cancellation scheduled for the end of the current billing period by the subscription cancel operation with mode PERIOD_END, keeping the subscription active."}},"httpPath":"/subscriptions/delete-cancellation","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Update subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/subscriptions/update-subscription","routeSlug":"/api/v2/subscriptions/update-subscription","metadata":{"seo":{"title":"Update subscription","description":"Applies targeted updates to an active subscription, including updating the payment instrument, discount, description, and metadata, ending a trial period, and managing line items. For example, trial end uses an explicit mode, and line items are managed by adding, updating, and removing entries instead of full replacement. Each update is applied only when its corresponding field is present in the request."}},"httpPath":"/subscriptions/update","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Subscription created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/subscriptions/on-subscription-created","routeSlug":"/api/v2/subscriptions/on-subscription-created","metadata":{"seo":{"title":"Subscription created","description":"Webhook sent when a new subscription is created."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"SubscriptionCreated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Subscription updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/subscriptions/on-subscription-updated","routeSlug":"/api/v2/subscriptions/on-subscription-updated","metadata":{"seo":{"title":"Subscription updated","description":"Webhook sent when a subscription is updated."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"SubscriptionUpdated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Subscription scheduled for cancellation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/subscriptions/on-subscription-scheduled-for-cancellation","routeSlug":"/api/v2/subscriptions/on-subscription-scheduled-for-cancellation","metadata":{"seo":{"title":"Subscription scheduled for cancellation","description":"Webhook sent when a subscription is scheduled for cancellation."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"SubscriptionScheduledForCancellation","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Subscription cancelled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/subscriptions/on-subscription-cancelled","routeSlug":"/api/v2/subscriptions/on-subscription-cancelled","metadata":{"seo":{"title":"Subscription cancelled","description":"Webhook sent when a subscription is cancelled."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"SubscriptionCancelled","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Subscription trial activated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/subscriptions/on-subscription-trial-activated","routeSlug":"/api/v2/subscriptions/on-subscription-trial-activated","metadata":{"seo":{"title":"Subscription trial activated","description":"Webhook sent when a subscription trial is activated."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"SubscriptionTrialActivated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Subscription activated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/subscriptions/on-subscription-activated","routeSlug":"/api/v2/subscriptions/on-subscription-activated","metadata":{"seo":{"title":"Subscription activated","description":"Webhook sent when a subscription is activated."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"SubscriptionActivated","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Subscription expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/subscriptions/on-subscription-expired","routeSlug":"/api/v2/subscriptions/on-subscription-expired","metadata":{"seo":{"title":"Subscription expired","description":"Webhook sent when a subscription expires."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"SubscriptionExpired","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Risks","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Antifraud lists","link":"/api/v2/antifraud-lists","routeSlug":"/api/v2/antifraud-lists","items":[{"label":"Create antifraud list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/antifraud-lists/create-antifraud-list","routeSlug":"/api/v2/antifraud-lists/create-antifraud-list","metadata":{"seo":{"title":"Create antifraud list","description":"Creates a new antifraud list."}},"httpPath":"/antifraud-lists/create","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Update antifraud list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/antifraud-lists/update-antifraud-list","routeSlug":"/api/v2/antifraud-lists/update-antifraud-list","metadata":{"seo":{"title":"Update antifraud list","description":"Updates the antifraud list."}},"httpPath":"/antifraud-lists/update","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List antifraud lists","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/antifraud-lists/list-antifraud-list","routeSlug":"/api/v2/antifraud-lists/list-antifraud-list","metadata":{"seo":{"title":"List antifraud lists","description":"Retrieves a paginated list of antifraud lists."}},"httpPath":"/antifraud-lists/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get antifraud list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/antifraud-lists/get-antifraud-list","routeSlug":"/api/v2/antifraud-lists/get-antifraud-list","metadata":{"seo":{"title":"Get antifraud list","description":"Returns the antifraud list for the provided identifier."}},"httpPath":"/antifraud-lists/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Create antifraud list item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/antifraud-lists/create-item-antifraud-list","routeSlug":"/api/v2/antifraud-lists/create-item-antifraud-list","metadata":{"seo":{"title":"Create antifraud list item","description":"Creates a new antifraud list item."}},"httpPath":"/antifraud-lists/create-item","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Delete antifraud list item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/antifraud-lists/delete-item-antifraud-list","routeSlug":"/api/v2/antifraud-lists/delete-item-antifraud-list","metadata":{"seo":{"title":"Delete antifraud list item","description":"Deletes the antifraud list item for the provided identifier."}},"httpPath":"/antifraud-lists/delete-item","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List antifraud list items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/antifraud-lists/list-item-antifraud-list","routeSlug":"/api/v2/antifraud-lists/list-item-antifraud-list","metadata":{"seo":{"title":"List antifraud list items","description":"Retrieves a paginated list of antifraud list items."}},"httpPath":"/antifraud-lists/list-item","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Fraud alerts","link":"/api/v2/fraud-alerts","routeSlug":"/api/v2/fraud-alerts","items":[{"label":"Fraud alert received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/fraud-alerts/on-fraud-alert-received","routeSlug":"/api/v2/fraud-alerts/on-fraud-alert-received","metadata":{"seo":{"title":"Fraud alert received","description":"Webhook sent when a fraud alert is received for a payment."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"FraudAlertReceived","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Prevention alerts","link":"/api/v2/prevention-alerts","routeSlug":"/api/v2/prevention-alerts","items":[{"label":"Prevention alert received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/prevention-alerts/on-prevention-alert-received","routeSlug":"/api/v2/prevention-alerts/on-prevention-alert-received","metadata":{"seo":{"title":"Prevention alert received","description":"Webhook sent when a prevention alert is received for a payment."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"PreventionAlertReceived","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Orchestration","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Routing","link":"/api/v2/routing","routeSlug":"/api/v2/routing","items":[{"label":"Get routing configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/routing/get-routing-config","routeSlug":"/api/v2/routing/get-routing-config","metadata":{"seo":{"title":"Get routing configuration","description":"Returns the routing configuration for the provided identifier."}},"httpPath":"/routing-configs/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get routing configuration version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/routing/get-routing-config-version","routeSlug":"/api/v2/routing/get-routing-config-version","metadata":{"seo":{"title":"Get routing configuration version","description":"Returns the routing configuration version with the full route tree for the provided identifier."}},"httpPath":"/routing-configs/get-version","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List routing configurations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/routing/list-routing-configs","routeSlug":"/api/v2/routing/list-routing-configs","metadata":{"seo":{"title":"List routing configurations","description":"Returns a paginated list of routing configurations."}},"httpPath":"/routing-configs/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Webhooks","variant":"secondary","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Routing configuration version published","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/v2/routing/on-routing-config-version-published","routeSlug":"/api/v2/routing/on-routing-config-version-published","metadata":{"seo":{"title":"Routing configuration version published","description":"Webhook sent when a new routing configuration version is published."}},"badges":[{"name":"Event","color":"purple"}],"httpPath":"RoutingConfigVersionPublished","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Finance","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Settlements","link":"/api/v2/settlements","routeSlug":"/api/v2/settlements","items":[{"label":"List settlements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/settlements/list-settlements","routeSlug":"/api/v2/settlements/list-settlements","metadata":{"seo":{"title":"List settlements","description":"Retrieves a paginated list of settlements. This endpoint requires an account-level API key."}},"httpPath":"/settlements/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Get settlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/settlements/get-settlement","routeSlug":"/api/v2/settlements/get-settlement","metadata":{"seo":{"title":"Get settlement","description":"Retrieves details for the specified settlement. This endpoint requires an account-level API key."}},"httpPath":"/settlements/get","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","label":"Reports","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"group","label":"Reports","link":"/api/v2/reports","routeSlug":"/api/v2/reports","items":[{"label":"Create report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/reports/create-report","routeSlug":"/api/v2/reports/create-report","metadata":{"seo":{"title":"Create report","description":"Creates a report for the specified date range. The report is processed asynchronously. Once processing completes, use the returned id to download it."}},"httpPath":"/reports/create","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"Download report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/reports/download-report","routeSlug":"/api/v2/reports/download-report","metadata":{"seo":{"title":"Download report","description":"Returns a 303 redirect to a short-lived download URL."}},"httpPath":"/reports/download","version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"label":"List reports","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v2/reports/list-reports","routeSlug":"/api/v2/reports/list-reports","metadata":{"seo":{"title":"List reports","description":"Returns reports available to the current API key, sorted by creation date (newest first). The response includes only report types the API key has access to. Supports cursor-based pagination."}},"httpPath":"/reports/list","version":"v2","isDefault":false,"versionFolderId":"702acf7c"}],"version":"v2","isDefault":false,"versionFolderId":"702acf7c"},{"type":"separator","version":"v2","versionFolderId":"702acf7c","separatorLine":true}]}Please note that the payment page link expires in 24 hours.