{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/","routeSlug":"/"},{"type":"group","label":"Getting Started","items":[{"type":"link","fsPath":"onboarding.md","metadata":{"type":"markdown"},"label":"User Registration & Onboarding Guide","link":"/onboarding","routeSlug":"/onboarding"},{"type":"link","fsPath":"dashboardOverview.md","metadata":{"type":"markdown"},"label":"Dashboard Overview","link":"/dashboardoverview","routeSlug":"/dashboardoverview"},{"type":"link","fsPath":"entities.md","metadata":{"type":"markdown"},"label":"Entities Overview","link":"/entities","routeSlug":"/entities"},{"type":"link","fsPath":"createAccount.md","metadata":{"type":"markdown"},"label":"Adding Account","link":"/createaccount","routeSlug":"/createaccount"}]},{"type":"group","label":"Using Chaching","items":[{"type":"group","fsPath":"Using Chaching/Customers/customers.md","metadata":{"type":"markdown"},"label":"Customers","link":"/using-chaching/customers/customers","routeSlug":"/using-chaching/customers/customers","items":[{"type":"link","fsPath":"Using Chaching/Customers/add-new-customer.md","metadata":{"type":"markdown"},"label":"Add New Customer","link":"/using-chaching/customers/add-new-customer","routeSlug":"/using-chaching/customers/add-new-customer"},{"type":"link","fsPath":"Using Chaching/Customers/update-customer.md","metadata":{"type":"markdown"},"label":"Update Customers","link":"/using-chaching/customers/update-customer","routeSlug":"/using-chaching/customers/update-customer"},{"type":"link","fsPath":"Using Chaching/Customers/view-customer-details.md","metadata":{"type":"markdown"},"label":"View Customer Details","link":"/using-chaching/customers/view-customer-details","routeSlug":"/using-chaching/customers/view-customer-details"},{"type":"link","fsPath":"Using Chaching/Customers/add-payment-method.md","metadata":{"type":"markdown"},"label":"Add Payment Method","link":"/using-chaching/customers/add-payment-method","routeSlug":"/using-chaching/customers/add-payment-method"},{"type":"link","fsPath":"Using Chaching/Customers/export-customers.md","metadata":{"type":"markdown"},"label":"Export Customers","link":"/using-chaching/customers/export-customers","routeSlug":"/using-chaching/customers/export-customers"}]},{"type":"group","fsPath":"Using Chaching/Subscriptions/Subscriptions.md","metadata":{"type":"markdown"},"label":"Subscriptions","link":"/using-chaching/subscriptions/subscriptions","routeSlug":"/using-chaching/subscriptions/subscriptions","items":[{"type":"link","fsPath":"Using Chaching/Subscriptions/View subscription details.md","metadata":{"type":"markdown"},"label":"View subscription details","link":"/using-chaching/subscriptions/view-subscription-details","routeSlug":"/using-chaching/subscriptions/view-subscription-details"},{"type":"link","fsPath":"Using Chaching/Subscriptions/failed-payments.md","metadata":{"type":"markdown"},"label":"Handle failed subscription payments","link":"/using-chaching/subscriptions/failed-payments","routeSlug":"/using-chaching/subscriptions/failed-payments"}]},{"type":"group","fsPath":"Using Chaching/Invoices/Invoices.md","metadata":{"type":"markdown"},"label":"Invoices","link":"/using-chaching/invoices/invoices","routeSlug":"/using-chaching/invoices/invoices","items":[{"type":"link","fsPath":"Using Chaching/Invoices/View invoices details.md","metadata":{"type":"markdown"},"label":"View invoices details","link":"/using-chaching/invoices/view-invoices-details","routeSlug":"/using-chaching/invoices/view-invoices-details"}]},{"type":"group","fsPath":"Using Chaching/Transactions/Transactions.md","metadata":{"type":"markdown"},"label":"Transactions","link":"/using-chaching/transactions/transactions","routeSlug":"/using-chaching/transactions/transactions","items":[{"type":"link","fsPath":"Using Chaching/Transactions/Transactions.md","metadata":{"type":"markdown"},"label":"Transactions","link":"/using-chaching/transactions/transactions","routeSlug":"/using-chaching/transactions/transactions"}]},{"type":"group","fsPath":"Using Chaching/Products/Products.md","metadata":{"type":"markdown"},"label":"Products","link":"/using-chaching/products/products","routeSlug":"/using-chaching/products/products","items":[{"type":"link","fsPath":"Using Chaching/Products/Products.md","metadata":{"type":"markdown"},"label":"Products","link":"/using-chaching/products/products","routeSlug":"/using-chaching/products/products"}]},{"type":"link","fsPath":"Using Chaching/Create a Payment/CreatePayment.md","metadata":{"type":"markdown"},"label":"Create a Payment","link":"/using-chaching/create-a-payment/createpayment","routeSlug":"/using-chaching/create-a-payment/createpayment"},{"type":"link","fsPath":"Using Chaching/Create an Invoice/CreateInvoice.md","metadata":{"type":"markdown"},"label":"Create an Invoice","link":"/using-chaching/create-an-invoice/createinvoice","routeSlug":"/using-chaching/create-an-invoice/createinvoice"},{"type":"link","fsPath":"Using Chaching/Create a Subscription/CreateSubscription.md","metadata":{"type":"markdown"},"label":"Create a Subscription","link":"/using-chaching/create-a-subscription/createsubscription","routeSlug":"/using-chaching/create-a-subscription/createsubscription"},{"type":"link","fsPath":"Using Chaching/Hosted Page/hostedPage.md","metadata":{"type":"markdown"},"label":"Using Hosted Checkout","link":"/using-chaching/hosted-page/hostedpage","routeSlug":"/using-chaching/hosted-page/hostedpage"}]},{"type":"group","label":"Developer Guide","items":[{"type":"link","label":"Chaching API","link":"/developer-guide/api","routeSlug":"/developer-guide/api"},{"type":"group","label":"Customers","link":"/developer-guide/api/customers","routeSlug":"/developer-guide/api/customers","items":[{"label":"Creates a new customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_create","routeSlug":"/developer-guide/api/customers/customerscontroller_create","metadata":{"seo":{"title":"Creates a new customer","description":"Creates a new customer for the authenticated account with the provided details."}},"httpPath":"/customers"},{"label":"Get paginated list of customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_getallbyaccount","routeSlug":"/developer-guide/api/customers/customerscontroller_getallbyaccount","metadata":{"seo":{"title":"Get paginated list of customers","description":"Retrieves a paginated list of customers associated with the authenticated account."}},"httpPath":"/customers"},{"label":"Search customers by name or email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_search","routeSlug":"/developer-guide/api/customers/customerscontroller_search","metadata":{"seo":{"title":"Search customers by name or email","description":"Searches for customers associated with the authenticated account based on a search string that matches their name or email."}},"httpPath":"/customers/search"},{"label":"Get customer details by External Key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_getdetails","routeSlug":"/developer-guide/api/customers/customerscontroller_getdetails","metadata":{"seo":{"title":"Get customer details by External Key","description":"Retrieves detailed information about a specific customer using their External Key."}},"httpPath":"/customers/{externalKey}"},{"label":"Update customer details by External Key","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_update","routeSlug":"/developer-guide/api/customers/customerscontroller_update","metadata":{"seo":{"title":"Update customer details by External Key","description":"Updates the details of a specific customer using their External Key and the provided update data."}},"httpPath":"/customers/{externalKey}"},{"label":"Delete a customer by External Key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_remove","routeSlug":"/developer-guide/api/customers/customerscontroller_remove","metadata":{"seo":{"title":"Delete a customer by External Key","description":"Deletes a specific customer associated with the authenticated account using their External Key."}},"httpPath":"/customers/{externalKey}"},{"label":"List customer payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_getpaymentmethods","routeSlug":"/developer-guide/api/customers/customerscontroller_getpaymentmethods","metadata":{"seo":{"title":"List customer payment methods","description":"Retrieves a paginated list of all payment methods associated with a specific customer."}},"httpPath":"/customers/{externalKey}/payment-methods"},{"label":"Get customer payment method details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/customers/customerscontroller_getpaymentmethod","routeSlug":"/developer-guide/api/customers/customerscontroller_getpaymentmethod","metadata":{"seo":{"title":"Get customer payment method details","description":"Retrieves detailed information about a specific payment method associated with a customer."}},"httpPath":"/customers/{externalKey}/payment-methods/{id}"}]},{"type":"group","label":"Products","link":"/developer-guide/api/products","routeSlug":"/developer-guide/api/products","items":[{"label":"Get tax codes with category names","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_gettaxescodes","routeSlug":"/developer-guide/api/products/productscontroller_gettaxescodes","metadata":{"seo":{"title":"Get tax codes with category names","description":"Retrieves a list of tax codes with their associated category names. Optionally filter by search term."}},"httpPath":"/products/taxCodes"},{"label":"List all products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_listallproducts","routeSlug":"/developer-guide/api/products/productscontroller_listallproducts","metadata":{"seo":{"title":"List all products","description":"Retrieves a paginated list of all products for the authenticated account. Supports pagination and search functionality."}},"httpPath":"/products"},{"label":"Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_createproduct","routeSlug":"/developer-guide/api/products/productscontroller_createproduct","metadata":{"seo":{"title":"Create a product","description":"Creates a new product with the specified details. The product name must be unique and follow specific naming conventions."}},"httpPath":"/products"},{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_retrieveproduct","routeSlug":"/developer-guide/api/products/productscontroller_retrieveproduct","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves details of a specific product by its unique identifier."}},"httpPath":"/products/{id}"},{"label":"Update a product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_updateproduct","routeSlug":"/developer-guide/api/products/productscontroller_updateproduct","metadata":{"seo":{"title":"Update a product","description":"Updates an existing product with the specified details. Only provided fields will be updated."}},"httpPath":"/products/{id}"},{"label":"Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/products/productscontroller_deleteproduct","routeSlug":"/developer-guide/api/products/productscontroller_deleteproduct","metadata":{"seo":{"title":"Delete a product","description":"Permanently deletes a product. This action cannot be undone."}},"httpPath":"/products/{id}"}]},{"type":"group","label":"Transactions","link":"/developer-guide/api/transactions","routeSlug":"/developer-guide/api/transactions","items":[{"label":"List all transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/transactions/transactionscontroller_gettransactions","routeSlug":"/developer-guide/api/transactions/transactionscontroller_gettransactions","metadata":{"seo":{"title":"List all transactions","description":"Retrieves a list of transactions for the current account, based on the authentication that was used to make the request."}},"httpPath":"/transactions"},{"label":"Retrieve a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/transactions/transactionscontroller_gettransaction","routeSlug":"/developer-guide/api/transactions/transactionscontroller_gettransaction","metadata":{"seo":{"title":"Retrieve a transaction","description":"Retrieves detailed information about a specific transaction for the current account, based on the authentication that was used to make the request."}},"httpPath":"/transactions/{id}"}]},{"type":"group","label":"Invoices","link":"/developer-guide/api/invoices","routeSlug":"/developer-guide/api/invoices","items":[{"label":"List all invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_listinvoices","routeSlug":"/developer-guide/api/invoices/invoicescontroller_listinvoices","metadata":{"seo":{"title":"List all invoices","description":"Retrieves a paginated list of all invoices for the authenticated account. Supports pagination and filtering."}},"httpPath":"/invoices"},{"label":"Create an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_createinvoice","routeSlug":"/developer-guide/api/invoices/invoicescontroller_createinvoice","metadata":{"seo":{"title":"Create an invoice","description":"Creates a new invoice for a customer. The invoice will include line items, pricing, taxes, and other billing information. The invoice will be in draft status until paid or committed."}},"httpPath":"/invoices"},{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_retrieveinvoice","routeSlug":"/developer-guide/api/invoices/invoicescontroller_retrieveinvoice","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves a specific invoice by its unique identifier, including all invoice details, line items, and payment information."}},"httpPath":"/invoices/{id}"},{"label":"Pay an invoice","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_payinvoice","routeSlug":"/developer-guide/api/invoices/invoicescontroller_payinvoice","metadata":{"seo":{"title":"Pay an invoice","description":"Pays an invoice. This action will attempt to charge the customer using the payment method on file and finalize the invoice."}},"httpPath":"/invoices/{id}"},{"label":"Void an invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_voidinvoice","routeSlug":"/developer-guide/api/invoices/invoicescontroller_voidinvoice","metadata":{"seo":{"title":"Void an invoice","description":"Voids a draft or open invoice. A voided invoice cannot be paid and is marked as cancelled. This action is irreversible."}},"httpPath":"/invoices/{id}"},{"label":"List invoice transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_gettransactions","routeSlug":"/developer-guide/api/invoices/invoicescontroller_gettransactions","metadata":{"seo":{"title":"List invoice transactions","description":"Retrieves a paginated list of all transactions associated with a specific invoice, including payment attempts, refunds, and adjustments."}},"httpPath":"/invoices/{id}/transactions"},{"label":"Retrieve invoice transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/invoices/invoicescontroller_gettransaction","routeSlug":"/developer-guide/api/invoices/invoicescontroller_gettransaction","metadata":{"seo":{"title":"Retrieve invoice transaction","description":"Retrieves detailed information about a specific transaction associated with an invoice."}},"httpPath":"/invoices/{id}/transactions/{transactionId}"}]},{"type":"group","label":"TaxRates","link":"/developer-guide/api/taxrates","routeSlug":"/developer-guide/api/taxrates","items":[{"label":"List all tax rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/taxrates/taxescontroller_findall","routeSlug":"/developer-guide/api/taxrates/taxescontroller_findall","metadata":{"seo":{"title":"List all tax rates","description":"Retrieves a paginated list of all tax rates for the authenticated account. Supports pagination and filtering."}},"httpPath":"/taxRates"},{"label":"Create a tax rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/taxrates/taxescontroller_createtaxrate","routeSlug":"/developer-guide/api/taxrates/taxescontroller_createtaxrate","metadata":{"seo":{"title":"Create a tax rate","description":"Creates a new tax rate for the authenticated account. Tax rates define the percentage of tax to be applied to transactions."}},"httpPath":"/taxRates"},{"label":"Retrieve a tax rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/taxrates/taxescontroller_retrievetaxrate","routeSlug":"/developer-guide/api/taxrates/taxescontroller_retrievetaxrate","metadata":{"seo":{"title":"Retrieve a tax rate","description":"Retrieves a specific tax rate by its unique identifier."}},"httpPath":"/taxRates/{id}"},{"label":"Update a tax rate","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/taxrates/taxescontroller_updatetaxrate","routeSlug":"/developer-guide/api/taxrates/taxescontroller_updatetaxrate","metadata":{"seo":{"title":"Update a tax rate","description":"Updates an existing tax rate by its unique identifier. Only the provided fields will be updated."}},"httpPath":"/taxRates/{id}"}]},{"type":"group","label":"Prices","link":"/developer-guide/api/prices","routeSlug":"/developer-guide/api/prices","items":[{"label":"List all prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_listallprices","routeSlug":"/developer-guide/api/prices/pricescontroller_listallprices","metadata":{"seo":{"title":"List all prices","description":"Retrieves a paginated list of all prices for the authenticated account. Supports pagination and search functionality."}},"httpPath":"/prices"},{"label":"Retrieve a price","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_retrieveprice","routeSlug":"/developer-guide/api/prices/pricescontroller_retrieveprice","metadata":{"seo":{"title":"Retrieve a price","description":"Retrieves details of a specific price by its unique identifier."}},"httpPath":"/prices/{id}"},{"label":"Create a price for a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_createprice","routeSlug":"/developer-guide/api/prices/pricescontroller_createprice","metadata":{"seo":{"title":"Create a price for a product","description":"Creates a new price for an existing product. The price can be one-time or recurring (subscription-based)."}},"httpPath":"/prices/{id}"},{"label":"Delete a price","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_deleteprice","routeSlug":"/developer-guide/api/prices/pricescontroller_deleteprice","metadata":{"seo":{"title":"Delete a price","description":"Permanently deletes a price that has never been billed. This action cannot be undone. A price is activated permanently the first time it is billed, Chaching exposes no endpoint that deactivates it, and an active price can therefore never be deleted: this endpoint answers 400 for it."}},"httpPath":"/prices/{id}"},{"label":"Update all details of a price","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_updateinactiveprice","routeSlug":"/developer-guide/api/prices/pricescontroller_updateinactiveprice","metadata":{"seo":{"title":"Update all details of a price","description":"Updates the currency, amount, type, recurring interval, tax behavior, and description of a price. When the price has at least one subscription attached, only the description is applied and every other field is left unchanged. This endpoint never changes the active status of the price, and the route name describes the state a price is normally in when a full update makes sense rather than a precondition this endpoint enforces."}},"httpPath":"/prices/{id}/inactive"},{"label":"Update the description of a price","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/prices/pricescontroller_updateactiveprice","routeSlug":"/developer-guide/api/prices/pricescontroller_updateactiveprice","metadata":{"seo":{"title":"Update the description of a price","description":"Updates only the customer-facing description of a price. No other field is modified, and this endpoint never changes the active status of the price. A price is activated permanently the first time it is billed; Chaching exposes no endpoint that deactivates a price."}},"httpPath":"/prices/{id}/active"}]},{"type":"group","label":"Subscriptions","link":"/developer-guide/api/subscriptions","routeSlug":"/developer-guide/api/subscriptions","items":[{"label":"List all subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_listsubscriptions","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_listsubscriptions","metadata":{"seo":{"title":"List all subscriptions","description":"Retrieves a paginated list of all subscriptions for the authenticated account. Supports pagination and filtering."}},"httpPath":"/subscriptions"},{"label":"Create a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_createsubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_createsubscription","metadata":{"seo":{"title":"Create a subscription","description":"Creates a new subscription for a customer. The subscription will include product items, pricing, and billing information."}},"httpPath":"/subscriptions"},{"label":"Retrieve a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_retrievesubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_retrievesubscription","metadata":{"seo":{"title":"Retrieve a subscription","description":"Retrieves a specific subscription by its unique identifier."}},"httpPath":"/subscriptions/{id}"},{"label":"Update a subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_updatesubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_updatesubscription","metadata":{"seo":{"title":"Update a subscription","description":"Updates an existing subscription by its unique identifier. Can modify items, pricing, billing information, and other subscription details."}},"httpPath":"/subscriptions/{id}"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_cancelsubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"Cancels an active subscription. The subscription will be terminated immediately or at the end of the current billing period based on configuration."}},"httpPath":"/subscriptions/{id}"},{"label":"Pause a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_pausesubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_pausesubscription","metadata":{"seo":{"title":"Pause a subscription","description":"Pauses an active subscription. No charges will be made while the subscription is paused. The subscription can be resumed later."}},"httpPath":"/subscriptions/{id}/pause"},{"label":"Resume a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/subscriptions/subscriptionscontroller_resumesubscription","routeSlug":"/developer-guide/api/subscriptions/subscriptionscontroller_resumesubscription","metadata":{"seo":{"title":"Resume a subscription","description":"Resumes a paused subscription. Billing will continue from where it was paused, and the subscription will be active again."}},"httpPath":"/subscriptions/{id}/resume"}]},{"type":"group","label":"Balance","link":"/developer-guide/api/balance","routeSlug":"/developer-guide/api/balance","items":[{"label":"Retrieve balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/balance/balancecontroller_getbalance","routeSlug":"/developer-guide/api/balance/balancecontroller_getbalance","metadata":{"seo":{"title":"Retrieve balance","description":"Retrieves the current account balance, based on the authentication that was used to make the request."}},"httpPath":"/balance"}]},{"type":"group","label":"Payment Methods","link":"/developer-guide/api/payment-methods","routeSlug":"/developer-guide/api/payment-methods","items":[{"label":"List all payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_getpaymentmethods","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_getpaymentmethods","metadata":{"seo":{"title":"List all payment methods","description":"Retrieves a list of payment methods for the current account, based on the authentication that was used to make the request."}},"httpPath":"/payment-methods"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_getpaymentmethod","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_getpaymentmethod","metadata":{"seo":{"title":"Retrieve a payment method","description":"Retrieves detailed information about a specific payment method for the current account, based on the authentication that was used to make the request."}},"httpPath":"/payment-methods/{id}"},{"label":"Attach a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_attachpaymentmethod","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_attachpaymentmethod","metadata":{"seo":{"title":"Attach a payment method","description":"Attaches a payment method to a customer for the current account, based on the authentication that was used to make the request."}},"httpPath":"/payment-methods/{id}/attach"},{"label":"Detach a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_detachpaymentmethod","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_detachpaymentmethod","metadata":{"seo":{"title":"Detach a payment method","description":"Detaches a payment method from a customer for the current account, based on the authentication that was used to make the request."}},"httpPath":"/payment-methods/{id}/detach"},{"label":"Set a payment method as the customer default","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/payment-methods/paymentmethodscontroller_setdefaultpaymentmethod","routeSlug":"/developer-guide/api/payment-methods/paymentmethodscontroller_setdefaultpaymentmethod","metadata":{"seo":{"title":"Set a payment method as the customer default","description":"Makes a payment method the default for one of the current account's customers, based on the authentication that was used to make the request."}},"httpPath":"/payment-methods/{id}/set-default"}]},{"type":"group","label":"Revenue Recovery","link":"/developer-guide/api/revenue-recovery","routeSlug":"/developer-guide/api/revenue-recovery","items":[{"label":"Retrieve revenue recovery settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/revenue-recovery/revenuerecoverycontroller_getrevenuerecovery","routeSlug":"/developer-guide/api/revenue-recovery/revenuerecoverycontroller_getrevenuerecovery","metadata":{"seo":{"title":"Retrieve revenue recovery settings","description":"Retrieves the account's revenue recovery settings — the payment-retry schedule and the two failed-payment outcomes. The settings apply to your whole account, every subscription and every payment plan alike, and there are no per-customer settings. Saved settings also apply to customers who already have unpaid invoices."}},"httpPath":"/revenue-recovery"},{"label":"Update revenue recovery settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/developer-guide/api/revenue-recovery/revenuerecoverycontroller_updaterevenuerecovery","routeSlug":"/developer-guide/api/revenue-recovery/revenuerecoverycontroller_updaterevenuerecovery","metadata":{"seo":{"title":"Update revenue recovery settings","description":"Replaces the account's revenue recovery settings — the payment-retry schedule and the two failed-payment outcomes. The settings apply to your whole account, every subscription and every payment plan alike, and there are no per-customer settings. Saved settings also apply to customers who already have unpaid invoices."}},"httpPath":"/revenue-recovery"}]},{"type":"link","fsPath":"Developer Guide/webhook.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/developer-guide/webhook","routeSlug":"/developer-guide/webhook"},{"type":"link","fsPath":"Developer Guide/subscription-lifecycle.md","metadata":{"type":"markdown"},"label":"Track subscription lifecycle and failed payments","link":"/developer-guide/subscription-lifecycle","routeSlug":"/developer-guide/subscription-lifecycle"}]},{"type":"group","label":"Settings","items":[{"type":"link","fsPath":"settings/PersonalDetails.md","metadata":{"type":"markdown"},"label":"Personal Details","link":"/settings/personaldetails","routeSlug":"/settings/personaldetails"},{"type":"link","fsPath":"settings/CompanyandBranding.md","metadata":{"type":"markdown"},"label":"Company and Branding","link":"/settings/companyandbranding","routeSlug":"/settings/companyandbranding"},{"type":"link","fsPath":"settings/InvoicesSubscriptions.md","metadata":{"type":"markdown"},"label":"Invoices & Subscriptions","link":"/settings/invoicessubscriptions","routeSlug":"/settings/invoicessubscriptions"},{"type":"link","fsPath":"settings/PlansandBilling.md","metadata":{"type":"markdown"},"label":"Plans and Billing","link":"/settings/plansandbilling","routeSlug":"/settings/plansandbilling"},{"type":"link","fsPath":"settings/MerchantAccount.md","metadata":{"type":"markdown"},"label":"Merchant Account","link":"/settings/merchantaccount","routeSlug":"/settings/merchantaccount"},{"type":"link","fsPath":"settings/DeveloperSettings.md","metadata":{"type":"markdown"},"label":"Developer Settings","link":"/settings/developersettings","routeSlug":"/settings/developersettings"}]},{"type":"group","fsPath":"Users/Users.md","metadata":{"type":"markdown"},"label":"Users","link":"/users/users","routeSlug":"/users/users","items":[{"type":"link","fsPath":"Users/RolePermissionsMatrix.md","metadata":{"type":"markdown"},"label":"Role Permissions Matrix","link":"/users/rolepermissionsmatrix","routeSlug":"/users/rolepermissionsmatrix"}]},{"type":"link","fsPath":"migrateSubscriptions.md","metadata":{"type":"markdown"},"label":"Migrate Subscriptions","link":"/migratesubscriptions","routeSlug":"/migratesubscriptions"},{"type":"link","fsPath":"support&Communication.md","metadata":{"type":"markdown"},"label":"Support & Communication","link":"/supportcommunication","routeSlug":"/supportcommunication"}]}